Elastic Load Balancing

{'LoadBalancerAttributes': {'AdditionalAttributes': [{'Key': 'string',
                                                      'Value': 'string'}]}}

Returns detailed information about all of the attributes associated with the specified load balancer.

Request Syntax

client.describe_load_balancer_attributes(
    LoadBalancerName='string'
)

type LoadBalancerName

string

param LoadBalancerName

[REQUIRED]

The name of the load balancer.

rtype

dict

returns

Response Syntax

{
    'LoadBalancerAttributes': {
        'CrossZoneLoadBalancing': {
            'Enabled': True|False
        },
        'AccessLog': {
            'Enabled': True|False,
            'S3BucketName': 'string',
            'EmitInterval': 123,
            'S3BucketPrefix': 'string'
        },
        'ConnectionDraining': {
            'Enabled': True|False,
            'Timeout': 123
        },
        'ConnectionSettings': {
            'IdleTimeout': 123
        },
        'AdditionalAttributes': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  The following element is returned in a structure named DescribeLoadBalancerAttributesResult .

  • LoadBalancerAttributes (dict) --

    The load balancer attributes structure.

    • CrossZoneLoadBalancing (dict) --

      The name of the load balancer attribute. If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.

      For more information, see Enable Cross-Zone Load Balancing.

      • Enabled (boolean) --

        Specifies whether cross-zone load balancing is enabled for the load balancer.

    • AccessLog (dict) --

      The name of the load balancer attribute. If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.

      For more information, see Enable Access Logs.

      • Enabled (boolean) --

        Specifies whether access log is enabled for the load balancer.

      • S3BucketName (string) --

        The name of the Amazon S3 bucket where the access logs are stored.

      • EmitInterval (integer) --

        The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

        Default: 60 minutes

      • S3BucketPrefix (string) --

        The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod . If the prefix is not provided, the log is placed at the root level of the bucket.

    • ConnectionDraining (dict) --

      The name of the load balancer attribute. If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.

      For more information, see Enable Connection Draining.

      • Enabled (boolean) --

        Specifies whether connection draining is enabled for the load balancer.

      • Timeout (integer) --

        Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.

    • ConnectionSettings (dict) --

      The name of the load balancer attribute.

      By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to remain idle (no data is sent over the connection) for the specified duration.

      For more information, see Configure Idle Connection Timeout.

      • IdleTimeout (integer) --

        Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

    • AdditionalAttributes (list) --

      This parameter is reserved for future use.

      • (dict) --

        The AdditionalAttribute data type.

        • Key (string) --

          Reserved for future use.

        • Value (string) --

          Reserved for future use.

{'LoadBalancerAttributes': {'AdditionalAttributes': [{'Key': 'string',
                                                      'Value': 'string'}]}}

Modifies the attributes of a specified load balancer.

You can modify the load balancer attributes, such as AccessLogs , ConnectionDraining , and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.

For more information, see the following:

• Cross-Zone Load Balancing

• Connection Draining

• Access Logs

• Idle Connection Timeout

Request Syntax

client.modify_load_balancer_attributes(
    LoadBalancerName='string',
    LoadBalancerAttributes={
        'CrossZoneLoadBalancing': {
            'Enabled': True|False
        },
        'AccessLog': {
            'Enabled': True|False,
            'S3BucketName': 'string',
            'EmitInterval': 123,
            'S3BucketPrefix': 'string'
        },
        'ConnectionDraining': {
            'Enabled': True|False,
            'Timeout': 123
        },
        'ConnectionSettings': {
            'IdleTimeout': 123
        },
        'AdditionalAttributes': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
)

type LoadBalancerName

string

param LoadBalancerName

[REQUIRED]

The name of the load balancer.

type LoadBalancerAttributes

dict

param LoadBalancerAttributes

[REQUIRED]

Attributes of the load balancer.

• CrossZoneLoadBalancing (dict) --

  The name of the load balancer attribute. If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.

  For more information, see Enable Cross-Zone Load Balancing.

  • Enabled (boolean) -- [REQUIRED]

    Specifies whether cross-zone load balancing is enabled for the load balancer.

• AccessLog (dict) --

  The name of the load balancer attribute. If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.

  For more information, see Enable Access Logs.

  • Enabled (boolean) -- [REQUIRED]

    Specifies whether access log is enabled for the load balancer.

  • S3BucketName (string) --

    The name of the Amazon S3 bucket where the access logs are stored.

  • EmitInterval (integer) --

    The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

    Default: 60 minutes

  • S3BucketPrefix (string) --

    The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod . If the prefix is not provided, the log is placed at the root level of the bucket.

• ConnectionDraining (dict) --

  The name of the load balancer attribute. If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.

  For more information, see Enable Connection Draining.

  • Enabled (boolean) -- [REQUIRED]

    Specifies whether connection draining is enabled for the load balancer.

  • Timeout (integer) --

    Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.

• ConnectionSettings (dict) --

  The name of the load balancer attribute.

  By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to remain idle (no data is sent over the connection) for the specified duration.

  For more information, see Configure Idle Connection Timeout.

  • IdleTimeout (integer) -- [REQUIRED]

    Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

• AdditionalAttributes (list) --

  This parameter is reserved for future use.

  • (dict) --

    The AdditionalAttribute data type.

    • Key (string) --

      Reserved for future use.

    • Value (string) --

      Reserved for future use.

rtype

dict

returns

Response Syntax

{
    'LoadBalancerName': 'string',
    'LoadBalancerAttributes': {
        'CrossZoneLoadBalancing': {
            'Enabled': True|False
        },
        'AccessLog': {
            'Enabled': True|False,
            'S3BucketName': 'string',
            'EmitInterval': 123,
            'S3BucketPrefix': 'string'
        },
        'ConnectionDraining': {
            'Enabled': True|False,
            'Timeout': 123
        },
        'ConnectionSettings': {
            'IdleTimeout': 123
        },
        'AdditionalAttributes': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  The output for the ModifyLoadBalancerAttributes action.

  • LoadBalancerName (string) --

    The name of the load balancer.

  • LoadBalancerAttributes (dict) --

    The LoadBalancerAttributes data type.

    • CrossZoneLoadBalancing (dict) --

      The name of the load balancer attribute. If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.

      For more information, see Enable Cross-Zone Load Balancing.

      • Enabled (boolean) --

        Specifies whether cross-zone load balancing is enabled for the load balancer.

    • AccessLog (dict) --

      The name of the load balancer attribute. If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.

      For more information, see Enable Access Logs.

      • Enabled (boolean) --

        Specifies whether access log is enabled for the load balancer.

      • S3BucketName (string) --

        The name of the Amazon S3 bucket where the access logs are stored.

      • EmitInterval (integer) --

        The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

        Default: 60 minutes

      • S3BucketPrefix (string) --

        The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod . If the prefix is not provided, the log is placed at the root level of the bucket.

    • ConnectionDraining (dict) --

      The name of the load balancer attribute. If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.

      For more information, see Enable Connection Draining.

      • Enabled (boolean) --

        Specifies whether connection draining is enabled for the load balancer.

      • Timeout (integer) --

        Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.

    • ConnectionSettings (dict) --

      The name of the load balancer attribute.

      By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to remain idle (no data is sent over the connection) for the specified duration.

      For more information, see Configure Idle Connection Timeout.

      • IdleTimeout (integer) --

        Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

    • AdditionalAttributes (list) --

      This parameter is reserved for future use.

      • (dict) --

        The AdditionalAttribute data type.

        • Key (string) --

          Reserved for future use.

        • Value (string) --

          Reserved for future use.