Elastic Load Balancing. API Reference API Version

Transcription

1 Elastic Load Balancing API Reference

2 Elastic Load Balancing: API Reference Copyright 2014 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. The following are trademarks of Amazon Web Services, Inc.: Amazon, Amazon Web Services Design, AWS, Amazon CloudFront, Cloudfront, Amazon DevPay, DynamoDB, ElastiCache, Amazon EC2, Amazon Elastic Compute Cloud, Amazon Glacier, Kindle, Kindle Fire, AWS Marketplace Design, Mechanical Turk, Amazon Redshift, Amazon Route 53, Amazon S3, Amazon VPC. In addition, Amazon.com graphics, logos, page headers, button icons, scripts, and service names are trademarks, or trade dress of Amazon in the U.S. and/or other countries. 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 Welcome... 1 Actions... 2 AddTags Request Parameters... 3 Errors ApplySecurityGroupsToLoadBalancer Request Parameters... 5 Response Elements... 5 Errors AttachLoadBalancerToSubnets Request Parameters... 7 Response Elements... 7 Errors ConfigureHealthCheck 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 DeleteLoadBalancerListeners iii

4 Request Parameters Errors DeleteLoadBalancerPolicy Request Parameters Errors DeregisterInstancesFromLoadBalancer Request Parameters Response Elements Errors 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 iv

5 Response Elements Errors EnableAvailabilityZonesForLoadBalancer Request Parameters Response Elements Errors ModifyLoadBalancerAttributes Request Parameters Response Elements Errors RegisterInstancesWithLoadBalancer Request Parameters Response Elements Errors RemoveTags Request Parameters Errors SetLoadBalancerListenerSSLCertificate Request Parameters Errors SetLoadBalancerPoliciesForBackendServer Request Parameters Errors SetLoadBalancerPoliciesOfListener Request Parameters Errors Data Types AccessLog AddTagsResult AppCookieStickinessPolicy ApplySecurityGroupsToLoadBalancerResult AttachLoadBalancerToSubnetsResult BackendServer v

6 ConfigureHealthCheckResult ConnectionDraining ConnectionSettings CreateAppCookieStickinessPolicyResult CreateLBCookieStickinessPolicyResult CreateLoadBalancerListenersResult CreateLoadBalancerPolicyResult CreateLoadBalancerResult CrossZoneLoadBalancing DeleteLoadBalancerListenersResult DeleteLoadBalancerPolicyResult DeleteLoadBalancerResult DeregisterInstancesFromLoadBalancerResult DescribeInstanceHealthResult DescribeLoadBalancerAttributesResult DescribeLoadBalancerPoliciesResult DescribeLoadBalancerPolicyTypesResult DescribeLoadBalancersResult DescribeTagsResult vi

7 DetachLoadBalancerFromSubnetsResult DisableAvailabilityZonesForLoadBalancerResult EnableAvailabilityZonesForLoadBalancerResult HealthCheck Instance InstanceState LBCookieStickinessPolicy Listener Listener LoadBalancerAttributes LoadBalancer ModifyLoadBalancerAttributesResult Policies PolicyAttribute PolicyAttribute PolicyAttributeType Policy PolicyType RegisterInstancesWithLoadBalancerResult vii

8 RemoveTagsResult SetLoadBalancerListenerSSLCertificateResult SetLoadBalancerPoliciesForBackendServerResult SetLoadBalancerPoliciesOfListenerResult SourceSecurityGroup Tag Tag TagKeyOnly Common Parameters Common Parameters for Signature V4 Signing Common Errors viii

9 Welcome Elastic Load Balancing is a way to automatically distribute incoming web traffic across applications that run on multiple Amazon Elastic Compute Cloud (Amazon EC2) instances. You can create, access, and manage Elastic Load Balancing using the AWS Management Console, the AWS Command Line Interface (AWS CLI), the Query API, or the AWS SDKs. For more information about Elastic Load Balancing interfaces, see Accessing Elastic Load Balancing. This reference guide contains documentation for the Query API and the AWS CLI commands, to manage Elastic Load Balancing. For detailed information about Elastic Load Balancing features and their associated actions or commands, go to Managing Load Balancers in the Elastic Load Balancing Developer Guide. This reference guide is based on the current WSDL, which is available at: Endpoints The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint. You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see Regions and Endpoints in the Amazon Web Services General Reference. This document was last updated on August 8,

10 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. 22) CreateLoadBalancerPolicy (p. 24) DeleteLoadBalancer (p. 26) DeleteLoadBalancerListeners (p. 27) DeleteLoadBalancerPolicy (p. 28) DeregisterInstancesFromLoadBalancer (p. 29) DescribeInstanceHealth (p. 31) DescribeLoadBalancerAttributes (p. 35) DescribeLoadBalancerPolicies (p. 37) DescribeLoadBalancerPolicyTypes (p. 40) DescribeLoadBalancers (p. 43) DescribeTags (p. 46) DetachLoadBalancerFromSubnets (p. 48) DisableAvailabilityZonesForLoadBalancer (p. 50) EnableAvailabilityZonesForLoadBalancer (p. 52) ModifyLoadBalancerAttributes (p. 54) RegisterInstancesWithLoadBalancer (p. 58) RemoveTags (p. 60) SetLoadBalancerListenerSSLCertificate (p. 62) SetLoadBalancerPoliciesForBackendServer (p. 64) SetLoadBalancerPoliciesOfListener (p. 66) 2

11 AddTags AddTags Adds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. Each tag consists of a key and an optional value. Tag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, this action will update the value of the key. For more information, see Tagging in the Elastic Load Balancing Developer Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerNames.member.N The name of the load balancer to tag. You can specify a maximum of one load balancer name. list Tags.member.N A list of tags for each load balancer. Type: Tag (p. 91) 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. 97). AccessPointNotFound The specified load balancer could not be found. DuplicateTagKeys The same tag key specified multiple times. TooManyTags The quota for the number of tags that can be assigned to a load balancer has been reached. 3

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

13 ApplySecurityGroupsToLoadBalancer ApplySecurityGroupsToLoadBalancer 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the load balancer.the name must be unique within the set of load balancers associated with your AWS account. SecurityGroups.member.N A list of security group IDs to associate with your load balancer in VPC. The security group IDs must be provided as the ID and not the security group name (For example, sg-1234). list Response Elements The following element is returned in a structure named ApplySecurityGroupsToLoadBalancerResult. SecurityGroups A list of security group IDs associated with your load balancer. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 InvalidSecurityGroup One or more specified security groups do not exist. 5

14 Sample Request &LoadBalancerName=my-test-vpc-loadbalancer &Version= &Action=ApplySecurityGroupsToLoadBalancer &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

15 AttachLoadBalancerToSubnets AttachLoadBalancerToSubnets 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the load balancer.the name must be unique within the set of load balancers associated with your AWS account. Subnets.member.N A list of subnet IDs to add for the load balancer. You can add only one subnet per Availability Zone. list Response Elements The following element is returned in a structure named AttachLoadBalancerToSubnetsResult. Subnets A list of subnet IDs attached to the load balancer. list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 InvalidSubnet The VPC has no Internet gateway. 7

16 SubnetNotFound One or more subnets were not found. Sample Request &LoadBalancerName=my-test-vpc-loadbalancer &Version= &Action=AttachLoadBalancerToSubnets &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

17 ConfigureHealthCheck ConfigureHealthCheck 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). HealthCheck A structure containing the configuration information for the new healthcheck. Type: HealthCheck (p. 78) LoadBalancerName The mnemonic name associated with the load balancer. The name must be unique within the set of load balancers associated with your AWS account. Response Elements The following element is returned in a structure named ConfigureHealthCheckResult. HealthCheck The updated healthcheck for the instances. Type: HealthCheck (p. 78) Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. Sample Request &HealthCheck.UnhealthyThreshold=2 9

18 &LoadBalancerName=MyLoadBalancer &HealthCheck.Target= &HealthCheck.Interval=30 &HealthCheck.Timeout=3 &Version= &Action=ConfigureHealthCheck &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

19 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 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). CookieName Name of the application cookie used for stickiness. LoadBalancerName The name of the load balancer. PolicyName The name of the policy being created. The 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. 97). AccessPointNotFound The specified load balancer could not be found. 11

20 DuplicatePolicyName Policy with the same name exists for this load balancer. Please choose another name. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 TooManyPolicies Quota for number of policies for this load balancer has already been reached. Sample Request &LoadBalancerName=MyLoadBalancer &PolicyName=MyAppStickyPolicy &Version= &Action=CreateAppCookieStickinessPolicy &AUTHPARAMS Sample Response <CreateAppCookieStickinessPolicyResponse xmlns=" cing.amazonaws.com/doc/ /"> <CreateAppCookieStickinessPolicyResult/> <ResponseMetadata> <RequestId>99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE</RequestId> </ResponseMetadata> </CreateAppCookieStickinessPolicyResponse> 12

21 CreateLBCookieStickinessPolicy CreateLBCookieStickinessPolicy Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (useragent) 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). CookieExpirationPeriod 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. Type: Long LoadBalancerName The name associated with the load balancer. PolicyName The name of the policy being created. The 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. 97). AccessPointNotFound The specified load balancer could not be found. DuplicatePolicyName Policy with the same name exists for this load balancer. Please choose another name. 13

22 InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 TooManyPolicies Quota for number of policies for this load balancer has already been reached. Sample Request &LoadBalancerName=MyLoadBalancer&PolicyName=MyDurationStickyPolicy &Version= &Action=CreateLBCookieStickinessPolicy &AUTHPARAMS Sample Response <CreateLBCookieStickinessPolicyResponse xmlns=" aws.com/doc/ /"> <CreateLBCookieStickinessPolicyResult/> <ResponseMetadata> <RequestId>99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE</RequestId> </ResponseMetadata> </CreateLBCookieStickinessPolicyResponse> 14

23 CreateLoadBalancer CreateLoadBalancer 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: us-east-1.elb.amazonaws.com (for the Northern Virginia region) us-west-1.elb.amazonaws.com (for the Northern California region) 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: EC2-Classic For information on creating and managing your load balancers in EC2-Classic, see Deploy Elastic Load Balancing in Amazon EC2-Classic. EC2-VPC For information on creating and managing your load balancers in EC2-VPC, see Deploy Elastic Load Balancing in Amazon VPC. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). AvailabilityZones.member.N 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 load balancer. Traffic will be equally distributed across all zones. You can later add more Availability Zones after the creation of the load balancer by calling EnableAvailabilityZonesForLoadBalancer (p. 52) action. list Listeners.member.N A list of the following tuples: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId. Type: Listener (p. 81) list 15

24 Response Elements LoadBalancerName The name associated with the load balancer. The name must be unique within your set of load balancers, must have a maximum of 32 characters, and must only contain alphanumeric characters or hyphens. Scheme The type of a load balancer. 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. Specify the value internal for this option to create an internal load balancer with a DNS name that resolves to private IP addresses. Note This option is only available for load balancers created within EC2-VPC. SecurityGroups.member.N The security groups to assign to your load balancer within your VPC. list Subnets.member.N A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone. list Tags.member.N A list of tags to assign to the load balancer. For more information about setting tags for your load balancer, see Tagging. Type: Tag (p. 91) list Length constraints: Minimum of 1 item(s) in the list. Response Elements The following element is returned in a structure named CreateLoadBalancerResult. DNSName The DNS name for the load balancer. 16

25 Errors Errors For information about the errors that are common to all actions, see Common Errors (p. 97). CertificateNotFound The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service. DuplicateAccessPointName The load balancer name already exists for this account. Please choose another name. DuplicateTagKeys The same tag key specified multiple times. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code: 409 InvalidScheme Invalid value for scheme. Scheme can only be specified for load balancers in VPC. InvalidSecurityGroup One or more specified security groups do not exist. InvalidSubnet The VPC has no Internet gateway. SubnetNotFound One or more subnets were not found. TooManyAccessPoints The quota for the number of load balancers has already been reached. TooManyTags The quota for the number of tags that can be assigned to a load balancer has been reached. 17

26 Create a TCP Load Balancer in EC2-Classic Sample Request &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= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>my-test-loadbalancer us-east-1.elb.amazonaws.com</DNS Name> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create an HTTPS Load Balancer in EC2-Classic Sample Request &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= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>MyHTTPSLoadBalancer us-east-1.elb.amazonaws.com</DNSName> 18

27 </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create a TCP Load Balancer in EC2-VPC Sample Request &LoadBalancerName=MyVPCLoadBalancer &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 &Version= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>MyVPCLoadBalancer 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 &SecurityGroups.member.1=sg-706cb61f &LoadBalancerName=MyInternalLoadBalancer &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= &Action=CreateLoadBalancer &AUTHPARAMS 19

28 Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>internal-MyInternalLoadBalancer us-east-1.elb.amazon aws.com</dnsname> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> Create a TCP Load Balancer in a Default VPC Sample Request Balancer &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= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>MyDefaultVPCLoadBalancer sa.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-Classic and Assign a Tag Sample Request &AvailabilityZones.member.1=us-east-1c; &Listeners.member.1.LoadBalancerPort=80 &Listeners.member.1.InstancePort=80 20

29 &Listeners.member.1.Protocol=http &Listeners.member.1.InstanceProtocol=http &Tags.member.1.Value=digital-media &Tags.member.1.Key=department &Version= &Action=CreateLoadBalancer &AUTHPARAMS Sample Response <CreateLoadBalancerResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerResult> <DNSName>my-test-loadbalancer us-east-1.elb.amazonaws.com</DNS Name> </CreateLoadBalancerResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerResponse> 21

30 CreateLoadBalancerListeners CreateLoadBalancerListeners 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). Listeners.member.N A list of LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and SSLCertificateId items. Type: Listener (p. 81) list LoadBalancerName The name of the load balancer. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. CertificateNotFound The specified SSL ID does not refer to a valid SSL certificate in the AWS Identity and Access Management Service. DuplicateListener A Listener already exists for the given LoadBalancerName and LoadBalancerPort, but with a different InstancePort, Protocol, or SSLCertificateId. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code:

31 Sample Request &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 &LoadBalancerName=MyHTTPSLoadBalancer &Version= &Action=CreateLoadBalancerListeners &AUTHPARAMS Sample Response <CreateLoadBalancerListenersResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerListenersResult/> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerListenersResponse> 23

32 CreateLoadBalancerPolicy CreateLoadBalancerPolicy 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the LoadBalancer for which the policy is being created. PolicyAttributes.member.N A list of attributes associated with the policy being created. Type: PolicyAttribute (p. 86) list PolicyName The name of the load balancer policy being created. The name must be unique within the set of policies for this load balancer. PolicyTypeName The name of the base policy type being used to create this policy. To get the list of policy types, use the DescribeLoadBalancerPolicyTypes (p. 40) action. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. DuplicatePolicyName Policy with the same name exists for this load balancer. Please choose another name. InvalidConfigurationRequest Requested configuration change is invalid. 24

33 HTTP Status Code: 409 PolicyTypeNotFound One or more of the specified policy types do not exist. TooManyPolicies Quota for number of policies for this load balancer has already been reached. Sample Request Name=ProxyProtocol &PolicyAttributes.member.1.AttributeValue=true &PolicyTypeName=ProxyProtocolPolicyType &LoadBalancerName=my-test-loadbalancer &PolicyName=EnableProxyProtocol &Version= &Action=CreateLoadBalancerPolicy &AUTHPARAMS Sample Response <CreateLoadBalancerPolicyResponse xmlns=" aws.com/doc/ /"> <CreateLoadBalancerPolicyResult/> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </CreateLoadBalancerPolicyResponse> 25

34 DeleteLoadBalancer DeleteLoadBalancer 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 DeleteLoad- Balancer action still succeeds. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name associated with the load balancer. 26

35 DeleteLoadBalancerListeners DeleteLoadBalancerListeners Deletes listeners from the load balancer for the specified port. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The mnemonic name associated with the load balancer. LoadBalancerPorts.member.N The client port number(s) of the load balancer listener(s) to be removed. Type: Integer list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. 27

36 DeleteLoadBalancerPolicy DeleteLoadBalancerPolicy Deletes a policy from the load balancer. The specified policy must not be enabled for any listeners. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The mnemonic name associated with the load balancer. PolicyName The mnemonic name for the policy being deleted. Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidConfigurationRequest Requested configuration change is invalid. HTTP Status Code:

37 DeregisterInstancesFromLoadBalancer DeregisterInstancesFromLoadBalancer 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 (p. 43) to verify if the instance is deregistered from the load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). Instances.member.N A list of EC2 instance IDs consisting of all instances to be deregistered. Type: Instance (p. 79) list LoadBalancerName The name associated with the load balancer. Response Elements The following element is returned in a structure named DeregisterInstancesFromLoadBalancer- Result. Instances An updated list of remaining instances registered with the load balancer. Type: Instance (p. 79) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidEndPoint The specified EndPoint is not valid. 29

38 Deregister instance i-e3677ad7 from MyHTTPSLoadBalancer load balancer. Sample Request &LoadBalancerName=MyHTTPSLoadBalancer &Version= &Action=DeregisterInstancesFromLoadBalancer &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> 30

39 DescribeInstanceHealth DescribeInstanceHealth 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). Instances.member.N A list of instance IDs whose states are being queried. Type: Instance (p. 79) list LoadBalancerName The name of the load balancer. Response Elements The following element is returned in a structure named DescribeInstanceHealthResult. InstanceStates A list containing health information for the specified instances. Type: InstanceState (p. 80) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. InvalidEndPoint The specified EndPoint is not valid. 31

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

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

42 <DescribeInstanceHealthResult> <InstanceStates> <member> <>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> 34

43 DescribeLoadBalancerAttributes DescribeLoadBalancerAttributes Returns detailed information about all of the attributes associated with the specified load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The name of the load balancer. Response Elements The following element is returned in a structure named DescribeLoadBalancerAttributesResult. LoadBalancerAttributes The load balancer attributes structure. Type: LoadBalancerAttributes (p. 82) Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. LoadBalancerAttributeNotFound The specified load balancer attribute could not be found. Sample Request &Version= &Action=DescribeLoadBalancerAttributes &AUTHPARAMS 35

44 Sample Response <DescribeLoadBalancerAttributesResponse xmlns=" cing.amazonaws.com/doc/ /"> <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> 36

45 DescribeLoadBalancerPolicies DescribeLoadBalancerPolicies 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. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). LoadBalancerName The mnemonic name associated with the load balancer. If no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices. PolicyNames.member.N The names of load balancer policies you've created or Elastic Load Balancing sample policy names. list Response Elements The following element is returned in a structure named DescribeLoadBalancerPoliciesResult. Policys A list of policy description structures. Type: Policy (p. 88) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). AccessPointNotFound The specified load balancer could not be found. PolicyNotFound One or more specified policies were not found. 37

46 of all the policies associated with a load balancer Sample Request &Version= &Action=DescribeLoadBalancerPolicies &AUTHPARAMS Sample Response <DescribeLoadBalancerPoliciesResponse xmlns=" aws.com/doc/ /"> <DescribeLoadBalancerPoliciesResult> <Policys> <member> <PolicyName>MyDurationStickyPolicy</PolicyName> <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName> <PolicyAttributes> <member> <AttributeName>CookieExpirationPeriod</AttributeName> <AttributeValue>60</AttributeValue> </member> </PolicyAttributes> </member> <member> <PolicyName>MyAppStickyPolicy</PolicyName> <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName> <PolicyAttributes> <member> <AttributeName>CookieName</AttributeName> <AttributeValue>MyAppCookie</AttributeValue> </member> </PolicyAttributes> </member> </Policys> </DescribeLoadBalancerPoliciesResult> <ResponseMetadata> <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPoliciesResponse> of a specified policy associated with the load balancer Sample Request tocol 38

47 &LoadBalancerName=my-test-loadbalancer &Version= &Action=DescribeLoadBalancerPolicies &AUTHPARAMS Sample Response <DescribeLoadBalancerPoliciesResponse xmlns=" aws.com/doc/ /"> <DescribeLoadBalancerPoliciesResult> <Policys> <member> <PolicyName>EnableProxyProtocol</PolicyName> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <PolicyAttributes> <member> <AttributeName>ProxyProtocol</AttributeName> <AttributeValue>true</AttributeValue> </member> </PolicyAttributes> </member> </Policys> </DescribeLoadBalancerPoliciesResult> <ResponseMetadata> <RequestId> b-12b7-11e3-895e-1334aEXAMPLE</RequestId> </ResponseMetadata> </DescribeLoadBalancerPoliciesResponse> 39

48 DescribeLoadBalancerPolicyTypes DescribeLoadBalancerPolicyTypes 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 CreateLoadBalancer- Policy (p. 24) action to instantiate specific policy configurations that will be applied to a load balancer. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p. 93). PolicyTypeNames.member.N Specifies the name of the policy types. If no names are specified, returns the description of all the policy types defined by Elastic Load Balancing service. list Response Elements The following element is returned in a structure named DescribeLoadBalancerPolicyTypesResult. PolicyTypes List of policy type description structures of the specified policy type. If no policy type names are specified, returns the description of all the policy types defined by Elastic Load Balancing service. Type: PolicyType (p. 89) list Errors For information about the errors that are common to all actions, see Common Errors (p. 97). PolicyTypeNotFound One or more of the specified policy types do not exist. Partial description of all the policy types defined by Elastic Load Balancing for your account Sample Request &Action=DescribeLoadBalancerPolicyTypes &AUTHPARAMS 40

49 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 > of ProxyProtocolPolicyType Sample Request tocolpolicytype &Version= &Action=DescribeLoadBalancerPolicyTypes &AUTHPARAMS Sample Response <DescribeLoadBalancerPolicyTypesResponse xmlns=" cing.amazonaws.com/doc/ /"> <DescribeLoadBalancerPolicyTypesResult> <PolicyTypes> <member> <PolicyAttributeTypes> <member> <AttributeName>ProxyProtocol</AttributeName> <AttributeType>Boolean</AttributeType> <Cardinality>ONE</Cardinality> </member> </PolicyAttributeTypes> <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName> <>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</> </member> </PolicyTypes> </DescribeLoadBalancerPolicyTypesResult> 41