com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.elasticloadbalancing.model;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing#createLoadBalancer(CreateLoadBalancerRequest) 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 com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing#createLoadBalancer(CreateLoadBalancerRequest)
*/
public class CreateLoadBalancerRequest extends AmazonWebServiceRequest {
/**
* 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.
*/
private String loadBalancerName;
/**
* A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*/
private java.util.List listeners;
/**
* 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.
*/
private java.util.List availabilityZones;
/**
* Default constructor for a new CreateLoadBalancerRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public CreateLoadBalancerRequest() {}
/**
* Constructs a new CreateLoadBalancerRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param 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.
*/
public CreateLoadBalancerRequest(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
}
/**
* Constructs a new CreateLoadBalancerRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param 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.
* @param listeners A list of the following tuples: LoadBalancerPort,
* InstancePort, and Protocol.
* @param 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.
*/
public CreateLoadBalancerRequest(String loadBalancerName, java.util.List listeners, java.util.List availabilityZones) {
this.loadBalancerName = loadBalancerName;
this.listeners = listeners;
this.availabilityZones = availabilityZones;
}
/**
* 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.
*
* @return 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.
*/
public String getLoadBalancerName() {
return 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.
*
* @param 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.
*/
public void setLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateLoadBalancerRequest withLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
return this;
}
/**
* A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*
* @return A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*/
public java.util.List getListeners() {
if (listeners == null) {
listeners = new java.util.ArrayList();
}
return listeners;
}
/**
* A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*
* @param listeners A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*/
public void setListeners(java.util.Collection listeners) {
java.util.List listenersCopy = new java.util.ArrayList();
if (listeners != null) {
listenersCopy.addAll(listeners);
}
this.listeners = listenersCopy;
}
/**
* A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param listeners A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateLoadBalancerRequest withListeners(Listener... listeners) {
for (Listener value : listeners) {
getListeners().add(value);
}
return this;
}
/**
* A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param listeners A list of the following tuples: LoadBalancerPort, InstancePort, and
* Protocol.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateLoadBalancerRequest withListeners(java.util.Collection listeners) {
java.util.List listenersCopy = new java.util.ArrayList();
if (listeners != null) {
listenersCopy.addAll(listeners);
}
this.listeners = listenersCopy;
return this;
}
/**
* 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.
*
* @return 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.
*/
public java.util.List getAvailabilityZones() {
if (availabilityZones == null) {
availabilityZones = new java.util.ArrayList();
}
return 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.
*
* @param 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.
*/
public void setAvailabilityZones(java.util.Collection availabilityZones) {
java.util.List availabilityZonesCopy = new java.util.ArrayList();
if (availabilityZones != null) {
availabilityZonesCopy.addAll(availabilityZones);
}
this.availabilityZones = availabilityZonesCopy;
}
/**
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateLoadBalancerRequest withAvailabilityZones(String... availabilityZones) {
for (String value : availabilityZones) {
getAvailabilityZones().add(value);
}
return this;
}
/**
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateLoadBalancerRequest withAvailabilityZones(java.util.Collection availabilityZones) {
java.util.List availabilityZonesCopy = new java.util.ArrayList();
if (availabilityZones != null) {
availabilityZonesCopy.addAll(availabilityZones);
}
this.availabilityZones = availabilityZonesCopy;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append("LoadBalancerName: " + loadBalancerName + ", ");
sb.append("Listeners: " + listeners + ", ");
sb.append("AvailabilityZones: " + availabilityZones + ", ");
sb.append("}");
return sb.toString();
}
}