com.amazonaws.services.elasticloadbalancing.model

Class CreateLoadBalancerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest

All Implemented Interfaces:

Serializable

public class CreateLoadBalancerRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateLoadBalancer operation.

Creates a new load balancer.

After the call has completed successfully, a new load balancer is created with a unique Domain Name Service (DNS) name. The DNS name includes the name of the AWS region in which the load balance was created. For example, if your load balancer was created in the United States, the DNS name might end with either of the following:

• 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 .

See Also:

AmazonElasticLoadBalancing.createLoadBalancer(CreateLoadBalancerRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getAvailabilityZones() A list of Availability Zones.
List<Listener>	getListeners() A list of the following tuples: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.
String	getLoadBalancerName() The name associated with the load balancer.
String	getScheme() The type of a load balancer.
List<String>	getSecurityGroups() The security groups to assign to your load balancer within your VPC.
List<String>	getSubnets() A list of subnet IDs in your VPC to attach to your load balancer.
List<Tag>	getTags() A list of tags to assign to the load balancer.
int	hashCode()
void	setAvailabilityZones(Collection<String> availabilityZones) A list of Availability Zones.
void	setListeners(Collection<Listener> listeners) A list of the following tuples: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.
void	setLoadBalancerName(String loadBalancerName) The name associated with the load balancer.
void	setScheme(String scheme) The type of a load balancer.
void	setSecurityGroups(Collection<String> securityGroups) The security groups to assign to your load balancer within your VPC.
void	setSubnets(Collection<String> subnets) A list of subnet IDs in your VPC to attach to your load balancer.
void	setTags(Collection<Tag> tags) A list of tags to assign to the load balancer.
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: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.
CreateLoadBalancerRequest	withListeners(Listener... listeners) A list of the following tuples: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.
CreateLoadBalancerRequest	withLoadBalancerName(String loadBalancerName) The name associated with the load balancer.
CreateLoadBalancerRequest	withScheme(String scheme) The type of a load balancer.
CreateLoadBalancerRequest	withSecurityGroups(Collection<String> securityGroups) The security groups to assign to your load balancer within your VPC.
CreateLoadBalancerRequest	withSecurityGroups(String... securityGroups) The security groups to assign to your load balancer within your VPC.
CreateLoadBalancerRequest	withSubnets(Collection<String> subnets) A list of subnet IDs in your VPC to attach to your load balancer.
CreateLoadBalancerRequest	withSubnets(String... subnets) A list of subnet IDs in your VPC to attach to your load balancer.
CreateLoadBalancerRequest	withTags(Collection<Tag> tags) A list of tags to assign to the load balancer.
CreateLoadBalancerRequest	withTags(Tag... tags) A list of tags to assign to the load balancer.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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 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.

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 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.

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

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 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 action.

Method Detail

getLoadBalancerName

public String getLoadBalancerName()

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.

Returns:

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.

setLoadBalancerName

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

Parameters:

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.

withLoadBalancerName

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

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

Parameters:

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.

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: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.

Returns:

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

setListeners

public void setListeners(Collection<Listener> listeners)

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

Parameters:

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

withListeners

public CreateLoadBalancerRequest withListeners(Listener... listeners)

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

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

Parameters:

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

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: Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.

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

Parameters:

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

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 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 action.

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 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 action.

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 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 action.

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 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 action.

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 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 action.

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 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 action.

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 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 action.

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 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 action.

Returns:

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

getSubnets

public List<String> getSubnets()

A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

Returns:

A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

setSubnets

public void setSubnets(Collection<String> subnets)

A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

Parameters:

subnets - A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

withSubnets

public CreateLoadBalancerRequest withSubnets(String... subnets)

A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

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

Parameters:

subnets - A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

Returns:

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

withSubnets

public CreateLoadBalancerRequest withSubnets(Collection<String> subnets)

A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

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

Parameters:

subnets - A list of subnet IDs in your VPC to attach to your load balancer. Specify one subnet per Availability Zone.

Returns:

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

getSecurityGroups

public List<String> getSecurityGroups()

The security groups to assign to your load balancer within your VPC.

Returns:

The security groups to assign to your load balancer within your VPC.

setSecurityGroups

public void setSecurityGroups(Collection<String> securityGroups)

The security groups to assign to your load balancer within your VPC.

Parameters:

securityGroups - The security groups to assign to your load balancer within your VPC.

withSecurityGroups

public CreateLoadBalancerRequest withSecurityGroups(String... securityGroups)

The security groups to assign to your load balancer within your VPC.

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

Parameters:

securityGroups - The security groups to assign to your load balancer within your VPC.

Returns:

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

withSecurityGroups

public CreateLoadBalancerRequest withSecurityGroups(Collection<String> securityGroups)

The security groups to assign to your load balancer within your VPC.

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

Parameters:

securityGroups - The security groups to assign to your load balancer within your VPC.

Returns:

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

getScheme

public String getScheme()

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.

This option is only available for load balancers created within EC2-VPC.

Returns:

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.

This option is only available for load balancers created within EC2-VPC.

setScheme

public void setScheme(String 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.

This option is only available for load balancers created within EC2-VPC.

Parameters:

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.

This option is only available for load balancers created within EC2-VPC.

withScheme

public CreateLoadBalancerRequest withScheme(String 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.

This option is only available for load balancers created within EC2-VPC.

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

Parameters:

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.

This option is only available for load balancers created within EC2-VPC.

Returns:

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

getTags

public List<Tag> getTags()

A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

Constraints:
Length: 1 -

Returns:

A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

setTags

public void setTags(Collection<Tag> tags)

A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

Constraints:
Length: 1 -

Parameters:

tags - A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

withTags

public CreateLoadBalancerRequest withTags(Tag... tags)

A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

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

Constraints:
Length: 1 -

Parameters:

tags - A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

Returns:

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

withTags

public CreateLoadBalancerRequest withTags(Collection<Tag> tags)

A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

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

Constraints:
Length: 1 -

Parameters:

tags - A list of tags to assign to the load balancer.

For more information about setting tags for your load balancer, see Tagging.

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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object