load_balancer_attributes
Creates, updates, deletes, gets or lists a load_balancer_attributes resource.
Overview
| Name | load_balancer_attributes |
| Type | Resource |
| Id | aws.elb.load_balancer_attributes |
Fields
The following fields are returned by SELECT queries:
- describe_load_balancer_attributes
| Name | Datatype | Description |
|---|---|---|
access_log | string | If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify. For more information, see Enable Access Logs in the Classic Load Balancers Guide. |
additional_attributes | string | Any additional attributes. |
connection_draining | string | If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance. For more information, see Configure Connection Draining in the Classic Load Balancers Guide. |
connection_settings | string | If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration. By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide. |
cross_zone_load_balancing | string | If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones. For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_load_balancer_attributes | select | LoadBalancerName, region | Describes the attributes for the specified load balancer. | |
modify_load_balancer_attributes | update | LoadBalancerName, LoadBalancerAttributes, region | Modifies the attributes of the 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 in the Classic Load Balancers Guide: Cross-Zone Load Balancing Connection Draining Access Logs Idle Connection Timeout |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
LoadBalancerAttributes | object | The attributes for the load balancer. |
LoadBalancerName | string | The name of the load balancer. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_load_balancer_attributes
Describes the attributes for the specified load balancer.
SELECT
access_log,
additional_attributes,
connection_draining,
connection_settings,
cross_zone_load_balancing
FROM aws.elb.load_balancer_attributes
WHERE LoadBalancerName = '{{ LoadBalancerName }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- modify_load_balancer_attributes
Modifies the attributes of the 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 in the Classic Load Balancers Guide: Cross-Zone Load Balancing Connection Draining Access Logs Idle Connection Timeout
UPDATE aws.elb.load_balancer_attributes
SET
-- No updatable properties
WHERE
LoadBalancerName = '{{ LoadBalancerName }}' --required
AND LoadBalancerAttributes = '{{ LoadBalancerAttributes }}' --required
AND region = '{{ region }}' --required
RETURNING
access_log,
additional_attributes,
connection_draining,
connection_settings,
cross_zone_load_balancing;