AutoScalingGroup
Describes an Auto Scaling group.
Contents
- AutoScalingGroupName
-
The name of the Auto Scaling 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
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 duration of the default cooldown period, in seconds.
Type: Integer
Required: Yes
- DesiredCapacity
-
The desired size of the group.
Type: Integer
Required: Yes
- HealthCheckType
-
A comma-separated value string of one or more health check types.
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
- MaxSize
-
The maximum size of the group.
Type: Integer
Required: Yes
- MinSize
-
The minimum size of the group.
Type: Integer
Required: Yes
- AutoScalingGroupARN
-
The Amazon Resource Name (ARN) of the Auto Scaling 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
- AvailabilityZoneDistribution
-
The instance capacity distribution across Availability Zones.
Type: AvailabilityZoneDistribution object
Required: No
- AvailabilityZoneImpairmentPolicy
-
The Availability Zone impairment policy.
Type: AvailabilityZoneImpairmentPolicy object
Required: No
- CapacityRebalance
-
Indicates whether Capacity Rebalancing is enabled.
Type: Boolean
Required: No
- CapacityReservationSpecification
-
The capacity reservation specification.
Type: CapacityReservationSpecification object
Required: No
- Context
-
Reserved.
Type: String
Required: No
- DefaultInstanceWarmup
-
The duration of the default instance warmup, in seconds.
Type: Integer
Required: No
- DesiredCapacityType
-
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityType
for attribute-based instance type selection only.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
- EnabledMetrics.member.N
-
The metrics enabled for the group.
Type: Array of EnabledMetric objects
Required: No
- HealthCheckGracePeriod
-
The duration of the health check grace period, in seconds.
Type: Integer
Required: No
- InstanceMaintenancePolicy
-
An instance maintenance policy.
Type: InstanceMaintenancePolicy object
Required: No
- 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
- LaunchTemplate
-
The launch template for the group.
Type: LaunchTemplateSpecification object
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
- MaxInstanceLifetime
-
The maximum amount of time, in seconds, that an instance can be in service.
Valid Range: Minimum value of 0.
Type: Integer
Required: No
- MixedInstancesPolicy
-
The mixed instances policy for the group.
Type: MixedInstancesPolicy object
Required: No
- NewInstancesProtectedFromScaleIn
-
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
Type: Boolean
Required: No
- PlacementGroup
-
The name of the placement group into which to launch your instances, if any.
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
- PredictedCapacity
-
The predicted capacity of the group when it has a predictive scaling policy.
Type: Integer
Required: No
- ServiceLinkedRoleARN
-
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.
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
- Status
-
The current state of the group when the DeleteAutoScalingGroup operation 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
- TrafficSources.member.N
-
The traffic sources associated with this Auto Scaling group.
Type: Array of TrafficSourceIdentifier objects
Required: No
- VPCZoneIdentifier
-
One or more subnet IDs, if applicable, separated by commas.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5000.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
- WarmPoolConfiguration
-
The warm pool for the group.
Type: WarmPoolConfiguration object
Required: No
- WarmPoolSize
-
The current size of the warm pool.
Type: Integer
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: