Menu
Auto Scaling
API Reference (API Version 2011-01-01)

AutoScalingGroup

Describes an Auto Scaling group.

Contents

AutoScalingGroupARN

The Amazon Resource Name (ARN) of the group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

AutoScalingGroupName

The name of the group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

AvailabilityZones.member.N

One or more Availability Zones for the group.

Type: Array of strings

Array Members: Minimum number of 1 item.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

CreatedTime

The date and time the group was created.

Type: Timestamp

Required: Yes

DefaultCooldown

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

Type: Integer

Required: Yes

DesiredCapacity

The desired size of the group.

Type: Integer

Required: Yes

EnabledMetrics.member.N

The metrics enabled for the group.

Type: Array of EnabledMetric objects

Required: No

HealthCheckGracePeriod

The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service.

Type: Integer

Required: No

HealthCheckType

The service to use for the health checks. The valid values are EC2 and ELB.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

Instances.member.N

The EC2 instances associated with the group.

Type: Array of Instance objects

Required: No

LaunchConfigurationName

The name of the associated launch configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

LoadBalancerNames.member.N

One or more load balancers associated with the group.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

MaxSize

The maximum size of the group.

Type: Integer

Required: Yes

MinSize

The minimum size of the group.

Type: Integer

Required: Yes

NewInstancesProtectedFromScaleIn

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

Type: Boolean

Required: No

PlacementGroup

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Status

The current state of the group when DeleteAutoScalingGroup is in progress.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

SuspendedProcesses.member.N

The suspended processes associated with the group.

Type: Array of SuspendedProcess objects

Required: No

Tags.member.N

The tags for the group.

Type: Array of TagDescription objects

Required: No

TargetGroupARNs.member.N

The Amazon Resource Names (ARN) of the target groups for your load balancer.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 511.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

TerminationPolicies.member.N

The termination policies for the group.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

VPCZoneIdentifier

One or more subnet IDs, if applicable, separated by commas.

If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2047.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: