Elastic Load Balancing. API Reference API Version

Transcription

1 Elastic Load Balancing API Reference

2 Elastic Load Balancing: API Reference Copyright 2015 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

3 Table of Contents Welcome... 1 Actions... 2 AddTags... 3 Request Parameters... 3 Errors ApplySecurityGroupsToLoadBalancer... 5 Request Parameters... 5 Response Elements... 5 Errors AttachLoadBalancerToSubnets... 7 Request Parameters... 7 Response Elements... 7 Errors ConfigureHealthCheck... 9 Request Parameters... 9 Response Elements... 9 Errors CreateAppCookieStickinessPolicy Request Parameters Errors CreateLBCookieStickinessPolicy Request Parameters Errors CreateLoadBalancer Request Parameters Response Elements Errors CreateLoadBalancerListeners Request Parameters Errors CreateLoadBalancerPolicy Request Parameters Errors DeleteLoadBalancer Request Parameters Errors DeleteLoadBalancerListeners Request Parameters Errors DeleteLoadBalancerPolicy Request Parameters Errors DeregisterInstancesFromLoadBalancer Request Parameters Response Elements Errors iii

4 DescribeInstanceHealth Request Parameters Response Elements Errors DescribeLoadBalancerAttributes Request Parameters Response Elements Errors DescribeLoadBalancerPolicies Request Parameters Response Elements Errors DescribeLoadBalancerPolicyTypes Request Parameters Response Elements Errors DescribeLoadBalancers Request Parameters Response Elements Errors DescribeTags Request Parameters Response Elements Errors DetachLoadBalancerFromSubnets Request Parameters Response Elements Errors DisableAvailabilityZonesForLoadBalancer Request Parameters Response Elements Errors EnableAvailabilityZonesForLoadBalancer Request Parameters Response Elements Errors ModifyLoadBalancerAttributes Request Parameters Response Elements Errors RegisterInstancesWithLoadBalancer Request Parameters Response Elements Errors RemoveTags Request Parameters iv

5 Errors SetLoadBalancerListenerSSLCertificate Request Parameters Errors SetLoadBalancerPoliciesForBackendServer Request Parameters Errors SetLoadBalancerPoliciesOfListener Request Parameters Errors Data Types AccessLog Description Contents AdditionalAttribute Description Contents AppCookieStickinessPolicy Description Contents BackendServerDescription Description Contents ConnectionDraining Description Contents ConnectionSettings Description Contents CrossZoneLoadBalancing Description Contents HealthCheck Description Contents Instance Description Contents InstanceState Description Contents LBCookieStickinessPolicy Description Contents Listener Description Contents ListenerDescription Description Contents LoadBalancerAttributes Description Contents LoadBalancerDescription v

6 Description Contents Policies Description Contents PolicyAttribute Description Contents PolicyAttributeDescription Description Contents PolicyAttributeTypeDescription Description Contents PolicyDescription Description Contents PolicyTypeDescription Description Contents SourceSecurityGroup Description Contents Tag Description Contents TagDescription Description Contents TagKeyOnly Description Contents Common Parameters Common Errors Query Requests Signing Query Requests Regions and Endpoints for Elastic Load Balancing SOAP API WSDL and Schema Definitions Programming Language Support Request Authentication The Response Structure vi

7 Welcome A load balancer distributes incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances.you configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances. For more information, see the Elastic Load Balancing Developer Guide. For information about the AWS regions supported by Elastic Load Balancing, see Regions and Endpoints - Elastic Load Balancing in the Amazon Web Services General Reference. All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code. This document was last updated on December 18,

8 Actions The following actions are supported: AddTags (p. 3) ApplySecurityGroupsToLoadBalancer (p. 5) AttachLoadBalancerToSubnets (p. 7) ConfigureHealthCheck (p. 9) CreateAppCookieStickinessPolicy (p. 11) CreateLBCookieStickinessPolicy (p. 13) CreateLoadBalancer (p. 15) CreateLoadBalancerListeners (p. 21) CreateLoadBalancerPolicy (p. 23) DeleteLoadBalancer (p. 25) DeleteLoadBalancerListeners (p. 26) DeleteLoadBalancerPolicy (p. 27) DeregisterInstancesFromLoadBalancer (p. 28) DescribeInstanceHealth (p. 30) DescribeLoadBalancerAttributes (p. 34) DescribeLoadBalancerPolicies (p. 36) DescribeLoadBalancerPolicyTypes (p. 39) DescribeLoadBalancers (p. 42) DescribeTags (p. 45) DetachLoadBalancerFromSubnets (p. 47) DisableAvailabilityZonesForLoadBalancer (p. 49) EnableAvailabilityZonesForLoadBalancer (p. 51) ModifyLoadBalancerAttributes (p. 53) RegisterInstancesWithLoadBalancer (p. 57) RemoveTags (p. 59) SetLoadBalancerListenerSSLCertificate (p. 61) SetLoadBalancerPoliciesForBackendServer (p. 63) SetLoadBalancerPoliciesOfListener (p. 65) 2

9 AddTags AddTags 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 Tag Your Load Balancer in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerNames.member.N The name of the load balancer. You can specify one load balancer only. list Tags.member.N The tags. Type: Tag (p. 82) list Length constraints: Minimum of 1 item(s) in the list. Errors For information about the errors that are common to all actions, see Common Errors (p. 86). DuplicateTagKeys A tag key was specified more than once. LoadBalancerNotFound The specified load balancer does not exist. TooManyTags The quota for the number of tags that can be assigned to a load balancer has been reached. Sample Request &LoadBalancerNames.member.1=my-loadbalancer &Tags.member.1.Key=project 3

10 &Tags.member.1.Value=lima &Version= &AUTHPARAMS Sample Response <AddTagsResponse xmlns=" 01/"> <AddTagsResult/> <ResponseMetadata> <RequestId>360e81f e4-b6ed-0f30EXAMPLE</RequestId> </ResponseMetadata> </AddTagsResponse> 4

11 ApplySecurityGroupsToLoadBalancer ApplySecurityGroupsToLoadBalancer 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 Security Groups for Load Balancers in a VPC in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerName The name of the load balancer. SecurityGroups.member.N The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group. list Response Elements The following element is returned. SecurityGroups The IDs of the security groups associated with the load balancer. list Errors For information about the errors that are common to all actions, see Common Errors (p. 86). InvalidConfigurationRequest The requested configuration change is not valid. HTTP Status Code: 409 InvalidSecurityGroup One or more of the specified security groups do not exist. LoadBalancerNotFound The specified load balancer does not exist. 5

12 Sample Request ancer &LoadBalancerName=my-vpc-loadbalancer &SecurityGroups.member.1=sg &Version= &AUTHPARAMS Sample Response <ApplySecurityGroupsToLoadBalancerResponse xmlns=" cing.amazonaws.com/doc/ /"> <ApplySecurityGroupsToLoadBalancerResult> <SecurityGroups> <member>sg </member> </SecurityGroups> </ApplySecurityGroupsToLoadBalancerResult> <ResponseMetadata> <RequestId>06b5decc-102a-11e3-9ad6-bf3e4EXAMPLE</RequestId> </ResponseMetadata> </ApplySecurityGroupsToLoadBalancerResponse> 6

13 AttachLoadBalancerToSubnets AttachLoadBalancerToSubnets 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 Add or Remove Subnets for Your Load Balancer in a VPC in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerName The name of the load balancer. Subnets.member.N The IDs of the subnets to add for the load balancer. You can add only one subnet per Availability Zone. list Response Elements The following element is returned. Subnets The IDs of the subnets attached to the load balancer. list Errors For information about the errors that are common to all actions, see Common Errors (p. 86). InvalidConfigurationRequest The requested configuration change is not valid. HTTP Status Code: 409 InvalidSubnet The specified VPC has no associated Internet gateway. LoadBalancerNotFound The specified load balancer does not exist. SubnetNotFound One or more of the specified subnets do not exist. 7

14 Sample Request &LoadBalancerName=my-vpc-loadbalancer &Subnets.member.1=subnet-3561b05e &Version= &AUTHPARAMS Sample Response <AttachLoadBalancerToSubnetsResponse xmlns=" aws.com/doc/ /"> <AttachLoadBalancerToSubnetsResult> <Subnets> <member>subnet-119f0078</member> <member>subnet-3561b05e</member> </Subnets> </AttachLoadBalancerToSubnetsResult> <ResponseMetadata> <RequestId>07b1ecbc e3-acaf-dd7edEXAMPLE</RequestId> </ResponseMetadata> </AttachLoadBalancerToSubnetsResponse> 8

15 ConfigureHealthCheck ConfigureHealthCheck Specifies the health check settings to use when evaluating the health state of your back-end instances. For more information, see Configure Health Checks in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). HealthCheck The configuration information for the new health check. Type: HealthCheck (p. 71) LoadBalancerName The name of the load balancer. Response Elements The following element is returned. HealthCheck The updated health check. Type: HealthCheck (p. 71) Errors For information about the errors that are common to all actions, see Common Errors (p. 86). LoadBalancerNotFound The specified load balancer does not exist. Sample Request &LoadBalancerName=my-loadbalancer &HealthCheck.HealthyThreshold=2 &HealthCheck.UnhealthyThreshold=2 &HealthCheck.Target= &HealthCheck.Interval=30 9

16 &HealthCheck.Timeout=3 &Version= &AUTHPARAMS Sample Response <ConfigureHealthCheckResponse xmlns=" aws.com/doc/ /"> <ConfigureHealthCheckResult> <HealthCheck> <Interval>30</Interval> <Target> <HealthyThreshold>2</HealthyThreshold> <Timeout>3</Timeout> <UnhealthyThreshold>2</UnhealthyThreshold> </HealthCheck> </ConfigureHealthCheckResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </ConfigureHealthCheckResponse> 10

17 CreateAppCookieStickinessPolicy CreateAppCookieStickinessPolicy 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 (p. 13), 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 Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). CookieName The name of the application cookie used for stickiness. LoadBalancerName The name of the load balancer. PolicyName The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 86). DuplicatePolicyName A policy with the specified name already exists for this load balancer. InvalidConfigurationRequest The requested configuration change is not valid. HTTP Status Code: 409 LoadBalancerNotFound The specified load balancer does not exist. 11

18 TooManyPolicies The quota for the number of policies for this load balancer has been reached. Sample Request Policy &LoadBalancerName=my-loadbalancer &PolicyName=my-app-sticky-policy &CookieName=my-app-cookie &Version= &AUTHPARAMS Sample Response <CreateAppCookieStickinessPolicyResponse xmlns=" cing.amazonaws.com/doc/ /"> <CreateAppCookieStickinessPolicyResult/> <ResponseMetadata> <RequestId>99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE</RequestId> </ResponseMetadata> </CreateAppCookieStickinessPolicyResponse> 12

19 CreateLBCookieStickinessPolicy CreateLBCookieStickinessPolicy 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 Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). CookieExpirationPeriod 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. Type: Long LoadBalancerName The name of the load balancer. PolicyName The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 86). DuplicatePolicyName A policy with the specified name already exists for this load balancer. InvalidConfigurationRequest The requested configuration change is not valid. HTTP Status Code:

20 LoadBalancerNotFound The specified load balancer does not exist. TooManyPolicies The quota for the number of policies for this load balancer has been reached. Sample Request &LoadBalancerName=my-loadbalancer &PolicyName=my-duration-sticky-policy &CookieExpirationPeriod=60 &Version= &AUTHPARAMS Sample Response <CreateLBCookieStickinessPolicyResponse xmlns=" aws.com/doc/ /"> <CreateLBCookieStickinessPolicyResult/> <ResponseMetadata> <RequestId>99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE</RequestId> </ResponseMetadata> </CreateLBCookieStickinessPolicyResponse> 14

21 CreateLoadBalancer CreateLoadBalancer Creates a load balancer. If the call completes successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The load balancer receives incoming traffic and routes it to the registered instances. For more information, see How Elastic Load Balancing Works in the Elastic Load Balancing Developer Guide. 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). AvailabilityZones.member.N 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 (p. 51). list Listeners.member.N The listeners. For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide. Type: Listener (p. 74) list LoadBalancerName The name of the load balancer. This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen. Scheme 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. 15

22 Response Elements SecurityGroups.member.N The IDs of the security groups to assign to the load balancer. list Subnets.member.N The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones. list Tags.member.N 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. Type: Tag (p. 82) list Length constraints: Minimum of 1 item(s) in the list. Response Elements The following element is returned. DNSName The DNS name of the load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 86). CertificateNotFound The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM). DuplicateLoadBalancerName The specified load balancer name already exists for this account. DuplicateTagKeys A tag key was specified more than once. InvalidConfigurationRequest The requested configuration change is not valid. 16

23 HTTP Status Code: 409 InvalidScheme The specified value for the schema is not valid. You can only specify a scheme for load balancers in a VPC. InvalidSecurityGroup One or more of the specified security groups do not exist. InvalidSubnet The specified VPC has no associated Internet gateway. SubnetNotFound One or more of the specified subnets do not exist. TooManyLoadBalancers The quota for the number of load balancers has been reached. TooManyTags The quota for the number of tags that can be assigned to a load balancer has been reached. Create a TCP Load Balancer in EC2-Classic Sample Request &LoadBalancerName=my-loadbalancer &AvailabilityZones.member.1=us-east-1c &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Version= &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>my-loadbalancer us-east-1.elb.amazonaws.com</DNSName> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> 17

24 </ResponseMetadata> </CreateLoadBalancerResponse> Create an HTTPS Load Balancer in EC2-Classic Sample Request &LoadBalancerName=my-https-loadbalancer &AvailabilityZones.member.1=us-east-1c &Listeners.member.1.LoadBalancerPort=443 &Listeners.member.1.InstancePort=443 &Listeners.member.1.Protocol=https &Listeners.member.1.InstanceProtocol=https &Listeners.member.1.SSLCertificateId=arn:aws:iam:: :server-certific ate/servercert &Version= &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>my-https-loadbalancer us-east-1.elb.amazonaws.com</DNS Name> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create a TCP Load Balancer in EC2-VPC Sample Request &LoadBalancerName=my-vpc-loadbalancer &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Subnets.member.1=subnet-6dec9f03 &SecurityGroups.member.1=sg-6801da07 &Version= &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> 18

25 <DNSName>my-vpc-loadbalancer us-east-1.elb.amazonaws.com</DNSName> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create an Internal TCP Load Balancer in EC2-VPC Sample Request &LoadBalancerName=my-internal-loadbalancer &Scheme=internal &SecurityGroups.member.1=sg-706cb61f &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Subnets.member.1=subnet-9edc97f0 &Version= &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>internal-my-internal-loadbalancer us-east- 1.elb.amazonaws.com</DNSName> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create a TCP Load Balancer in a Default VPC Sample Request &LoadBalancerName=my-defaultvpc-loadbalancer &AvailabilityZones.member.1=sa-east-1b &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Version= &AUTHPARAMS 19

26 Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>my-defaultvpc-loadbalancer sa.east-1.elb.amazon aws.com</dnsname> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create a TCP Load Balancer in EC2-Classic and Assign a Tag Sample Request &LoadBalancerName=my-loadbalancer &AvailabilityZones.member.1=us-east-1c; &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Tags.member.1.Value=digital-media &Tags.member.1.Key=department &Version= &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>my-loadbalancer us-east-1.elb.amazonaws.com</DNSName> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> 20

27 CreateLoadBalancerListeners CreateLoadBalancerListeners 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 Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). Listeners.member.N The listeners. Type: Listener (p. 74) list LoadBalancerName The name of the load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 86). CertificateNotFound The specified SSL ID does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM). DuplicateListener A listener already exists for the specified LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId. InvalidConfigurationRequest The requested configuration change is not valid. HTTP Status Code: 409 LoadBalancerNotFound The specified load balancer does not exist. 21

28 Sample Request &LoadBalancerName=my-https-loadbalancer &Listeners.member.1.Protocol=https &Listeners.member.1.LoadBalancerPort=443 &Listeners.member.1.InstancePort=443 &Listeners.member.1.InstanceProtocol=https &Listeners.member.1.SSLCertificateId=arn:aws:iam:: :server-certific ate/servercert &Version= &AUTHPARAMS Sample Response <CreateLoadBalancerListenersResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerListenersResult/> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerListenersResponse> 22

29 CreateLoadBalancerPolicy CreateLoadBalancerPolicy 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 Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerName The name of the load balancer. PolicyAttributes.member.N The attributes for the policy. Type: PolicyAttribute (p. 79) list PolicyName The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer. PolicyTypeName The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes (p. 39). Errors For information about the errors that are common to all actions, see Common Errors (p. 86). DuplicatePolicyName A policy with the specified name already exists for this load balancer. InvalidConfigurationRequest The requested configuration change is not valid. HTTP Status Code: 409 LoadBalancerNotFound The specified load balancer does not exist. 23

30 PolicyTypeNotFound One or more of the specified policy types do not exist. TooManyPolicies The quota for the number of policies for this load balancer has been reached. Sample Request &LoadBalancerName=my-loadbalancer &PolicyName=EnableProxyProtocol &PolicyTypeName=ProxyProtocolPolicyType &PolicyAttributes.member.1.AttributeName=ProxyProtocol &PolicyAttributes.member.1.AttributeValue=true &Version= &AUTHPARAMS Sample Response <CreateLoadBalancerPolicyResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerPolicyResult/> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerPolicyResponse> 24

31 DeleteLoadBalancer DeleteLoadBalancer 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 Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerName The name of the load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 86). 25

32 DeleteLoadBalancerListeners DeleteLoadBalancerListeners Deletes the specified listeners from the specified load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerName The name of the load balancer. LoadBalancerPorts.member.N The client port numbers of the listeners. Type: Integer list Errors For information about the errors that are common to all actions, see Common Errors (p. 86). LoadBalancerNotFound The specified load balancer does not exist. 26

33 DeleteLoadBalancerPolicy DeleteLoadBalancerPolicy Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerName The name of the load balancer. PolicyName The name of the policy. Errors For information about the errors that are common to all actions, see Common Errors (p. 86). InvalidConfigurationRequest The requested configuration change is not valid. HTTP Status Code: 409 LoadBalancerNotFound The specified load balancer does not exist. 27

34 DeregisterInstancesFromLoadBalancer DeregisterInstancesFromLoadBalancer 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 (p. 42) 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 Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). Instances.member.N The IDs of the instances. Type: Instance (p. 72) list LoadBalancerName The name of the load balancer. Response Elements The following element is returned. Instances The remaining instances registered with the load balancer. Type: Instance (p. 72) list Errors For information about the errors that are common to all actions, see Common Errors (p. 86). InvalidInstance The specified endpoint is not valid. LoadBalancerNotFound The specified load balancer does not exist. 28

35 Deregister instance i-e3677ad7 from the my-https-loadbalancer load balancer. Sample Request Balancer &LoadBalancerName=my-https-loadbalancer &Instances.member.1.InstanceId=i-e3677ad7 &Version= &AUTHPARAMS Sample Response <DeregisterInstancesFromLoadBalancerResponse xmlns=" cing.amazonaws.com/doc/ /"> <DeregisterInstancesFromLoadBalancerResult> <Instances> <member> <InstanceId>i-6ec63d59</InstanceId> </member> </Instances> </DeregisterInstancesFromLoadBalancerResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DeregisterInstancesFromLoadBalancerResponse> 29

36 DescribeInstanceHealth DescribeInstanceHealth Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). Instances.member.N The IDs of the instances. Type: Instance (p. 72) list LoadBalancerName The name of the load balancer. Response Elements The following element is returned. InstanceStates Information about the health of the instances. Type: InstanceState (p. 72) list Errors For information about the errors that are common to all actions, see Common Errors (p. 86). InvalidInstance The specified endpoint is not valid. LoadBalancerNotFound The specified load balancer does not exist. 30

37 Description of a healthy instance Sample Request &LoadBalancerName=my-loadbalancer &Version= &AUTHPARAMS Sample Response <DescribeInstanceHealthResponse xmlns=" aws.com/doc/ /"> <DescribeInstanceHealthResult> <InstanceStates> <member> <Description>N/A</Description> <InstanceId>i-90d8c2a5</InstanceId> <State>InService</State> <ReasonCode>N/A</ReasonCode> </member> </InstanceStates> </DescribeInstanceHealthResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeInstanceHealthResponse> Description of an instance with registration in progress Sample Request &LoadBalancerName=my-loadbalancer &Version= &AUTHPARAMS Sample Response <DescribeInstanceHealthResponse xmlns=" aws.com/doc/ /"> <DescribeInstanceHealthResult> <InstanceStates> <member> <Description>Instance registration is still in progress.</description> <InstanceId>i-315b7e51</InstanceId> <State>OutOfService</State> <ReasonCode>ELB</ReasonCode> </member> 31

38 </InstanceStates> </DescribeInstanceHealthResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeInstanceHealthResponse> Description of an unhealthy (OutOfService) instance Sample Request &LoadBalancerName=my-loadbalancer &Version= &AUTHPARAMS Sample Response <DescribeInstanceHealthResponse xmlns=" aws.com/doc/ /"> <DescribeInstanceHealthResult> <InstanceStates> <member> <Description>Instance has failed at least the UnhealthyThreshold number of health checks consecutively.</description> <InstanceId>i-fda142c9</InstanceId> <State>OutOfService</State> <ReasonCode>Instance</ReasonCode> </member> </InstanceStates> </DescribeInstanceHealthResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeInstanceHealthResponse> Description of an instance in an unknown state Sample Request &LoadBalancerName=my-loadbalancer &Version= &AUTHPARAMS Sample Response <DescribeInstanceHealthResponse xmlns=" aws.com/doc/ /"> <DescribeInstanceHealthResult> 32

39 <InstanceStates> <member> <Description>A transient error occurred. Please try again later.</de scription> <InstanceId>i-7f12e649</InstanceId> <State>Unknown</State> <ReasonCode>ELB</ReasonCode> </member> </InstanceStates> </DescribeInstanceHealthResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeInstanceHealthResponse> 33

40 DescribeLoadBalancerAttributes DescribeLoadBalancerAttributes Describes the attributes for the specified load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerName The name of the load balancer. Response Elements The following element is returned. LoadBalancerAttributes Information about the load balancer attributes. Type: LoadBalancerAttributes (p. 75) Errors For information about the errors that are common to all actions, see Common Errors (p. 86). LoadBalancerAttributeNotFound The specified load balancer attribute does not exist. LoadBalancerNotFound The specified load balancer does not exist. Sample Request &LoadBalancerName=my-loadbalancer &Version= &AUTHPARAMS Sample Response <DescribeLoadBalancerAttributesResponse xmlns=" cing.amazonaws.com/doc/ /"> 34

41 <DescribeLoadBalancerAttributesResult> <LoadBalancerAttributes> <AccessLog> <Enabled>true</Enabled> <S3BucketName>my-loadbalancer-logs</S3BucketName> <S3BucketPrefix>testprefix</S3BucketPrefix> <EmitInterval>5</EmitInterval> </AccessLog> <ConnectionSettings> <IdleTimeout>30</IdleTimeout> </ConnectionSettings> <CrossZoneLoadBalancing> <Enabled>true</Enabled> </CrossZoneLoadBalancing> <ConnectionDraining> <Enabled>true</Enabled> <Timeout>60</Timeout> </ConnectionDraining> </LoadBalancerAttributes> </DescribeLoadBalancerAttributesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerAttributesResponse> 35

42 DescribeLoadBalancerPolicies DescribeLoadBalancerPolicies 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 Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerName The name of the load balancer. PolicyNames.member.N The names of the policies. list Response Elements The following element is returned. PolicyDescriptions Information about the policies. Type: PolicyDescription (p. 81) list Errors For information about the errors that are common to all actions, see Common Errors (p. 86). LoadBalancerNotFound The specified load balancer does not exist. PolicyNotFound One or more of the specified policies do not exist. 36

43 Description of all policies associated with a load balancer Sample Request &LoadBalancerName=my-loadbalancer &Version= &AUTHPARAMS Sample Response <DescribeLoadBalancerPoliciesResponse xmlns=" aws.com/doc/ /"> <DescribeLoadBalancerPoliciesResult> <PolicyDescriptions> <member> <PolicyName>my-duration-sticky-policy</PolicyName> <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName> <PolicyAttributeDescriptions> <member> <AttributeName>CookieExpirationPeriod</AttributeName> <AttributeValue>60</AttributeValue> </member> </PolicyAttributeDescriptions> </member> <member> <PolicyName>my-app-sticky-policy</PolicyName> <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName> <PolicyAttributeDescriptions> <member> <AttributeName>CookieName</AttributeName> <AttributeValue>my-app-cookie</AttributeValue> </member> </PolicyAttributeDescriptions> </member> </PolicyDescriptions> </DescribeLoadBalancerPoliciesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPoliciesResponse> Description of a specified policy associated with the load balancer Sample Request &LoadBalancerName=my-loadbalancer &PolicyNames.member.1=EnableProxyProtocol 37

44 &Version= &AUTHPARAMS Sample Response <DescribeLoadBalancerPoliciesResponse xmlns=" aws.com/doc/ /"> <DescribeLoadBalancerPoliciesResult> <PolicyDescriptions> <member> <PolicyName>EnableProxyProtocol</PolicyName> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <PolicyAttributeDescriptions> <member> <AttributeName>ProxyProtocol</AttributeName> <AttributeValue>true</AttributeValue> </member> </PolicyAttributeDescriptions> </member> </PolicyDescriptions> </DescribeLoadBalancerPoliciesResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPoliciesResponse> 38

45 DescribeLoadBalancerPolicyTypes DescribeLoadBalancerPolicyTypes Describes the specified load balancer policy types. You can use these policy types with CreateLoadBalancerPolicy (p. 23) to create policy configurations for a load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). PolicyTypeNames.member.N The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing. list Response Elements The following element is returned. PolicyTypeDescriptions Information about the policy types. Type: PolicyTypeDescription (p. 81) list Errors For information about the errors that are common to all actions, see Common Errors (p. 86). PolicyTypeNotFound One or more of the specified policy types do not exist. Partial description of all policy types defined by Elastic Load Balancing for your account Sample Request cytypes &Version= &AUTHPARAMS 39

46 Sample Response <DescribeLoadBalancerPolicyTypesResponse xmlns=" cing.amazonaws.com/doc/ /"> <DescribeLoadBalancerPolicyTypesResult> <PolicyTypeName>SSLNegotiationPolicyType</PolicyTypeName> <...> <PolicyTypeName>BackendServerAuthenticationPolicyType</PolicyTypeName> <...> <PolicyTypeName>PublicKeyPolicyType</PolicyTypeName> <...> <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName> <...> <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName> <...> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <...> </DescribeLoadBalancerPolicyTypesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPolicyTypesResponse> Description of ProxyProtocolPolicyType Sample Request cytypes &PolicyTypeNames.member.1=ProxyProtocolPolicyType &Version= &AUTHPARAMS Sample Response <DescribeLoadBalancerPolicyTypesResponse xmlns=" cing.amazonaws.com/doc/ /"> <DescribeLoadBalancerPolicyTypesResult> <PolicyTypeDescriptions> <member> <PolicyAttributeTypeDescriptions> <member> <AttributeName>ProxyProtocol</AttributeName> <AttributeType>Boolean</AttributeType> <Cardinality>ONE</Cardinality> </member> </PolicyAttributeTypeDescriptions> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <Description>Policy that controls whether to include the IP address and port of the originating request for TCP messages. This policy operates on TCP/SSL listeners only</description> </member> </PolicyTypeDescriptions> </DescribeLoadBalancerPolicyTypesResult> <ResponseMetadata> 40

47 <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPolicyTypesResponse> 41

48 DescribeLoadBalancers DescribeLoadBalancers Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerNames.member.N The names of the load balancers. list Marker The marker for the next set of results. (You received this marker from a previous call.) PageSize The maximum number of results to return with this call (a number from 1 to 400). The default is 400. Type: Integer Valid range: Minimum value of 1. Maximum value of 400. Response Elements The following elements are returned. LoadBalancerDescriptions Information about the load balancers. Type: LoadBalancerDescription (p. 76) list NextMarker The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Errors For information about the errors that are common to all actions, see Common Errors (p. 86). LoadBalancerNotFound The specified load balancer does not exist. 42

49 Description of a specified load balancer Sample Request &LoadBalancerNames.member.1=my-loadbalancer &Version= &AUTHPARAMS Sample Response <DescribeLoadBalancersResponse xmlns=" aws.com/doc/ /"> <DescribeLoadBalancersResult> <LoadBalancerDescriptions> <member> <SecurityGroups/> <LoadBalancerName>my-loadbalancer</LoadBalancerName> <CreatedTime> T21:15:31.280Z</CreatedTime> <HealthCheck> <Interval>90</Interval> <Target> <HealthyThreshold>2</HealthyThreshold> <Timeout>60</Timeout> <UnhealthyThreshold>10</UnhealthyThreshold> </HealthCheck> <ListenerDescriptions> <member> <PolicyNames/> <Listener> <Protocol>HTTP</Protocol> <LoadBalancerPort>80</LoadBalancerPort> <InstanceProtocol>HTTP</InstanceProtocol> <InstancePort>80</InstancePort> </Listener> </member> </ListenerDescriptions> <Instances> <member> <InstanceId>i-e4cbe38d</InstanceId> </member> </Instances> <Policies> <AppCookieStickinessPolicies/> <OtherPolicies/> <LBCookieStickinessPolicies/> </Policies> <AvailabilityZones> <member>us-east-1a</member> </AvailabilityZones> <CanonicalHostedZoneNameID>ZZZZZZZZZZZ123X</CanonicalHostedZoneNameID> <CanonicalHostedZoneName>my-loadbalancer us-east- 43

50 1.elb.amazonaws.com</CanonicalHostedZoneName> <Scheme>internet-facing</Scheme> <SourceSecurityGroup> <OwnerAlias>amazon-elb</OwnerAlias> <GroupName>amazon-elb-sg</GroupName> </SourceSecurityGroup> <DNSName>my-loadbalancer us-east-1.elb.amazonaws.com</DNSName> <BackendServerDescriptions/> <Subnets/> </member> </LoadBalancerDescriptions> </DescribeLoadBalancersResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancersResponse> 44

51 DescribeTags DescribeTags Describes the tags associated with the specified load balancers. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 84). LoadBalancerNames.member.N The names of the load balancers. list Length constraints: Minimum of 1 item(s) in the list. Maximum of 20 item(s) in the list. Response Elements The following element is returned. TagDescriptions Information about the tags. Type: TagDescription (p. 83) list Errors For information about the errors that are common to all actions, see Common Errors (p. 86). LoadBalancerNotFound The specified load balancer does not exist. Sample Request &LoadBalancerNames.member.1=my-loadbalancer &Version= &AUTHPARAMS Sample Response <DescribeTagsResponse xmlns=" <DescribeTagsResult> <TagDescriptions> 45