Input for the ConfigureHealthCheck action.

]]> The mnemonic name associated with the LoadBalancer. This name must be unique within the client AWS account.

]]> A structure containing the configuration information for the new healthcheck.

]]> The output for the ConfigureHealthCheck action.

]]> The updated healthcheck for the instances.

]]> The input for the SetLoadBalancerListenerSSLCertificate action.

]]> The name of the the LoadBalancer.

]]> The port that uses the specified SSL certificate.

]]> The ID of the SSL certificate chain to use. For more information on SSL certificates, see Managing Server Certificates in the AWS Identity and Access Management documentation.

]]> The output for the SetLoadBalancerListenerSSLCertificate action.

]]> The input for the RegisterInstancesWithLoadBalancer action.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> A list of instances IDs that should be registered with the LoadBalancer.

]]> The output for the RegisterInstancesWithLoadBalancer action.

]]> An updated list of instances for the LoadBalancer.

]]> The input for the SetLoadBalancerPoliciesOfListener action.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> The external port of the LoadBalancer with which this policy has to be associated.

]]> List of policies to be associated with the listener. Currently this list can have at most one policy. If the list is empty, the current policy is removed from the listener.

]]> The output for the SetLoadBalancerPoliciesOfListener action.

]]> The input for the DeleteLoadBalancerListeners action.

]]> The mnemonic name associated with the LoadBalancer.

]]> The client port number(s) of the LoadBalancerListener(s) to be removed.

]]> The output for the DeleteLoadBalancerListeners action.

]]> The input for the CreateLBCookieStickinessPolicy action.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> The name of the policy being created. The name must be unique within the set of policies for this Load Balancer.

]]> The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the sticky session will last for the duration of the browser session.

]]> The output for the CreateLBCookieStickinessPolicy action.

]]> The input for the DisableAvailabilityZonesForLoadBalancer action.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> A list of Availability Zones to be removed from the LoadBalancer.

There must be at least one Availability Zone registered with a LoadBalancer at all times. The client cannot remove all the Availability Zones from a LoadBalancer. Specified Availability Zones must be in the same Region. ]]> The output for the DisableAvailabilityZonesForLoadBalancer action.

]]> A list of updated Availability Zones for the LoadBalancer.

]]> The input for the CreateLoadBalancer action.

]]> The name associated with the LoadBalancer. The name must be unique within your set of LoadBalancers.

]]> A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.

]]> A list of Availability Zones.

At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the LoadBalancer. Traffic will be equally distributed across all zones.

This list can be modified after the creation of the LoadBalancer.

]]> The output for the CreateLoadBalancer action.

]]> The DNS name for the LoadBalancer.

]]> The input for the EnableAvailabilityZonesForLoadBalancer action.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> A list of new Availability Zones for the LoadBalancer. Each Availability Zone must be in the same Region as the LoadBalancer.

]]> The output for the EnableAvailabilityZonesForLoadBalancer action.

]]> An updated list of Availability Zones for the LoadBalancer.

]]> The input for the DeregisterInstancesFromLoadBalancer action.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> A list of EC2 instance IDs consisting of all instances to be deregistered.

]]> The output for the DeregisterInstancesFromLoadBalancer action.

]]> An updated list of remaining instances registered with the LoadBalancer.

]]> The input for the CreateAppCookieStickinessPolicy action.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> The name of the policy being created. The name must be unique within the set of policies for this Load Balancer.

]]> Name of the application cookie used for stickiness.

]]> The output for the CreateAppCookieStickinessPolicy action.

]]> The input for the DeleteLoadBalancer action.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> The output for the DeleteLoadBalander action.

]]> The input for the DeleteLoadBalancerPolicy action.

]]> The mnemonic name associated with the LoadBalancer. The name must be unique within your AWS account.

]]> The mnemonic name for the policy being deleted.

]]> The output for the DeleteLoadBalancerPolicy action.

]]> Returns the current state of the instances of the specified LoadBalancer. If no instances are specified, the state of all the instances for the LoadBalancer is returned.

]]> The name associated with the LoadBalancer. The name must be unique within the client AWS account.

]]> A list of instance IDs whose states are being queried.

]]> The output for the DescribeInstanceHealth action.

]]> A list containing health information for the specified instances.

]]> The input for the DescribeLoadBalancers action.

]]> A list of names associated with the LoadBalancers at creation time.

]]> The output for the DescribeLoadBalancers action.

]]> A list of LoadBalancer description structures.

]]> The input for the CreateLoadBalancerListeners action.

]]> The name of the new LoadBalancer. The name must be unique within your AWS account.

]]> A list of LoadBalancerPort, InstancePort, Protocol, and SSLCertificateId items.

]]> The output for the CreateLoadBalancerListeners action.

]]> The Instance data type.

]]> Provides an EC2 instance ID.

]]> This data type is used as a response element in the DescribeLoadBalancers action. For information about Elastic Load Balancing security groups, go to Using Security Groups With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

]]> Owner of the source security group. Use this value for the --source-group-user parameter of the ec2-authorize command in the Amazon EC2 command line tool.

]]> Name of the source security group. Use this value for the --source-group parameter of the ec2-authorize command in the Amazon EC2 command line tool.

]]> Contains the result of a successful invocation of DescribeLoadBalancers.

]]> Specifies the name associated with the LoadBalancer.

]]> Specifies the external DNS name associated with the LoadBalancer.

]]> Provides the name of the Amazon Route 53 hosted zone that is associated with the load balancer. For information on how to associate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

]]> Provides the ID of the Amazon Route 53 hosted zone name that is associated with the load balancer. For information on how to associate or disassociate your load balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing in the Elastic Load Balancing Developer Guide.

]]> LoadBalancerPort, InstancePort, Protocol, and PolicyNames are returned in a list of tuples in the ListenerDescriptions element.

]]> Specifies a list of Availability Zones.

]]> Provides a list of EC2 instance IDs for the LoadBalancer.

]]> Specifies information regarding the various health probes conducted on the LoadBalancer.

]]> The security group that you can use as part of your inbound rules for your load balancer's back-end Amazon EC2 application instances. To disallow traffic from sources other than your load balancer, add a security group rule to your back end instance that specifies this source security group as the inbound source.

]]> Provides the date and time the LoadBalancer was created.

]]> The ListenerDescription data type.

]]> A list of policies enabled for this listener. An empty list indicates that no policies are enabled.

]]> The HealthCheck data type.

]]> Specifies the instance being checked. The protocol is either TCP or HTTP. 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 healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

For HTTP, the situation is different. 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 needs to be 1024 16-bit Unicode characters or less.

]]> Specifies the approximate interval, in seconds, between health checks of an individual instance.

]]> Specifies the amount of time, in seconds, during which no response means a failed health probe.

This value must be less than the Interval value. ]]> Specifies the number of consecutive health probe failures required before moving the instance to the Unhealthy state.

]]> Specifies the number of consecutive health probe successes required before moving the instance to the Healthy state.

]]> The Listener data type.

]]> Specifies the LoadBalancer transport protocol to use for routing - TCP or HTTP. This property cannot be modified for the life of the LoadBalancer.

]]> Specifies the external LoadBalancer port number. This property cannot be modified for the life of the LoadBalancer.

]]> Specifies the TCP port on which the instance server is listening. This property cannot be modified for the life of the LoadBalancer.

]]> The ID of the SSL certificate chain to use. For more information on SSL certificates, see Managing Keys and Certificates in the AWS Identity and Access Management documentation.

]]> The InstanceState data type.

]]> Provides an EC2 instance ID.

]]> Specifies the current status of the instance.

]]> Provides information about the cause of OutOfService instances. Specifically, it indicates whether the cause is Elastic Load Balancing or the instance behind the Load Balancer.

]]> Provides a description of the instance.

]]> Enables the client to define an application healthcheck for the instances.

]]> Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same LoadBalancer and port.

]]> Adds new instances to the LoadBalancer.

Once the instance is registered, it starts receiving traffic and requests from the LoadBalancer. Any instance that is not in any of the Availability Zones registered for the LoadBalancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the LoadBalancer.

In order for this call to be successful, the client must have created the LoadBalancer. The client must provide the same account credentials as those that were used to create the LoadBalancer. Completion of this API does not guarantee that operation has completed. Rather, it means that the request has been registered and the changes will happen shortly. ]]> Associates, updates, or disables a policy with a listener on the load balancer. Currently only zero (0) or one (1) policy can be associated with a listener.

]]> Deletes listeners from the LoadBalancer for the specified port.

]]> 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 backend 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.

]]> Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the LoadBalancer.

There must be at least one Availability Zone registered with a LoadBalancer at all times. A client cannot remove all the Availability Zones from a LoadBalancer. Once an Availability Zone is removed, all the instances registered with the LoadBalancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the LoadBalancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the LoadBalancer does nothing.

Once the call has completed successfully, a new LoadBalancer is created; however, it will not be usable until at least one instance has been registered. When the LoadBalancer creation is completed, the client can check whether or not it is usable by using the DescribeInstanceHealth API. The LoadBalancer is usable as soon as any registered instance is InService.

Currently, the client's quota of LoadBalancers is limited to five per Region.

Load balancer DNS names vary depending on the Region they're created in. For load balancers created in the United States, the DNS name ends with:

us-east-1.elb.amazonaws.com (for the US Standard Region)
us-west-1.elb.amazonaws.com (for the Northern California Region)

For load balancers created in the EU (Ireland) Region, the DNS name ends with:

eu-west-1.elb.amazonaws.com

]]> Adds one or more EC2 Availability Zones to the LoadBalancer.

The LoadBalancer evenly distributes requests across all its registered Availability Zones that contain instances. As a result, the client must ensure that its LoadBalancer is appropriately scaled for each registered Availability Zone.

The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the LoadBalancer was created. ]]> Deregisters instances from the LoadBalancer. Once the instance is deregistered, it will stop receiving traffic from the LoadBalancer.

In order to successfully call this API, the same account credentials as those used to create the LoadBalancer must be provided.

]]> 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 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.

An application client must receive and send two cookies: the application-generated cookie and the special Elastic Load Balancing cookie named AWSELB. This is the default behavior for many common web browsers. ]]> Deletes the specified LoadBalancer.

If attempting to recreate the LoadBalancer, the client must reconfigure all the settings. The DNS name associated with a deleted LoadBalancer will no longer be usable. Once deleted, the name and associated DNS record of the LoadBalancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to client instances. The client will not receive the same DNS name even if a new LoadBalancer with same LoadBalancerName is created.

To successfully call this API, the client must provide the same account credentials as were used to create the LoadBalancer.

By design, if the LoadBalancer does not exist or has already been deleted, DeleteLoadBalancer still succeeds. ]]> Deletes a policy from the LoadBalancer. The specified policy must not be enabled for any listeners.

]]> Returns the current state of the instances of the specified LoadBalancer. If no instances are specified, the state of all the instances for the LoadBalancer is returned.

The client must have created the specified input LoadBalancer in order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer. ]]> Returns detailed configuration information for the specified LoadBalancers. If no LoadBalancers are specified, the operation returns configuration information for all LoadBalancers created by the caller.

The client must have created the specified input LoadBalancers in order to retrieve this information; the client must provide the same account credentials as those that were used to create the LoadBalancer. ]]> Creates one or more listeners on a LoadBalancer for the specified port. If a listener with the given port does not already exist, it will be created; otherwise, the properties of the new listener must match the properties of the existing listener.

]]> Elastic Load Balancing

Elastic Load Balancing is a cost-effective and easy to use web service to help you improve availability and scalability of your application. It makes it easy for you to distribute application loads between two or more EC2 instances. Elastic Load Balancing enables availability through redundancy and supports traffic growth of your application.

]]>