com.amazonaws.services.elasticloadbalancing.model
Class CreateLoadBalancerRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest

public class CreateLoadBalancerRequest
extends AmazonWebServiceRequest

Container for the parameters to the CreateLoadBalancer operation.

Creates a new LoadBalancer.

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

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

NOTE: Load balancer DNS names vary depending on the Region they're created in. For load balancers created in the United States, the DNS name ends with: us-east-1.elb.amazonaws.com (for the US Standard Region) us-west-1.elb.amazonaws.com (for the Northern California Region) For load balancers created in the EU (Ireland) Region, the DNS name ends with: eu-west-1.elb.amazonaws.com

See Also:
AmazonElasticLoadBalancing.createLoadBalancer(CreateLoadBalancerRequest)

Constructor Summary
CreateLoadBalancerRequest()
          Default constructor for a new CreateLoadBalancerRequest object.
CreateLoadBalancerRequest(String loadBalancerName)
          Constructs a new CreateLoadBalancerRequest object.
CreateLoadBalancerRequest(String loadBalancerName, List<Listener> listeners, List<String> availabilityZones)
          Constructs a new CreateLoadBalancerRequest object.
 
Method Summary
 List<String> getAvailabilityZones()
          A list of Availability Zones.
 List<Listener> getListeners()
          A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
 String getLoadBalancerName()
          The name associated with the LoadBalancer.
 void setAvailabilityZones(Collection<String> availabilityZones)
          A list of Availability Zones.
 void setListeners(Collection<Listener> listeners)
          A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
 void setLoadBalancerName(String loadBalancerName)
          The name associated with the LoadBalancer.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 CreateLoadBalancerRequest withAvailabilityZones(Collection<String> availabilityZones)
          A list of Availability Zones.
 CreateLoadBalancerRequest withAvailabilityZones(String... availabilityZones)
          A list of Availability Zones.
 CreateLoadBalancerRequest withListeners(Collection<Listener> listeners)
          A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
 CreateLoadBalancerRequest withListeners(Listener... listeners)
          A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
 CreateLoadBalancerRequest withLoadBalancerName(String loadBalancerName)
          The name associated with the LoadBalancer.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CreateLoadBalancerRequest

public CreateLoadBalancerRequest()
Default constructor for a new CreateLoadBalancerRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.


CreateLoadBalancerRequest

public CreateLoadBalancerRequest(String loadBalancerName)
Constructs a new CreateLoadBalancerRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
loadBalancerName - The 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.

CreateLoadBalancerRequest

public CreateLoadBalancerRequest(String loadBalancerName,
                                 List<Listener> listeners,
                                 List<String> availabilityZones)
Constructs a new CreateLoadBalancerRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:
loadBalancerName - The 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.
listeners - A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
availabilityZones - A list of Availability Zones.

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

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

Method Detail

getLoadBalancerName

public String getLoadBalancerName()
The 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.

Returns:
The 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.

setLoadBalancerName

public void setLoadBalancerName(String loadBalancerName)
The 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.

Parameters:
loadBalancerName - The 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.

withLoadBalancerName

public CreateLoadBalancerRequest withLoadBalancerName(String loadBalancerName)
The 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
loadBalancerName - The 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.
Returns:
A reference to this updated object so that method calls can be chained together.

getListeners

public List<Listener> getListeners()
A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.

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

setListeners

public void setListeners(Collection<Listener> listeners)
A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.

Parameters:
listeners - A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.

withListeners

public CreateLoadBalancerRequest withListeners(Listener... listeners)
A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.

Returns a reference to this object so that method calls can be chained together.

Parameters:
listeners - A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
Returns:
A reference to this updated object so that method calls can be chained together.

withListeners

public CreateLoadBalancerRequest withListeners(Collection<Listener> listeners)
A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.

Returns a reference to this object so that method calls can be chained together.

Parameters:
listeners - A list of the following tuples: LoadBalancerPort, InstancePort, and Protocol.
Returns:
A reference to this updated object so that method calls can be chained together.

getAvailabilityZones

public List<String> getAvailabilityZones()
A list of Availability Zones.

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

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

Returns:
A list of Availability Zones.

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

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


setAvailabilityZones

public void setAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones.

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

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

Parameters:
availabilityZones - A list of Availability Zones.

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

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


withAvailabilityZones

public CreateLoadBalancerRequest withAvailabilityZones(String... availabilityZones)
A list of Availability Zones.

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:
availabilityZones - A list of Availability Zones.

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

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

Returns:
A reference to this updated object so that method calls can be chained together.

withAvailabilityZones

public CreateLoadBalancerRequest withAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones.

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:
availabilityZones - A list of Availability Zones.

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

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

Returns:
A reference to this updated object so that method calls can be chained together.

toString

public String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class Object
Returns:
A string representation of this object.
See Also:
Object.toString()


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.