The AccessLog data type.
The AppCookieStickinessPolicy data type.
Container for the parameters to the ApplySecurityGroupsToLoadBalancer operation.
Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). The provided security group IDs will override any currently applied security groups.
For more information, see Manage Security Groups in Amazon VPC in the Elastic Load Balancing Developer Guide .
Returns information about the ApplySecurityGroupsToLoadBalancerResult response and response metadata.
The out for the ApplySecurityGroupsToLoadBalancer action.
Container for the parameters to the AttachLoadBalancerToSubnets operation.
Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
The load balancers evenly distribute requests across all of the registered subnets. For more information, see Deploy Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide .
Returns information about the AttachLoadBalancerToSubnetsResult response and response metadata.
The output for the AttachLoadBalancerToSubnets action.
This data type is used as a response element in the DescribeLoadBalancers action to describe the configuration of the back-end server.
Container for the parameters to the ConfigureHealthCheck operation.
Specifies the health check settings to use for evaluating the health state of your back-end instances.
For more information, see Health Check in the Elastic Load Balancing Developer Guide .
Returns information about the ConfigureHealthCheckResult response and response metadata.
The output for the ConfigureHealthCheck action.
The ConnectionDraining data type.
Container for the parameters to the CreateAppCookieStickinessPolicy operation.
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.
NOTE: 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.
For more information, see Enabling Application-Controlled Session Stickiness in the Elastic Load Balancing Developer Guide .
Returns information about the CreateAppCookieStickinessPolicyResult response and response metadata.
The output for the CreateAppCookieStickinessPolicy action.
Container for the parameters to the CreateLBCookieStickinessPolicy operation.
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.
For more information, see Enabling Duration-Based Session Stickiness in the Elastic Load Balancing Developer Guide .
Returns information about the CreateLBCookieStickinessPolicyResult response and response metadata.
The output for the CreateLBCookieStickinessPolicy action.
Container for the parameters to the CreateLoadBalancerListeners operation.
Creates one or more listeners on a load balancer 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.
For more information, see Add a Listener to Your Load Balancer in the Elastic Load Balancing Developer Guide .
Returns information about the CreateLoadBalancerListenersResult response and response metadata.
The output for the CreateLoadBalancerListeners action.
Container for the parameters to the CreateLoadBalancerPolicy operation.
Creates a new policy that contains the necessary attributes depending on the policy type. 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 your policy type.
Returns information about the CreateLoadBalancerPolicyResult response and response metadata.
The output for the CreateLoadBalancerPolicy action.
Container for the parameters to the CreateLoadBalancer operation.
Creates a new load balancer.
After the call has completed 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 balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:
For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints .
You can create up to 20 load balancers per region per account.
Elastic Load Balancing supports load balancing your Amazon EC2 instances launched within any one of the following platforms:
Returns information about the CreateLoadBalancerResult response and response metadata.
The output for the CreateLoadBalancer action.
The CrossZoneLoadBalancing data type.
Container for the parameters to the DeleteLoadBalancerListeners operation.
Deletes listeners from the load balancer for the specified port.
Returns information about the DeleteLoadBalancerListenersResult response and response metadata.
The output for the DeleteLoadBalancerListeners action.
Container for the parameters to the DeleteLoadBalancerPolicy operation.
Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners.
Returns information about the DeleteLoadBalancerPolicyResult response and response metadata.
The output for the DeleteLoadBalancerPolicy action.
Container for the parameters to the DeleteLoadBalancer operation.
Deletes the specified load balancer.
If attempting to recreate the load balancer, you must reconfigure all the settings. The DNS name associated with a deleted load balancer will no longer be usable. Once deleted, the name and associated DNS record of the load balancer no longer exist and traffic sent to any of its IP addresses will no longer be delivered to back-end instances.
To successfully call this API, you must provide the same account credentials as were used to create the load balancer.
NOTE: By design, if the load balancer does not exist or has already been deleted, a call to DeleteLoadBalancer action still succeeds.
Returns information about the DeleteLoadBalancerResult response and response metadata.
The output for the DeleteLoadBalancer action.
Container for the parameters to the DeregisterInstancesFromLoadBalancer operation.
Deregisters instances from the load balancer. Once the instance is deregistered, it will stop receiving traffic from the load balancer.
In order to successfully call this API, the same account credentials as those used to create the load balancer must be provided.
For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide .
You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.
Returns information about the DeregisterInstancesFromLoadBalancerResult response and response metadata.
The output for the DeregisterInstancesFromLoadBalancer action.
Container for the parameters to the DescribeInstanceHealth operation.
Returns the current state of the specified instances registered with the specified load balancer. If no instances are specified, the state of all the instances registered with the load balancer is returned.
NOTE: You must provide the same account credentials as those that were used to create the load balancer.
Returns information about the DescribeInstanceHealthResult response and response metadata.
The output for the DescribeInstanceHealth action.
Container for the parameters to the DescribeLoadBalancerAttributes operation.
Returns detailed information about all of the attributes associated with the specified load balancer.
Returns information about the DescribeLoadBalancerAttributesResult response and response metadata.
The following element is returned in a structure named DescribeLoadBalancerAttributesResult .
Container for the parameters to the DescribeLoadBalancerPolicies operation.
Returns detailed descriptions of the policies. If you specify a load balancer name, the action returns the descriptions of all the 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 the sample policies. The names of the sample policies have the ELBSample- prefix.
Returns information about the DescribeLoadBalancerPoliciesResult response and response metadata.
The output for the DescribeLoadBalancerPolicies action.
Container for the parameters to the DescribeLoadBalancerPolicyTypes operation.
Returns meta-information on the specified load balancer policies defined by the Elastic Load Balancing service. The policy types that are returned from this action can be used in a CreateLoadBalancerPolicy action to instantiate specific policy configurations that will be applied to a load balancer.
Returns information about the DescribeLoadBalancerPolicyTypesResult response and response metadata.
The output for the DescribeLoadBalancerPolicyTypes action.
Container for the parameters to the DescribeLoadBalancers operation.
Returns detailed configuration information for all the load balancers created for the account. If you specify load balancer names, the action returns configuration information of the specified load balancers.
NOTE: In order to retrieve this information, you must provide the same account credentials that was used to create the load balancer.
Returns information about the DescribeLoadBalancersResult response and response metadata.
The output for the DescribeLoadBalancers action.
Container for the parameters to the DetachLoadBalancerFromSubnets operation.
Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.
After a subnet is removed all of the EC2 instances registered with the load balancer that are in the removed subnet will go into the OutOfService state. When a subnet is removed, the load balancer will balance the traffic among the remaining routable subnets for the load balancer.
Returns information about the DetachLoadBalancerFromSubnetsResult response and response metadata.
The output for the DetachLoadBalancerFromSubnets action.
Container for the parameters to the DisableAvailabilityZonesForLoadBalancer operation.
Removes the specified EC2 Availability Zones from the set of configured Availability Zones for the load balancer.
There must be at least one Availability Zone registered with a load balancer at all times. Once an Availability Zone is removed, all the instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Upon Availability Zone removal, the load balancer attempts to equally balance the traffic among its remaining usable Availability Zones. Trying to remove an Availability Zone that was not associated with the load balancer does nothing.
For more information, see Disable an Availability Zone from a Load-Balanced Application in the Elastic Load Balancing Developer Guide .
Returns information about the DisableAvailabilityZonesForLoadBalancerResult response and response metadata.
The output for the DisableAvailabilityZonesForLoadBalancer action.
Container for the parameters to the EnableAvailabilityZonesForLoadBalancer operation.
Adds one or more EC2 Availability Zones to the load balancer.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.
NOTE: The new EC2 Availability Zones to be added must be in the same EC2 Region as the Availability Zones for which the load balancer was created.
For more information, see Expand a Load Balanced Application to an Additional Availability Zone in the Elastic Load Balancing Developer Guide .
Returns information about the EnableAvailabilityZonesForLoadBalancerResult response and response metadata.
The output for the EnableAvailabilityZonesForLoadBalancer action.
The HealthCheck data type.
The Instance data type.
The InstanceState data type.
The LBCookieStickinessPolicy data type.
The Listener data type.
The ListenerDescription data type.
The LoadBalancerAttributes data type.
Contains the result of a successful invocation of DescribeLoadBalancers.
Container for the parameters to the ModifyLoadBalancerAttributes operation.
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.
For information on cross-zone load balancing, see Request Routing and for information on connection draining, see Connection Draining in the Concepts section of the Elastic Load Balancer Developer Guide . For information on access logs, see Access Logs .
Returns information about the ModifyLoadBalancerAttributesResult response and response metadata.
The output for the ModifyLoadBalancerAttributes action.
The policies data type.
The PolicyAttribute data type. This data type contains a key/value pair that defines properties of a specific policy.
The PolicyAttributeDescription data type. This data type is used to describe the attributes and values associated with a policy.
The PolicyAttributeTypeDescription data type. This data type is used to describe values that are acceptable for the policy attribute.
The PolicyDescription data type.
The PolicyTypeDescription data type.
Container for the parameters to the RegisterInstancesWithLoadBalancer operation.
Adds new instances to the load balancer.
Once the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in any of the Availability Zones registered for the load balancer will be moved to the OutOfService state. It will move to the InService state when the Availability Zone is added to the load balancer.
When an instance registered with a load balancer is stopped and then restarted, 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 de-register your Amazon EC2 instances from your load balancer after you stop your instance, and then register the load balancer with your instance after you've restarted. To de-register your instances from load balancer, use DeregisterInstancesFromLoadBalancer action.
For more information, see De-register and Register Amazon EC2 Instances in the Elastic Load Balancing Developer Guide .
NOTE: In order for this call to be successful, you must provide the same account credentials as those that were used to create the load balancer.
NOTE: 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.
You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.
Returns information about the RegisterInstancesWithLoadBalancerResult response and response metadata.
The output for the RegisterInstancesWithLoadBalancer action.
Container for the parameters to the SetLoadBalancerListenerSSLCertificate operation.
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 on updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer in the Elastic Load Balancing Developer Guide .
Returns information about the SetLoadBalancerListenerSSLCertificateResult response and response metadata.
The output for the SetLoadBalancerListenerSSLCertificate action.
Container for the parameters to the SetLoadBalancerPoliciesForBackendServer operation.
Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, they can be applied here as a list. 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.
NOTE: The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.
Returns information about the SetLoadBalancerPoliciesForBackendServerResult response and response metadata.
The output for the SetLoadBalancerPoliciesForBackendServer action.
Container for the parameters to the SetLoadBalancerPoliciesOfListener operation.
Associates, updates, or disables a policy with a listener on the load balancer. You can associate multiple policies with a listener.
Returns information about the SetLoadBalancerPoliciesOfListenerResult response and response metadata.
The output for the SetLoadBalancerPoliciesOfListener action.
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 .