CreateLoadBalancer

Amazon Elastic Load Balancing: 2009-05-15

previous page next page

CreateLoadBalancer

Description

This API creates a new LoadBalancer.

[Note]Note

Currently, your quota of LoadBalancers is limited to five per region.

Once the call has completed successfully, a new LoadBalancer will be created, but it will not be usable until at least one instance has been registered.

When the LoadBalancer creation is completed, you can check whether it is usable by using the

DescribeInstanceHealth API. The LoadBalancer is usable as soon as any registered instance is InService.
[Note]Note

Load balancer DNS names will vary depend on the region in which they were created. For load balancers created in the United States, the DNS name will end with:

  • us-east-1.elb.amazonaws.com

For load balancers created in Europe, the DNS name will end with:

  • eu-west-1.elb.amazonaws.com

Request Parameters

Name Description Required

AvailabilityZones

List of Availability Zones. This list can be modified after the creation of the LoadBalancer. The Availability Zones specified must be in the same EC2 region as the LoadBalancer. You must specify at least one Availability Zone. Traffic will be equally distributed across all zones.

Type: AvailabilityZones

Default: None

[Note]Note

Some API operations take lists of parameters. These lists are specified using the following notation: param.member.n. Values of n are integers starting from 1. All lists of parameters must follow this notation, including lists that only contain one parameter. For example, a Query parameter list looks like this:

&attribute.member.1=this
&attribute.member.2=that

Yes

LoadBalancerName

The mnemonic name associated with the LoadBalancer. The name must be unique within your set of LoadBalancers requests on the specified protocol and received by Elastic Load Balancing on the LoadBalancerPort are load balanced across the registered instances and sent to port InstancePort.

Type: String

Default: None

Constraints: Must only use alphanumeric characters (case sensitive) and dash (-). Dash cannot be first or last character. Maximum length of name is 32 characters (characters are 16-bit Unicode).

Yes

Listeners

This parameter is used to denote a list of the following tuples LoadBalancerPort, InstancePort, and Protocol.

Type: Listeners

[Note]Note

Some API operations take lists of parameters. These lists are specified using the following notation: param.member.n. Values of n are integers starting from 1. All lists of parameters must follow this notation, including lists that only contain one parameter. For example, a Query parameter list looks like this:

&attribute.member.1=this
&attribute.member.2=that

Yes

Response Elements

Name Description

DNSName

DNS name for the LoadBalancer.

Type: String

Availability: Always returned

Special Errors

Common errors for all calls are listed and described in a separate section, please see API Error Codes.

Error Description HTTP Status Code SOAP Prefix

DuplicateLoadBalancerName

The LoadBalancer name requested already exists in this AWS account.

This error is returned if you try creating a LoadBalancer with the same name as a current LoadBalancer that you have, but with a different set of parameters. If you try creating a LoadBalancer with the same name and parameters of a LoadBalancer you already have, then the system will simply return the same output as it did when you created the LoadBalancer the first time. In other words, in such a case, you won't get an error, but you simply will get the same information back (but still only one LoadBalancer of that name and with that set of parameters.)

 400 Bad Request Client

TooManyLoadBalancers

Quota of LoadBalancers has already been reached.

400 Bad Request Client

ValidationError

One or more input parameters are invalid.

400 Bad Request Client

Examples

Sample Request

Example Request (Query) 

https://elasticloadbalancing.amazonaws.com /?SignatureVersion=2
&Action=CreateLoadBalancer
&Version=2009-05-15
&LoadBalancerName=TestLoadBalancer
&Listeners.member.1.Protocol=HTTP
&Listeners.member.1.LoadBalancerPort=80
&Listeners.member.1.InstancePort=80
&AvailabilityZones.member.1=us-east-1b
&Timestamp=2009-04-03T18%3A20%3A54.000Z
&AWSAccessKeyId=XXX YOUR ACCESS KEY XXX
&Signature=%XXX YOUR SIGNATURE XXX%3D

Sample Response

Example Query Response 

<CreateLoadBalancerResult>
<DNSName> TestLoadBalancer-380544827.us-east-1.elb.amazonaws.com</DNSName>
</CreateLoadBalancerResult>

previous page start next page