2015/05/07 - Elastic Load Balancing - 28 new api methods
Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.
When a load balancer implements this policy, the load balancer uses a special cookie to track the back-end server instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.
For more information, see Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide.
Request Syntax
client.create_lb_cookie_stickiness_policy(
LoadBalancerName='string',
PolicyName='string',
CookieExpirationPeriod=123
)
string
[REQUIRED]
The name of the load balancer.
string
[REQUIRED]
The name of the policy being created. This name must be unique within the set of policies for this load balancer.
integer
The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the sticky session lasts for the duration of the browser session.
dict
Response Syntax
{}
Response Structure
(dict) --
Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.
For more information about updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide.
Request Syntax
client.set_load_balancer_listener_ssl_certificate(
LoadBalancerName='string',
LoadBalancerPort=123,
SSLCertificateId='string'
)
string
[REQUIRED]
The name of the load balancer.
integer
[REQUIRED]
The port that uses the specified SSL certificate.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SSL certificate.
dict
Response Syntax
{}
Response Structure
(dict) --
Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.
For more information, see Tagging in the Elastic Load Balancing Developer Guide.
Request Syntax
client.add_tags(
LoadBalancerNames=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
list
[REQUIRED]
The name of the load balancer. You can specify one load balancer only.
(string) --
list
[REQUIRED]
The tags.
(dict) --
Information about a tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) --
The value of the tag.
dict
Response Syntax
{}
Response Structure
(dict) --
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 Elastic Load Balancing Developer Guide:
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'
},
]
}
)
string
[REQUIRED]
The name of the load balancer.
dict
[REQUIRED]
The attributes of the load balancer.
CrossZoneLoadBalancing (dict) --
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 in the Elastic Load Balancing Developer Guide.
Enabled (boolean) -- [REQUIRED]
Specifies whether cross-zone load balancing is enabled for the load balancer.
AccessLog (dict) --
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 Elastic Load Balancing Developer Guide.
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) --
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 in the Elastic Load Balancing Developer Guide.
Enabled (boolean) -- [REQUIRED]
Specifies whether connection draining is enabled for the load balancer.
Timeout (integer) --
The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
ConnectionSettings (dict) --
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 Elastic Load Balancing Developer Guide.
IdleTimeout (integer) -- [REQUIRED]
The time, in seconds, that 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.
(dict) --
This data type is reserved.
Key (string) --
This parameter is reserved.
Value (string) --
This parameter is reserved.
dict
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) --
LoadBalancerName (string) --
The name of the load balancer.
LoadBalancerAttributes (dict) --
The attributes for a load balancer.
CrossZoneLoadBalancing (dict) --
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 in the Elastic Load Balancing Developer Guide.
Enabled (boolean) --
Specifies whether cross-zone load balancing is enabled for the load balancer.
AccessLog (dict) --
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 Elastic Load Balancing Developer Guide.
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) --
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 in the Elastic Load Balancing Developer Guide.
Enabled (boolean) --
Specifies whether connection draining is enabled for the load balancer.
Timeout (integer) --
The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
ConnectionSettings (dict) --
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 Elastic Load Balancing Developer Guide.
IdleTimeout (integer) --
The time, in seconds, that 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.
(dict) --
This data type is reserved.
Key (string) --
This parameter is reserved.
Value (string) --
This parameter is reserved.
Deletes the specified listeners from the specified load balancer.
Request Syntax
client.delete_load_balancer_listeners(
LoadBalancerName='string',
LoadBalancerPorts=[
123,
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The client port numbers of the listeners.
(integer) --
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes the specified load balancer.
If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to back-end instances.
If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds.
Request Syntax
client.delete_load_balancer(
LoadBalancerName='string'
)
string
[REQUIRED]
The name of the load balancer.
dict
Response Syntax
{}
Response Structure
(dict) --
Adds one or more subnets to the set of configured subnets for the specified load balancer.
The load balancer evenly distributes requests across all registered subnets. For more information, see Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide.
Request Syntax
client.attach_load_balancer_to_subnets(
LoadBalancerName='string',
Subnets=[
'string',
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The IDs of the subnets to add for the load balancer. You can add only one subnet per Availability Zone.
(string) --
dict
Response Syntax
{
'Subnets': [
'string',
]
}
Response Structure
(dict) --
Subnets (list) --
The IDs of the subnets attached to the load balancer.
(string) --
Describes the tags associated with the specified load balancers.
Request Syntax
client.describe_tags(
LoadBalancerNames=[
'string',
]
)
list
[REQUIRED]
The names of the load balancers.
(string) --
dict
Response Syntax
{
'TagDescriptions': [
{
'LoadBalancerName': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
TagDescriptions (list) --
Information about the tags.
(dict) --
The tags associated with a load balancer.
LoadBalancerName (string) --
The name of the load balancer.
Tags (list) --
The tags.
(dict) --
Information about a tag.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.
For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide.
Request Syntax
client.create_load_balancer_listeners(
LoadBalancerName='string',
Listeners=[
{
'Protocol': 'string',
'LoadBalancerPort': 123,
'InstanceProtocol': 'string',
'InstancePort': 123,
'SSLCertificateId': 'string'
},
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The listeners.
(dict) --
Information about a listener.
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
Protocol (string) -- [REQUIRED]
The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
LoadBalancerPort (integer) -- [REQUIRED]
The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.
InstanceProtocol (string) --
The protocol to use for routing traffic to back-end instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol.
If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.
If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.
InstancePort (integer) -- [REQUIRED]
The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.
SSLCertificateId (string) --
The Amazon Resource Name (ARN) of the server certificate.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a load balancer.
If the call completes successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balancer was created. For example, the DNS name might end with either of the following:
us-east-1.elb.amazonaws.com
us-west-2.elb.amazonaws.com
For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints in the Amazon Web Services General Reference.
You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Elastic Load Balancing Limits in the Elastic Load Balancing Developer Guide.
Elastic Load Balancing supports load balancing your EC2 instances launched in either the EC2-Classic or EC2-VPC platform. For more information, see Elastic Load Balancing in EC2-Classic or Elastic Load Balancing in a VPC in the Elastic Load Balancing Developer Guide.
Request Syntax
client.create_load_balancer(
LoadBalancerName='string',
Listeners=[
{
'Protocol': 'string',
'LoadBalancerPort': 123,
'InstanceProtocol': 'string',
'InstancePort': 123,
'SSLCertificateId': 'string'
},
],
AvailabilityZones=[
'string',
],
Subnets=[
'string',
],
SecurityGroups=[
'string',
],
Scheme='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the load balancer.
This name must be unique within your AWS account, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.
list
[REQUIRED]
The listeners.
For more information, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
(dict) --
Information about a listener.
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
Protocol (string) -- [REQUIRED]
The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
LoadBalancerPort (integer) -- [REQUIRED]
The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.
InstanceProtocol (string) --
The protocol to use for routing traffic to back-end instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol.
If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.
If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.
InstancePort (integer) -- [REQUIRED]
The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.
SSLCertificateId (string) --
The Amazon Resource Name (ARN) of the server certificate.
list
One or more Availability Zones from the same region as the load balancer. Traffic is equally distributed across all specified Availability Zones.
You must specify at least one Availability Zone.
You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.
(string) --
list
The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.
(string) --
list
The IDs of the security groups to assign to the load balancer.
(string) --
string
The type of a load balancer. Valid only for load balancers in a VPC.
By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers in the Elastic Load Balancing Developer Guide.
Specify internal to create an internal load balancer with a DNS name that resolves to private IP addresses.
list
A list of tags to assign to the load balancer.
For more information about tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.
(dict) --
Information about a tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) --
The value of the tag.
dict
Response Syntax
{
'DNSName': 'string'
}
Response Structure
(dict) --
DNSName (string) --
The DNS name of the load balancer.
Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.
If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.
For more information, see Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide.
Request Syntax
client.create_app_cookie_stickiness_policy(
LoadBalancerName='string',
PolicyName='string',
CookieName='string'
)
string
[REQUIRED]
The name of the load balancer.
string
[REQUIRED]
The name of the policy being created. This name must be unique within the set of policies for this load balancer.
string
[REQUIRED]
The name of the application cookie used for stickiness.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer.
There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.
For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide.
Request Syntax
client.disable_availability_zones_for_load_balancer(
LoadBalancerName='string',
AvailabilityZones=[
'string',
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The Availability Zones.
(string) --
dict
Response Syntax
{
'AvailabilityZones': [
'string',
]
}
Response Structure
(dict) --
AvailabilityZones (list) --
The remaining Availability Zones for the load balancer.
(string) --
Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.
For more information, see Manage Security Groups for Amazon VPC in the Elastic Load Balancing Developer Guide.
Request Syntax
client.apply_security_groups_to_load_balancer(
LoadBalancerName='string',
SecurityGroups=[
'string',
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.
(string) --
dict
Response Syntax
{
'SecurityGroups': [
'string',
]
}
Response Structure
(dict) --
SecurityGroups (list) --
The IDs of the security groups associated with the load balancer.
(string) --
Describes the specified policies.
If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix.
Request Syntax
client.describe_load_balancer_policies(
LoadBalancerName='string',
PolicyNames=[
'string',
]
)
string
The name of the load balancer.
list
The names of the policies.
(string) --
dict
Response Syntax
{
'PolicyDescriptions': [
{
'PolicyName': 'string',
'PolicyTypeName': 'string',
'PolicyAttributeDescriptions': [
{
'AttributeName': 'string',
'AttributeValue': 'string'
},
]
},
]
}
Response Structure
(dict) --
PolicyDescriptions (list) --
Information about the policies.
(dict) --
Information about a policy.
PolicyName (string) --
The name of the policy.
PolicyTypeName (string) --
The name of the policy type.
PolicyAttributeDescriptions (list) --
The policy attributes.
(dict) --
Information about a policy attribute.
AttributeName (string) --
The name of the attribute.
AttributeValue (string) --
The value of the attribute.
Removes one or more tags from the specified load balancer.
Request Syntax
client.remove_tags(
LoadBalancerNames=[
'string',
],
Tags=[
{
'Key': 'string'
},
]
)
list
[REQUIRED]
The name of the load balancer. You can specify a maximum of one load balancer name.
(string) --
list
[REQUIRED]
The list of tag keys to remove.
(dict) --
The key of a tag.
Key (string) --
The name of the key.
dict
Response Syntax
{}
Response Structure
(dict) --
Associates, updates, or disables a policy with a listener for the specified load balancer. You can associate multiple policies with a listener.
Request Syntax
client.set_load_balancer_policies_of_listener(
LoadBalancerName='string',
LoadBalancerPort=123,
PolicyNames=[
'string',
]
)
string
[REQUIRED]
The name of the load balancer.
integer
[REQUIRED]
The external port of the load balancer for the policy.
list
[REQUIRED]
The names of the policies. If the list is empty, the current policy is removed from the listener.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
Request Syntax
client.describe_load_balancers(
LoadBalancerNames=[
'string',
],
Marker='string',
PageSize=123
)
list
The names of the load balancers.
(string) --
string
The marker for the next set of results. (You received this marker from a previous call.)
integer
The maximum number of results to return with this call (a number from 1 to 400). The default is 400.
dict
Response Syntax
{
'LoadBalancerDescriptions': [
{
'LoadBalancerName': 'string',
'DNSName': 'string',
'CanonicalHostedZoneName': 'string',
'CanonicalHostedZoneNameID': 'string',
'ListenerDescriptions': [
{
'Listener': {
'Protocol': 'string',
'LoadBalancerPort': 123,
'InstanceProtocol': 'string',
'InstancePort': 123,
'SSLCertificateId': 'string'
},
'PolicyNames': [
'string',
]
},
],
'Policies': {
'AppCookieStickinessPolicies': [
{
'PolicyName': 'string',
'CookieName': 'string'
},
],
'LBCookieStickinessPolicies': [
{
'PolicyName': 'string',
'CookieExpirationPeriod': 123
},
],
'OtherPolicies': [
'string',
]
},
'BackendServerDescriptions': [
{
'InstancePort': 123,
'PolicyNames': [
'string',
]
},
],
'AvailabilityZones': [
'string',
],
'Subnets': [
'string',
],
'VPCId': 'string',
'Instances': [
{
'InstanceId': 'string'
},
],
'HealthCheck': {
'Target': 'string',
'Interval': 123,
'Timeout': 123,
'UnhealthyThreshold': 123,
'HealthyThreshold': 123
},
'SourceSecurityGroup': {
'OwnerAlias': 'string',
'GroupName': 'string'
},
'SecurityGroups': [
'string',
],
'CreatedTime': datetime(2015, 1, 1),
'Scheme': 'string'
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
LoadBalancerDescriptions (list) --
Information about the load balancers.
(dict) --
Information about a load balancer.
LoadBalancerName (string) --
The name of the load balancer.
DNSName (string) --
The external DNS name of the load balancer.
CanonicalHostedZoneName (string) --
The Amazon Route 53 hosted zone associated with the load balancer.
For more information, see Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
CanonicalHostedZoneNameID (string) --
The ID of the Amazon Route 53 hosted zone name associated with the load balancer.
ListenerDescriptions (list) --
The listeners for the load balancer.
(dict) --
The policies enabled for a listener.
Listener (dict) --
Information about a listener.
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing in the Elastic Load Balancing Developer Guide.
Protocol (string) --
The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
LoadBalancerPort (integer) --
The port on which the load balancer is listening: 25, 80, 443, 465, 587, or 1024-65535.
InstanceProtocol (string) --
The protocol to use for routing traffic to back-end instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol.
If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.
If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.
InstancePort (integer) --
The port on which the instance server is listening - 25, 80, 443, 465, 587, or 1024-65535.
SSLCertificateId (string) --
The Amazon Resource Name (ARN) of the server certificate.
PolicyNames (list) --
The policies. If there are no policies enabled, the list is empty.
(string) --
Policies (dict) --
The policies defined for the load balancer.
AppCookieStickinessPolicies (list) --
The stickiness policies created using CreateAppCookieStickinessPolicy.
(dict) --
Information about a policy for application-controlled session stickiness.
PolicyName (string) --
The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.
CookieName (string) --
The name of the application cookie used for stickiness.
LBCookieStickinessPolicies (list) --
The stickiness policies created using CreateLBCookieStickinessPolicy.
(dict) --
Information about a policy for duration-based session stickiness.
PolicyName (string) --
The name for the policy being created. The name must be unique within the set of policies for this load balancer.
CookieExpirationPeriod (integer) --
The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.
OtherPolicies (list) --
The policies other than the stickiness policies.
(string) --
BackendServerDescriptions (list) --
Information about the back-end servers.
(dict) --
Information about the configuration of a back-end server.
InstancePort (integer) --
The port on which the back-end server is listening.
PolicyNames (list) --
The names of the policies enabled for the back-end server.
(string) --
AvailabilityZones (list) --
The Availability Zones for the load balancer.
(string) --
Subnets (list) --
The IDs of the subnets for the load balancer.
(string) --
VPCId (string) --
The ID of the VPC for the load balancer.
Instances (list) --
The IDs of the instances for the load balancer.
(dict) --
The ID of a back-end instance.
InstanceId (string) --
The ID of the instance.
HealthCheck (dict) --
Information about the health checks conducted on the load balancer.
Target (string) --
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
Interval (integer) --
The approximate interval, in seconds, between health checks of an individual instance.
Timeout (integer) --
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval value.
UnhealthyThreshold (integer) --
The number of consecutive health check failures required before moving the instance to the Unhealthy state.
HealthyThreshold (integer) --
The number of consecutive health checks successes required before moving the instance to the Healthy state.
SourceSecurityGroup (dict) --
The security group that you can use as part of your inbound rules for your load balancer's back-end application instances. To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this source security group as the inbound source.
OwnerAlias (string) --
The owner of the security group.
GroupName (string) --
The name of the security group.
SecurityGroups (list) --
The security groups for the load balancer. Valid only for load balancers in a VPC.
(string) --
CreatedTime (datetime) --
The date and time the load balancer was created.
Scheme (string) --
The type of load balancer. Valid only for load balancers in a VPC.
If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.
If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.
NextMarker (string) --
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
Adds the specified instances to the specified load balancer.
The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.
Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration happens shortly afterwards. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.
After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.
If you stop an instance registered with a load balancer and then start it, the IP addresses associated with the instance changes. Elastic Load Balancing cannot recognize the new IP address, which prevents it from routing traffic to the instances. We recommend that you use the following sequence: stop the instance, deregister the instance, start the instance, and then register the instance. To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see Deregister and Register EC2 Instances in the Elastic Load Balancing Developer Guide.
Request Syntax
client.register_instances_with_load_balancer(
LoadBalancerName='string',
Instances=[
{
'InstanceId': 'string'
},
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The IDs of the instances.
(dict) --
The ID of a back-end instance.
InstanceId (string) --
The ID of the instance.
dict
Response Syntax
{
'Instances': [
{
'InstanceId': 'string'
},
]
}
Response Structure
(dict) --
Instances (list) --
The updated list of instances for the load balancer.
(dict) --
The ID of a back-end instance.
InstanceId (string) --
The ID of the instance.
Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.
You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.
For more information, see Deregister and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide.
Request Syntax
client.deregister_instances_from_load_balancer(
LoadBalancerName='string',
Instances=[
{
'InstanceId': 'string'
},
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The IDs of the instances.
(dict) --
The ID of a back-end instance.
InstanceId (string) --
The ID of the instance.
dict
Response Syntax
{
'Instances': [
{
'InstanceId': 'string'
},
]
}
Response Structure
(dict) --
Instances (list) --
The remaining instances registered with the load balancer.
(dict) --
The ID of a back-end instance.
InstanceId (string) --
The ID of the instance.
Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
For more information, see Add Availability Zone in the Elastic Load Balancing Developer Guide.
Request Syntax
client.enable_availability_zones_for_load_balancer(
LoadBalancerName='string',
AvailabilityZones=[
'string',
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The Availability Zones. These must be in the same region as the load balancer.
(string) --
dict
Response Syntax
{
'AvailabilityZones': [
'string',
]
}
Response Structure
(dict) --
AvailabilityZones (list) --
The updated list of Availability Zones for the load balancer.
(string) --
Describes the state of the specified instances registered with the specified load balancer. If no instances are specified, the call describes the state of all instances registered with the load balancer, not including any terminated instances.
Request Syntax
client.describe_instance_health(
LoadBalancerName='string',
Instances=[
{
'InstanceId': 'string'
},
]
)
string
[REQUIRED]
The name of the load balancer.
list
The IDs of the instances.
(dict) --
The ID of a back-end instance.
InstanceId (string) --
The ID of the instance.
dict
Response Syntax
{
'InstanceStates': [
{
'InstanceId': 'string',
'State': 'string',
'ReasonCode': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
InstanceStates (list) --
Information about the health of the instances.
(dict) --
Information about the state of a back-end instance.
InstanceId (string) --
The ID of the instance.
State (string) --
The current state of the instance.
Valid values: InService | OutOfService | Unknown
ReasonCode (string) --
Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.
Valid values: ELB | Instance | N/A
Description (string) --
A description of the instance state. This string can contain one or more of the following messages.
N/A
A transient error occurred. Please try again later.
Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
Instance has not passed the configured HealthyThreshold number of health checks consecutively.
Instance registration is still in progress.
Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
Instance is not currently registered with the LoadBalancer.
Instance deregistration currently in progress.
Disable Availability Zone is currently in progress.
Instance is in pending state.
Instance is in stopped state.
Instance is in terminated state.
Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
Request Syntax
client.delete_load_balancer_policy(
LoadBalancerName='string',
PolicyName='string'
)
string
[REQUIRED]
The name of the load balancer.
string
[REQUIRED]
The name of the policy.
dict
Response Syntax
{}
Response Structure
(dict) --
Describes the specified load balancer policy types.
You can use these policy types with CreateLoadBalancerPolicy to create policy configurations for a load balancer.
Request Syntax
client.describe_load_balancer_policy_types(
PolicyTypeNames=[
'string',
]
)
list
The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.
(string) --
dict
Response Syntax
{
'PolicyTypeDescriptions': [
{
'PolicyTypeName': 'string',
'Description': 'string',
'PolicyAttributeTypeDescriptions': [
{
'AttributeName': 'string',
'AttributeType': 'string',
'Description': 'string',
'DefaultValue': 'string',
'Cardinality': 'string'
},
]
},
]
}
Response Structure
(dict) --
PolicyTypeDescriptions (list) --
Information about the policy types.
(dict) --
Information about a policy type.
PolicyTypeName (string) --
The name of the policy type.
Description (string) --
A description of the policy type.
PolicyAttributeTypeDescriptions (list) --
The description of the policy attributes associated with the policies defined by Elastic Load Balancing.
(dict) --
Information about a policy attribute type.
AttributeName (string) --
The name of the attribute.
AttributeType (string) --
The type of the attribute. For example, Boolean or Integer.
Description (string) --
A description of the attribute.
DefaultValue (string) --
The default value of the attribute, if applicable.
Cardinality (string) --
The cardinality of the attribute.
Valid values:
ONE(1) : Single value required
ZERO_OR_ONE(0..1) : Up to one value can be supplied
ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed
ONE_OR_MORE(1..*0) : Required. Multiple values are allowed
Creates a policy with the specified attributes for the specified load balancer.
Policies are settings that are saved for your load balancer and that can be applied to the front-end listener or the back-end application server, depending on the policy type.
Request Syntax
client.create_load_balancer_policy(
LoadBalancerName='string',
PolicyName='string',
PolicyTypeName='string',
PolicyAttributes=[
{
'AttributeName': 'string',
'AttributeValue': 'string'
},
]
)
string
[REQUIRED]
The name of the load balancer.
string
[REQUIRED]
The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer.
string
[REQUIRED]
The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes.
list
The attributes for the policy.
(dict) --
Information about a policy attribute.
AttributeName (string) --
The name of the attribute.
AttributeValue (string) --
The value of the attribute.
dict
Response Syntax
{}
Response Structure
(dict) --
Describes the attributes for the specified load balancer.
Request Syntax
client.describe_load_balancer_attributes(
LoadBalancerName='string'
)
string
[REQUIRED]
The name of the load balancer.
dict
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) --
LoadBalancerAttributes (dict) --
Information about the load balancer attributes.
CrossZoneLoadBalancing (dict) --
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 in the Elastic Load Balancing Developer Guide.
Enabled (boolean) --
Specifies whether cross-zone load balancing is enabled for the load balancer.
AccessLog (dict) --
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 Elastic Load Balancing Developer Guide.
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) --
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 in the Elastic Load Balancing Developer Guide.
Enabled (boolean) --
Specifies whether connection draining is enabled for the load balancer.
Timeout (integer) --
The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
ConnectionSettings (dict) --
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 Elastic Load Balancing Developer Guide.
IdleTimeout (integer) --
The time, in seconds, that 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.
(dict) --
This data type is reserved.
Key (string) --
This parameter is reserved.
Value (string) --
This parameter is reserved.
Specifies the health check settings to use when evaluating the health state of your back-end instances.
For more information, see Health Checks in the Elastic Load Balancing Developer Guide.
Request Syntax
client.configure_health_check(
LoadBalancerName='string',
HealthCheck={
'Target': 'string',
'Interval': 123,
'Timeout': 123,
'UnhealthyThreshold': 123,
'HealthyThreshold': 123
}
)
string
[REQUIRED]
The name of the load balancer.
dict
[REQUIRED]
The configuration information for the new health check.
Target (string) -- [REQUIRED]
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
Interval (integer) -- [REQUIRED]
The approximate interval, in seconds, between health checks of an individual instance.
Timeout (integer) -- [REQUIRED]
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval value.
UnhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive health check failures required before moving the instance to the Unhealthy state.
HealthyThreshold (integer) -- [REQUIRED]
The number of consecutive health checks successes required before moving the instance to the Healthy state.
dict
Response Syntax
{
'HealthCheck': {
'Target': 'string',
'Interval': 123,
'Timeout': 123,
'UnhealthyThreshold': 123,
'HealthyThreshold': 123
}
}
Response Structure
(dict) --
HealthCheck (dict) --
The updated health check.
Target (string) --
The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
Interval (integer) --
The approximate interval, in seconds, between health checks of an individual instance.
Timeout (integer) --
The amount of time, in seconds, during which no response means a failed health check.
This value must be less than the Interval value.
UnhealthyThreshold (integer) --
The number of consecutive health check failures required before moving the instance to the Unhealthy state.
HealthyThreshold (integer) --
The number of consecutive health checks successes required before moving the instance to the Healthy state.
Replaces the set of policies associated with the specified port on which the back-end server is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.
Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the back-end server.
Request Syntax
client.set_load_balancer_policies_for_backend_server(
LoadBalancerName='string',
InstancePort=123,
PolicyNames=[
'string',
]
)
string
[REQUIRED]
The name of the load balancer.
integer
[REQUIRED]
The port number associated with the back-end server.
list
[REQUIRED]
The names of the policies. If the list is empty, then all current polices are removed from the back-end server.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Removes the specified subnets from the set of configured subnets for the load balancer.
After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets.
Request Syntax
client.detach_load_balancer_from_subnets(
LoadBalancerName='string',
Subnets=[
'string',
]
)
string
[REQUIRED]
The name of the load balancer.
list
[REQUIRED]
The IDs of the subnets.
(string) --
dict
Response Syntax
{
'Subnets': [
'string',
]
}
Response Structure
(dict) --
Subnets (list) --
The IDs of the remaining subnets for the load balancer.
(string) --