com.amazonaws.services.elasticloadbalancing.model

Class CreateLoadBalancerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateLoadBalancerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateLoadBalancer operation.

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 .

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
CreateLoadBalancerRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getAvailabilityZones() One or more Availability Zones from the same region as the load balancer.
List<Listener>	getListeners() The listeners.
String	getLoadBalancerName() The name of the load balancer.
String	getScheme() The type of a load balancer.
List<String>	getSecurityGroups() The IDs of the security groups to assign to the load balancer.
List<String>	getSubnets() The IDs of the subnets in your VPC to attach to the load balancer.
List<Tag>	getTags() A list of tags to assign to the load balancer.
int	hashCode()
void	setAvailabilityZones(Collection<String> availabilityZones) One or more Availability Zones from the same region as the load balancer.
void	setListeners(Collection<Listener> listeners) The listeners.
void	setLoadBalancerName(String loadBalancerName) The name of the load balancer.
void	setScheme(String scheme) The type of a load balancer.
void	setSecurityGroups(Collection<String> securityGroups) The IDs of the security groups to assign to the load balancer.
void	setSubnets(Collection<String> subnets) The IDs of the subnets in your VPC to attach to the 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) One or more Availability Zones from the same region as the load balancer.
CreateLoadBalancerRequest	withAvailabilityZones(String... availabilityZones) One or more Availability Zones from the same region as the load balancer.
CreateLoadBalancerRequest	withListeners(Collection<Listener> listeners) The listeners.
CreateLoadBalancerRequest	withListeners(Listener... listeners) The listeners.
CreateLoadBalancerRequest	withLoadBalancerName(String loadBalancerName) The name of the load balancer.
CreateLoadBalancerRequest	withScheme(String scheme) The type of a load balancer.
CreateLoadBalancerRequest	withSecurityGroups(Collection<String> securityGroups) The IDs of the security groups to assign to the load balancer.
CreateLoadBalancerRequest	withSecurityGroups(String... securityGroups) The IDs of the security groups to assign to the load balancer.
CreateLoadBalancerRequest	withSubnets(Collection<String> subnets) The IDs of the subnets in your VPC to attach to the load balancer.
CreateLoadBalancerRequest	withSubnets(String... subnets) The IDs of the subnets in your VPC to attach to the 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

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

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

listeners - The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

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

Method Detail

getLoadBalancerName

public String getLoadBalancerName()

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.

Returns:

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.

setLoadBalancerName

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

Parameters:

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.

withLoadBalancerName

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

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

Parameters:

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.

Returns:

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

getListeners

public List<Listener> getListeners()

The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

Returns:

The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

setListeners

public void setListeners(Collection<Listener> listeners)

The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

Parameters:

listeners - The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

withListeners

public CreateLoadBalancerRequest withListeners(Listener... listeners)

The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

NOTE: This method appends the values to the existing list (if any). Use setListeners(java.util.Collection) or withListeners(java.util.Collection) if you want to override the existing values.

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

Parameters:

listeners - The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

Returns:

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

withListeners

public CreateLoadBalancerRequest withListeners(Collection<Listener> listeners)

The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

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

Parameters:

listeners - The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

Returns:

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

getAvailabilityZones

public List<String> getAvailabilityZones()

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.

Returns:

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.

setAvailabilityZones

public void setAvailabilityZones(Collection<String> availabilityZones)

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.

Parameters:

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

withAvailabilityZones

public CreateLoadBalancerRequest withAvailabilityZones(String... availabilityZones)

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.

NOTE: This method appends the values to the existing list (if any). Use setAvailabilityZones(java.util.Collection) or withAvailabilityZones(java.util.Collection) if you want to override the existing values.

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

Parameters:

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

Returns:

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

withAvailabilityZones

public CreateLoadBalancerRequest withAvailabilityZones(Collection<String> availabilityZones)

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.

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

Parameters:

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

Returns:

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

getSubnets

public List<String> getSubnets()

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

Returns:

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

setSubnets

public void setSubnets(Collection<String> subnets)

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

Parameters:

subnets - The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

withSubnets

public CreateLoadBalancerRequest withSubnets(String... subnets)

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

NOTE: This method appends the values to the existing list (if any). Use setSubnets(java.util.Collection) or withSubnets(java.util.Collection) if you want to override the existing values.

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

Parameters:

subnets - The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

Returns:

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

withSubnets

public CreateLoadBalancerRequest withSubnets(Collection<String> subnets)

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

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

Parameters:

subnets - The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

Returns:

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

getSecurityGroups

public List<String> getSecurityGroups()

The IDs of the security groups to assign to the load balancer.

Returns:

The IDs of the security groups to assign to the load balancer.

setSecurityGroups

public void setSecurityGroups(Collection<String> securityGroups)

The IDs of the security groups to assign to the load balancer.

Parameters:

securityGroups - The IDs of the security groups to assign to the load balancer.

withSecurityGroups

public CreateLoadBalancerRequest withSecurityGroups(String... securityGroups)

The IDs of the security groups to assign to the load balancer.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.

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

Parameters:

securityGroups - The IDs of the security groups to assign to the load balancer.

Returns:

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

withSecurityGroups

public CreateLoadBalancerRequest withSecurityGroups(Collection<String> securityGroups)

The IDs of the security groups to assign to the load balancer.

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

Parameters:

securityGroups - The IDs of the security groups to assign to the load balancer.

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

Returns:

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.

setScheme

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

Parameters:

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.

withScheme

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

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

Parameters:

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.

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 tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.

Constraints:
Length: 1 -

Returns:

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.

setTags

public void setTags(Collection<Tag> tags)

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.

Constraints:
Length: 1 -

Parameters:

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

withTags

public CreateLoadBalancerRequest withTags(Tag... tags)

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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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 tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.

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 tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.

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 tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.

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

clone

public CreateLoadBalancerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()