public class CreateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
CreateAutoScalingGroup operation
.
Creates a new Auto Scaling group with the specified name and other attributes. When the creation request is completed, the Auto Scaling group is ready to be used in other calls.
NOTE: The Auto Scaling group name must be unique within the scope of your AWS account.
Constructor and Description |
---|
CreateAutoScalingGroupRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getAutoScalingGroupName()
The name of the Auto Scaling group.
|
List<String> |
getAvailabilityZones()
A list of Availability Zones for the Auto Scaling group.
|
Integer |
getDefaultCooldown()
The amount of time, in seconds, between a successful scaling activity
and the succeeding scaling activity.
|
Integer |
getDesiredCapacity()
The number of Amazon EC2 instances that should be running in the
group.
|
Integer |
getHealthCheckGracePeriod()
Length of time in seconds after a new Amazon EC2 instance comes into
service that Auto Scaling starts checking its health.
|
String |
getHealthCheckType()
The service you want the health checks from, Amazon EC2 or Elastic
Load Balancer.
|
String |
getLaunchConfigurationName()
The name of an existing launch configuration to use to launch new
instances.
|
List<String> |
getLoadBalancerNames()
A list of existing Elastic Load Balancing load balancers to use.
|
Integer |
getMaxSize()
The maximum size of the Auto Scaling group.
|
Integer |
getMinSize()
The minimum size of the Auto Scaling group.
|
String |
getPlacementGroup()
Physical location of an existing cluster placement group into which
you want to launch your instances.
|
List<Tag> |
getTags()
The tag to be created or updated.
|
List<String> |
getTerminationPolicies()
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
String |
getVPCZoneIdentifier()
A comma-separated list of subnet identifiers of Amazon Virtual Private
Clouds (Amazon VPCs).
|
int |
hashCode() |
void |
setAutoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones for the Auto Scaling group.
|
void |
setDefaultCooldown(Integer defaultCooldown)
The amount of time, in seconds, between a successful scaling activity
and the succeeding scaling activity.
|
void |
setDesiredCapacity(Integer desiredCapacity)
The number of Amazon EC2 instances that should be running in the
group.
|
void |
setHealthCheckGracePeriod(Integer healthCheckGracePeriod)
Length of time in seconds after a new Amazon EC2 instance comes into
service that Auto Scaling starts checking its health.
|
void |
setHealthCheckType(String healthCheckType)
The service you want the health checks from, Amazon EC2 or Elastic
Load Balancer.
|
void |
setLaunchConfigurationName(String launchConfigurationName)
The name of an existing launch configuration to use to launch new
instances.
|
void |
setLoadBalancerNames(Collection<String> loadBalancerNames)
A list of existing Elastic Load Balancing load balancers to use.
|
void |
setMaxSize(Integer maxSize)
The maximum size of the Auto Scaling group.
|
void |
setMinSize(Integer minSize)
The minimum size of the Auto Scaling group.
|
void |
setPlacementGroup(String placementGroup)
Physical location of an existing cluster placement group into which
you want to launch your instances.
|
void |
setTags(Collection<Tag> tags)
The tag to be created or updated.
|
void |
setTerminationPolicies(Collection<String> terminationPolicies)
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
void |
setVPCZoneIdentifier(String vPCZoneIdentifier)
A comma-separated list of subnet identifiers of Amazon Virtual Private
Clouds (Amazon VPCs).
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateAutoScalingGroupRequest |
withAutoScalingGroupName(String autoScalingGroupName)
The name of the Auto Scaling group.
|
CreateAutoScalingGroupRequest |
withAvailabilityZones(Collection<String> availabilityZones)
A list of Availability Zones for the Auto Scaling group.
|
CreateAutoScalingGroupRequest |
withAvailabilityZones(String... availabilityZones)
A list of Availability Zones for the Auto Scaling group.
|
CreateAutoScalingGroupRequest |
withDefaultCooldown(Integer defaultCooldown)
The amount of time, in seconds, between a successful scaling activity
and the succeeding scaling activity.
|
CreateAutoScalingGroupRequest |
withDesiredCapacity(Integer desiredCapacity)
The number of Amazon EC2 instances that should be running in the
group.
|
CreateAutoScalingGroupRequest |
withHealthCheckGracePeriod(Integer healthCheckGracePeriod)
Length of time in seconds after a new Amazon EC2 instance comes into
service that Auto Scaling starts checking its health.
|
CreateAutoScalingGroupRequest |
withHealthCheckType(String healthCheckType)
The service you want the health checks from, Amazon EC2 or Elastic
Load Balancer.
|
CreateAutoScalingGroupRequest |
withLaunchConfigurationName(String launchConfigurationName)
The name of an existing launch configuration to use to launch new
instances.
|
CreateAutoScalingGroupRequest |
withLoadBalancerNames(Collection<String> loadBalancerNames)
A list of existing Elastic Load Balancing load balancers to use.
|
CreateAutoScalingGroupRequest |
withLoadBalancerNames(String... loadBalancerNames)
A list of existing Elastic Load Balancing load balancers to use.
|
CreateAutoScalingGroupRequest |
withMaxSize(Integer maxSize)
The maximum size of the Auto Scaling group.
|
CreateAutoScalingGroupRequest |
withMinSize(Integer minSize)
The minimum size of the Auto Scaling group.
|
CreateAutoScalingGroupRequest |
withPlacementGroup(String placementGroup)
Physical location of an existing cluster placement group into which
you want to launch your instances.
|
CreateAutoScalingGroupRequest |
withTags(Collection<Tag> tags)
The tag to be created or updated.
|
CreateAutoScalingGroupRequest |
withTags(Tag... tags)
The tag to be created or updated.
|
CreateAutoScalingGroupRequest |
withTerminationPolicies(Collection<String> terminationPolicies)
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
CreateAutoScalingGroupRequest |
withTerminationPolicies(String... terminationPolicies)
A standalone termination policy or a list of termination policies used
to select the instance to terminate.
|
CreateAutoScalingGroupRequest |
withVPCZoneIdentifier(String vPCZoneIdentifier)
A comma-separated list of subnet identifiers of Amazon Virtual Private
Clouds (Amazon VPCs).
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
public String getAutoScalingGroupName()
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
public void setAutoScalingGroupName(String autoScalingGroupName)
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name of the Auto Scaling group.public CreateAutoScalingGroupRequest withAutoScalingGroupName(String autoScalingGroupName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
autoScalingGroupName
- The name of the Auto Scaling group.public String getLaunchConfigurationName()
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
public void setLaunchConfigurationName(String launchConfigurationName)
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
launchConfigurationName
- The name of an existing launch configuration to use to launch new
instances.public CreateAutoScalingGroupRequest withLaunchConfigurationName(String launchConfigurationName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1600
Pattern: [ --�𐀀-\r\n\t]*
launchConfigurationName
- The name of an existing launch configuration to use to launch new
instances.public Integer getMinSize()
public void setMinSize(Integer minSize)
minSize
- The minimum size of the Auto Scaling group.public CreateAutoScalingGroupRequest withMinSize(Integer minSize)
Returns a reference to this object so that method calls can be chained together.
minSize
- The minimum size of the Auto Scaling group.public Integer getMaxSize()
public void setMaxSize(Integer maxSize)
maxSize
- The maximum size of the Auto Scaling group.public CreateAutoScalingGroupRequest withMaxSize(Integer maxSize)
Returns a reference to this object so that method calls can be chained together.
maxSize
- The maximum size of the Auto Scaling group.public Integer getDesiredCapacity()
public void setDesiredCapacity(Integer desiredCapacity)
desiredCapacity
- The number of Amazon EC2 instances that should be running in the
group. The desired capacity must be greater than or equal to the
minimum size and less than or equal to the maximum size specified for
the Auto Scaling group.public CreateAutoScalingGroupRequest withDesiredCapacity(Integer desiredCapacity)
Returns a reference to this object so that method calls can be chained together.
desiredCapacity
- The number of Amazon EC2 instances that should be running in the
group. The desired capacity must be greater than or equal to the
minimum size and less than or equal to the maximum size specified for
the Auto Scaling group.public Integer getDefaultCooldown()
If a
DefaultCooldown
period is not specified, Auto Scaling
uses the default value of 300 as the default cool down period for the
Auto Scaling group. For more information, see Cooldown
Period
If a
DefaultCooldown
period is not specified, Auto Scaling
uses the default value of 300 as the default cool down period for the
Auto Scaling group. For more information, see Cooldown
Period
public void setDefaultCooldown(Integer defaultCooldown)
If a
DefaultCooldown
period is not specified, Auto Scaling
uses the default value of 300 as the default cool down period for the
Auto Scaling group. For more information, see Cooldown
Period
defaultCooldown
- The amount of time, in seconds, between a successful scaling activity
and the succeeding scaling activity. If a
DefaultCooldown
period is not specified, Auto Scaling
uses the default value of 300 as the default cool down period for the
Auto Scaling group. For more information, see Cooldown
Period
public CreateAutoScalingGroupRequest withDefaultCooldown(Integer defaultCooldown)
If a
DefaultCooldown
period is not specified, Auto Scaling
uses the default value of 300 as the default cool down period for the
Auto Scaling group. For more information, see Cooldown
Period
Returns a reference to this object so that method calls can be chained together.
defaultCooldown
- The amount of time, in seconds, between a successful scaling activity
and the succeeding scaling activity. If a
DefaultCooldown
period is not specified, Auto Scaling
uses the default value of 300 as the default cool down period for the
Auto Scaling group. For more information, see Cooldown
Period
public List<String> getAvailabilityZones()
Constraints:
Length: 1 -
public void setAvailabilityZones(Collection<String> availabilityZones)
Constraints:
Length: 1 -
availabilityZones
- A list of Availability Zones for the Auto Scaling group. This is
required unless you have specified subnets.public CreateAutoScalingGroupRequest withAvailabilityZones(String... availabilityZones)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
availabilityZones
- A list of Availability Zones for the Auto Scaling group. This is
required unless you have specified subnets.public CreateAutoScalingGroupRequest withAvailabilityZones(Collection<String> availabilityZones)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
availabilityZones
- A list of Availability Zones for the Auto Scaling group. This is
required unless you have specified subnets.public List<String> getLoadBalancerNames()
For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group.
For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group.
public void setLoadBalancerNames(Collection<String> loadBalancerNames)
For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group.
loadBalancerNames
- A list of existing Elastic Load Balancing load balancers to use. The
load balancers must be associated with the AWS account. For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group.
public CreateAutoScalingGroupRequest withLoadBalancerNames(String... loadBalancerNames)
For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group.
Returns a reference to this object so that method calls can be chained together.
loadBalancerNames
- A list of existing Elastic Load Balancing load balancers to use. The
load balancers must be associated with the AWS account. For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group.
public CreateAutoScalingGroupRequest withLoadBalancerNames(Collection<String> loadBalancerNames)
For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group.
Returns a reference to this object so that method calls can be chained together.
loadBalancerNames
- A list of existing Elastic Load Balancing load balancers to use. The
load balancers must be associated with the AWS account. For information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group.
public String getHealthCheckType()
EC2
or ELB
.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
EC2
or ELB
.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
public void setHealthCheckType(String healthCheckType)
EC2
or ELB
.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
healthCheckType
- The service you want the health checks from, Amazon EC2 or Elastic
Load Balancer. Valid values are EC2
or ELB
.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
public CreateAutoScalingGroupRequest withHealthCheckType(String healthCheckType)
EC2
or ELB
.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 32
Pattern: [ --�𐀀-\r\n\t]*
healthCheckType
- The service you want the health checks from, Amazon EC2 or Elastic
Load Balancer. Valid values are EC2
or ELB
.
By default, the Auto Scaling health check uses the results of Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Check.
public Integer getHealthCheckGracePeriod()
This is
required if you are adding ELB
health check. Frequently,
new instances need to warm up, briefly, before they can pass a health
check. To provide ample warm-up time, set the health check grace
period of the group to match the expected startup period of your
application.
This is
required if you are adding ELB
health check. Frequently,
new instances need to warm up, briefly, before they can pass a health
check. To provide ample warm-up time, set the health check grace
period of the group to match the expected startup period of your
application.
public void setHealthCheckGracePeriod(Integer healthCheckGracePeriod)
This is
required if you are adding ELB
health check. Frequently,
new instances need to warm up, briefly, before they can pass a health
check. To provide ample warm-up time, set the health check grace
period of the group to match the expected startup period of your
application.
healthCheckGracePeriod
- Length of time in seconds after a new Amazon EC2 instance comes into
service that Auto Scaling starts checking its health. During this time
any health check failure for the that instance is ignored. This is
required if you are adding ELB
health check. Frequently,
new instances need to warm up, briefly, before they can pass a health
check. To provide ample warm-up time, set the health check grace
period of the group to match the expected startup period of your
application.
public CreateAutoScalingGroupRequest withHealthCheckGracePeriod(Integer healthCheckGracePeriod)
This is
required if you are adding ELB
health check. Frequently,
new instances need to warm up, briefly, before they can pass a health
check. To provide ample warm-up time, set the health check grace
period of the group to match the expected startup period of your
application.
Returns a reference to this object so that method calls can be chained together.
healthCheckGracePeriod
- Length of time in seconds after a new Amazon EC2 instance comes into
service that Auto Scaling starts checking its health. During this time
any health check failure for the that instance is ignored. This is
required if you are adding ELB
health check. Frequently,
new instances need to warm up, briefly, before they can pass a health
check. To provide ample warm-up time, set the health check grace
period of the group to match the expected startup period of your
application.
public String getPlacementGroup()
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
public void setPlacementGroup(String placementGroup)
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
placementGroup
- Physical location of an existing cluster placement group into which
you want to launch your instances. For information about cluster
placement group, see Using
Cluster Instancespublic CreateAutoScalingGroupRequest withPlacementGroup(String placementGroup)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
placementGroup
- Physical location of an existing cluster placement group into which
you want to launch your instances. For information about cluster
placement group, see Using
Cluster Instancespublic String getVPCZoneIdentifier()
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Launch Auto Scaling Instances into Amazon VPC.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Launch Auto Scaling Instances into Amazon VPC.
public void setVPCZoneIdentifier(String vPCZoneIdentifier)
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Launch Auto Scaling Instances into Amazon VPC.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
vPCZoneIdentifier
- A comma-separated list of subnet identifiers of Amazon Virtual Private
Clouds (Amazon VPCs). If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Launch Auto Scaling Instances into Amazon VPC.
public CreateAutoScalingGroupRequest withVPCZoneIdentifier(String vPCZoneIdentifier)
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Launch Auto Scaling Instances into Amazon VPC.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [ --�𐀀-\r\n\t]*
vPCZoneIdentifier
- A comma-separated list of subnet identifiers of Amazon Virtual Private
Clouds (Amazon VPCs). If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For information on launching your Auto Scaling group into Amazon VPC subnets, see Launch Auto Scaling Instances into Amazon VPC.
public List<String> getTerminationPolicies()
For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
public void setTerminationPolicies(Collection<String> terminationPolicies)
For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
terminationPolicies
- A standalone termination policy or a list of termination policies used
to select the instance to terminate. The policies are executed in the
order that they are listed. For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
public CreateAutoScalingGroupRequest withTerminationPolicies(String... terminationPolicies)
For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
Returns a reference to this object so that method calls can be chained together.
terminationPolicies
- A standalone termination policy or a list of termination policies used
to select the instance to terminate. The policies are executed in the
order that they are listed. For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
public CreateAutoScalingGroupRequest withTerminationPolicies(Collection<String> terminationPolicies)
For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
Returns a reference to this object so that method calls can be chained together.
terminationPolicies
- A standalone termination policy or a list of termination policies used
to select the instance to terminate. The policies are executed in the
order that they are listed. For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the the Auto Scaling Developer Guide.
public List<Tag> getTags()
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
public void setTags(Collection<Tag> tags)
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
tags
- The tag to be created or updated. Each tag should be defined by its
resource type, resource ID, key, value, and a propagate flag. Valid
values: key=value, value=value, propagate=true or
false. Value and propagate are optional parameters. For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
public CreateAutoScalingGroupRequest withTags(Tag... tags)
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
Returns a reference to this object so that method calls can be chained together.
tags
- The tag to be created or updated. Each tag should be defined by its
resource type, resource ID, key, value, and a propagate flag. Valid
values: key=value, value=value, propagate=true or
false. Value and propagate are optional parameters. For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
public CreateAutoScalingGroupRequest withTags(Collection<Tag> tags)
For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
Returns a reference to this object so that method calls can be chained together.
tags
- The tag to be created or updated. Each tag should be defined by its
resource type, resource ID, key, value, and a propagate flag. Valid
values: key=value, value=value, propagate=true or
false. Value and propagate are optional parameters. For information about using tags, see Tag Your Auto Scaling Groups and Amazon EC2 Instances.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.