String activityId
The ID of the activity.
String autoScalingGroupName
The name of the Auto Scaling group.
String description
A friendly, more verbose description of the activity.
String cause
The reason the activity began.
Date startTime
The start time of the activity.
Date endTime
The end time of the activity.
String statusCode
The current status of the activity.
String statusMessage
A friendly, more verbose description of the activity status.
Integer progress
A value between 0 and 100 that indicates the progress of the activity.
String details
The details about the activity.
String autoScalingGroupState
The state of the Auto Scaling group, which is either InService or Deleted.
String autoScalingGroupARN
The Amazon Resource Name (ARN) of the Auto Scaling group.
String adjustmentType
The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity.
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to 20 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> loadBalancerNames
The names of the load balancers. You can specify up to 10 load balancers.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> targetGroupARNs
The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups. To get the ARN of a target group, use the Elastic Load Balancing DescribeTargetGroups API operation.
String autoScalingGroupName
The name of the Auto Scaling group.
String autoScalingGroupARN
The Amazon Resource Name (ARN) of the Auto Scaling group.
String launchConfigurationName
The name of the associated launch configuration.
LaunchTemplateSpecification launchTemplate
The launch template for the group.
MixedInstancesPolicy mixedInstancesPolicy
The mixed instances policy for the group.
Integer minSize
The minimum size of the group.
Integer maxSize
The maximum size of the group.
Integer desiredCapacity
The desired size of the group.
Integer predictedCapacity
The predicted capacity of the group when it has a predictive scaling policy.
Integer defaultCooldown
The duration of the default cooldown period, in seconds.
SdkInternalList<T> availabilityZones
One or more Availability Zones for the group.
SdkInternalList<T> loadBalancerNames
One or more load balancers associated with the group.
SdkInternalList<T> targetGroupARNs
The Amazon Resource Names (ARN) of the target groups for your load balancer.
String healthCheckType
The service to use for the health checks. The valid values are EC2 and ELB. If you
configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it
fails either the EC2 status checks or the load balancer health checks.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
SdkInternalList<T> instances
The EC2 instances associated with the group.
Date createdTime
The date and time the group was created.
SdkInternalList<T> suspendedProcesses
The suspended processes associated with the group.
String placementGroup
The name of the placement group into which to launch your instances, if any.
String vPCZoneIdentifier
One or more subnet IDs, if applicable, separated by commas.
SdkInternalList<T> enabledMetrics
The metrics enabled for the group.
String status
The current state of the group when the DeleteAutoScalingGroup operation is in progress.
SdkInternalList<T> tags
The tags for the group.
SdkInternalList<T> terminationPolicies
The termination policies for the group.
Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
String 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.
Integer maxInstanceLifetime
The maximum amount of time, in seconds, that an instance can be in service.
Valid Range: Minimum value of 0.
Boolean capacityRebalance
Indicates whether Capacity Rebalancing is enabled.
WarmPoolConfiguration warmPoolConfiguration
The warm pool for the group.
Integer warmPoolSize
The current size of the warm pool.
String context
Reserved.
String instanceId
The ID of the instance.
String instanceType
The instance type of the EC2 instance.
String autoScalingGroupName
The name of the Auto Scaling group for the instance.
String availabilityZone
The Availability Zone for the instance.
String lifecycleState
The lifecycle state for the instance. The Quarantined state is not used. For information about
lifecycle states, see Instance
lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid Values: Pending | Pending:Wait | Pending:Proceed |
Quarantined | InService | Terminating | Terminating:Wait |
Terminating:Proceed | Terminated | Detaching | Detached |
EnteringStandby | Standby | Warmed:Pending |
Warmed:Pending:Wait | Warmed:Pending:Proceed | Warmed:Terminating |
Warmed:Terminating:Wait | Warmed:Terminating:Proceed | Warmed:Terminated |
Warmed:Stopped | Warmed:Running
String healthStatus
The last reported health status of this instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
String launchConfigurationName
The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
LaunchTemplateSpecification launchTemplate
The launch template for the instance.
Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
String weightedCapacity
The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scheduledActionNames
The names of the scheduled actions to delete. The maximum number allowed is 50.
SdkInternalList<T> failedScheduledActions
The names of the scheduled actions that could not be deleted, including an error message.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scheduledUpdateGroupActions
One or more scheduled actions. The maximum number allowed is 50.
SdkInternalList<T> failedScheduledUpdateGroupActions
The names of the scheduled actions that could not be created or updated, including an error message.
String virtualName
The name of the virtual device (for example, ephemeral0).
You can specify either VirtualName or Ebs, but not both.
String deviceName
The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more
information, see Device Naming
on Linux Instances in the Amazon EC2 User Guide for Linux Instances.
Ebs ebs
Parameters used to automatically set up EBS volumes when an instance is launched.
You can specify either VirtualName or Ebs, but not both.
Boolean noDevice
Setting this value to true suppresses the specified device included in the block device mapping of
the AMI.
If NoDevice is true for the root device, instances might fail the EC2 health check. In
that case, Amazon EC2 Auto Scaling launches replacement instances.
If you specify NoDevice, you cannot specify Ebs.
String autoScalingGroupName
The name of the Auto Scaling group.
String instanceRefreshId
The instance refresh ID.
SdkInternalList<T> timestamps
The time stamps for the data points, in UTC format.
SdkInternalList<T> values
The values of the data points.
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group.
String lifecycleActionToken
A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
String lifecycleActionResult
The action for the group to take. This parameter can be either CONTINUE or ABANDON.
String instanceId
The ID of the instance.
String autoScalingGroupName
The name of the Auto Scaling group. This name must be unique per Region per account.
String launchConfigurationName
The name of the launch configuration to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate or
MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or
InstanceId).
LaunchTemplateSpecification launchTemplate
Parameters used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (LaunchTemplate or
MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or
InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
MixedInstancesPolicy mixedInstancesPolicy
An embedded object that specifies a mixed instances policy. The required properties must be specified. If optional properties are unspecified, their default values are used.
The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
String instanceId
The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Creating an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
Integer minSize
The minimum size of the group.
Integer maxSize
The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go
above MaxSize by more than your largest instance weight (weights that define how many units each
instance contributes to the desired capacity of the group).
Integer desiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.
Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The
default value is 300. This setting applies when using simple scaling policies, but not when using
other scaling policies or scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto
Scaling in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> availabilityZones
A list of Availability Zones where instances in the Auto Scaling group can be created. This parameter is optional
if you specify one or more subnets for VPCZoneIdentifier.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
SdkInternalList<T> loadBalancerNames
A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network
Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
SdkInternalList<T> targetGroupARNs
The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
String healthCheckType
The service to use for the health checks. The valid values are EC2 (default) and ELB.
If you configure an Auto Scaling group to use load balancer (ELB) health checks, it considers the instance
unhealthy if it fails either the EC2 status checks or the load balancer health checks. For more information, see
Health checks for Auto Scaling
instances in the Amazon EC2 Auto Scaling User Guide.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2
instance that has come into service. During this time, any health check failures for the instance are ignored.
The default value is 0. For more information, see Health
check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB health check.
String placementGroup
The name of an existing placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
String vPCZoneIdentifier
A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group
can be created. If you specify VPCZoneIdentifier with AvailabilityZones, the subnets
that you specify for this parameter must reside in those Availability Zones.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
SdkInternalList<T> terminationPolicies
A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Controlling which Auto Scaling instances terminate during scale in in the Amazon EC2 Auto Scaling User Guide.
Boolean 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 Instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
Boolean capacityRebalance
Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Amazon EC2 Auto Scaling Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> lifecycleHookSpecificationList
One or more lifecycle hooks for the group, which specify actions to perform when Amazon EC2 Auto Scaling launches or terminates instances.
SdkInternalList<T> tags
One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
String 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. By default, Amazon EC2 Auto Scaling uses a service-linked role named
AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-linked
roles in the Amazon EC2 Auto Scaling User Guide.
Integer maxInstanceLifetime
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
String context
Reserved.
String launchConfigurationName
The name of the launch configuration. This name must be unique per Region per account.
String imageId
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
If you do not specify InstanceId, you must specify ImageId.
String keyName
The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
SdkInternalList<T> securityGroups
A list that contains the security groups to assign to the instances in the Auto Scaling group.
[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
[EC2-Classic] Specify either the security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.
String classicLinkVPCId
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
This parameter can only be used if you are launching EC2-Classic instances.
SdkInternalList<T> classicLinkVPCSecurityGroups
The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify the ClassicLinkVPCId parameter, you must specify this parameter.
String userData
The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
String instanceId
The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Creating a launch configuration using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
If you do not specify InstanceId, you must specify both ImageId and
InstanceType.
String instanceType
Specifies the instance type of the EC2 instance.
For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
If you do not specify InstanceId, you must specify InstanceType.
String kernelId
The ID of the kernel associated with the AMI.
String ramdiskId
The ID of the RAM disk to select.
SdkInternalList<T> blockDeviceMappings
A block device mapping, which specifies the block devices for the instance. You can specify virtual devices and EBS volumes. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
InstanceMonitoring instanceMonitoring
Controls whether instances in this group are launched with detailed (true) or basic (
false) monitoring.
The default value is true (enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
String spotPrice
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.
When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
String iamInstanceProfile
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
Boolean ebsOptimized
Specifies whether the launch configuration is optimized for EBS I/O (true) or not (
false). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration
stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional
fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For
more information, see Amazon
EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.
The default value is false.
Boolean associatePublicIpAddress
For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public
IP address to the group's instances. If you specify true, each instance in the Auto Scaling group
receives a unique public IP address. For more information, see Launching Auto Scaling instances in
a VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this parameter, you must specify at least one subnet for VPCZoneIdentifier when you
create your group.
If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.
String placementTenancy
The tenancy of the instance. An instance with dedicated tenancy runs on isolated, single-tenant
hardware and can only be launched into a VPC.
To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set
to default), you must set the value of this parameter to dedicated.
If you specify PlacementTenancy, you must specify at least one subnet for
VPCZoneIdentifier when you create your group.
For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Valid Values: default | dedicated
InstanceMetadataOptions metadataOptions
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> tags
One or more tags.
String metricName
The name of the metric.
String namespace
The namespace of the metric.
SdkInternalList<T> dimensions
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
String statistic
The statistic of the metric.
String unit
The unit of the metric.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean forceDelete
Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any outstanding lifecycle actions associated with the group.
String launchConfigurationName
The name of the launch configuration.
SdkInternalList<T> tags
One or more tags.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean forceDelete
Specifies that the warm pool is to be deleted along with all of its associated instances, without waiting for all instances to be terminated. This parameter also deletes any outstanding lifecycle actions associated with the warm pool instances.
Integer maxNumberOfAutoScalingGroups
The maximum number of groups allowed for your account. The default is 200 groups per Region.
Integer maxNumberOfLaunchConfigurations
The maximum number of launch configurations allowed for your account. The default is 200 launch configurations per Region.
Integer numberOfAutoScalingGroups
The current number of groups for your account.
Integer numberOfLaunchConfigurations
The current number of launch configurations for your account.
SdkInternalList<T> adjustmentTypes
The policy adjustment types.
SdkInternalList<T> autoScalingGroupNames
The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally
increase this limit using the MaxRecords parameter.
If you omit this parameter, all Auto Scaling groups are described.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50 and the maximum value
is 100.
SdkInternalList<T> autoScalingGroups
The groups.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> instanceIds
The IDs of the instances. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
Array Members: Maximum number of 50 items.
Integer maxRecords
The maximum number of items to return with this call. The default value is 50 and the maximum value
is 50.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> autoScalingInstances
The instances.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> autoScalingNotificationTypes
The notification types.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> instanceRefreshIds
One or more instance refresh IDs.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50 and the maximum value
is 100.
SdkInternalList<T> instanceRefreshes
The instance refreshes for the specified group.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> launchConfigurationNames
The launch configuration names. If you omit this parameter, all launch configurations are described.
Array Members: Maximum number of 50 items.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50 and the maximum value
is 100.
SdkInternalList<T> launchConfigurations
The launch configurations.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> lifecycleHookNames
The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.
SdkInternalList<T> lifecycleHooks
The lifecycle hooks for the specified group.
SdkInternalList<T> lifecycleHookTypes
The lifecycle hook types.
String autoScalingGroupName
The name of the Auto Scaling group.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 100 and the maximum value
is 100.
SdkInternalList<T> loadBalancers
The load balancers.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
String autoScalingGroupName
The name of the Auto Scaling group.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 100 and the maximum value
is 100.
SdkInternalList<T> loadBalancerTargetGroups
Information about the target groups.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> metrics
One or more metrics.
SdkInternalList<T> granularities
The granularities for the metrics.
SdkInternalList<T> autoScalingGroupNames
The name of the Auto Scaling group.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50 and the maximum value
is 100.
SdkInternalList<T> notificationConfigurations
The notification configurations.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> policyNames
The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. If you specify an unknown policy name, it is ignored with no error.
Array Members: Maximum number of 50 items.
SdkInternalList<T> policyTypes
One or more policy types. The valid values are SimpleScaling, StepScaling,
TargetTrackingScaling, and PredictiveScaling.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to be returned with each call. The default value is 50 and the maximum
value is 100.
SdkInternalList<T> scalingPolicies
The scaling policies.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> activityIds
The activity IDs of the desired scaling activities. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
Array Members: Maximum number of 50 IDs.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean includeDeletedGroups
Indicates whether to include scaling activity from deleted Auto Scaling groups.
Integer maxRecords
The maximum number of items to return with this call. The default value is 100 and the maximum value
is 100.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> activities
The scaling activities. Activities are sorted by start time. Activities still in progress are described first.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> processes
The names of the process types.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scheduledActionNames
The names of one or more scheduled actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
Array Members: Maximum number of 50 actions.
Date startTime
The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
Date endTime
The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50 and the maximum value
is 100.
SdkInternalList<T> scheduledUpdateGroupActions
The scheduled actions.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> filters
One or more filters to scope the tags to return. The maximum number of filters per filter type (for example,
auto-scaling-group) is 1000.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50 and the maximum value
is 100.
SdkInternalList<T> tags
One or more tags.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> terminationPolicyTypes
The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance,
OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour,
Default, OldestLaunchTemplate, and AllocationStrategy.
String autoScalingGroupName
The name of the Auto Scaling group.
Integer maxRecords
The maximum number of instances to return with this call. The maximum value is 50.
String nextToken
The token for the next set of instances to return. (You received this token from a previous call.)
WarmPoolConfiguration warmPoolConfiguration
The warm pool configuration details.
SdkInternalList<T> instances
The instances that are currently in the warm pool.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to 20 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean shouldDecrementDesiredCapacity
Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.
SdkInternalList<T> activities
The activities related to detaching the instances from the Auto Scaling group.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> loadBalancerNames
The names of the load balancers. You can specify up to 10 load balancers.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> targetGroupARNs
The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> metrics
Specifies one or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
If you omit this parameter, all metrics are disabled.
String snapshotId
The snapshot ID of the volume to use.
You must specify either a VolumeSize or a SnapshotId.
Integer volumeSize
The volume size, in GiBs. The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
You must specify either a SnapshotId or a VolumeSize. If you specify both
SnapshotId and VolumeSize, the volume size must be equal or greater than the size of
the snapshot.
String volumeType
The volume type. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.
Valid Values: standard | io1 | gp2 | st1 | sc1 |
gp3
Boolean deleteOnTermination
Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value
is true.
Integer iops
The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For gp3
and io1 volumes, this represents the number of IOPS that are provisioned for the volume. For
gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume
accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances
built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
Iops is supported when the volume type is gp3 or io1 and required only
when the volume type is io1. (Not used with standard, gp2,
st1, or sc1 volumes.)
Boolean encrypted
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the Amazon Web Services managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.
Enabling encryption by default results in all EBS volumes being encrypted with the Amazon Web Services managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.
For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK key policy for use with encrypted volumes in the Amazon EC2 Auto Scaling User Guide.
Integer throughput
The throughput (MiBps) to provision for a gp3 volume.
String metric
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
String granularity
The granularity of the metric. The only valid value is 1Minute.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> metrics
Specifies which group-level metrics to start collecting. You can specify one or more of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The instance weighting feature supports the following additional metrics:
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
The warm pools feature supports the following additional metrics:
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
If you omit this parameter, all metrics are enabled.
String granularity
The granularity to associate with the metrics to collect. The only valid value is 1Minute.
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to 20 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean shouldDecrementDesiredCapacity
Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to
Standby mode.
SdkInternalList<T> activities
The activities related to moving instances into Standby mode.
String autoScalingGroupName
The name of the Auto Scaling group.
String policyName
The name or ARN of the policy.
Boolean honorCooldown
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.
Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto
Scaling in the Amazon EC2 Auto Scaling User Guide.
Double metricValue
The metric value to compare to BreachThreshold. This enables you to execute a policy of type
StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50
and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric
value to 59.
If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.
Required if the policy type is StepScaling and not supported otherwise.
Double breachThreshold
The breach threshold for the alarm.
Required if the policy type is StepScaling and not supported otherwise.
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to 20 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> activities
The activities related to moving instances out of Standby mode.
String name
The name of the filter. The valid values are: auto-scaling-group, key,
value, and propagate-at-launch.
SdkInternalList<T> values
One or more filter values. Filter values are case-sensitive.
String autoScalingGroupName
The name of the Auto Scaling group.
String policyName
The name of the policy.
Date startTime
The inclusive start time of the time range for the forecast data to get. At most, the date and time can be one year before the current date and time.
Date endTime
The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is 30 days.
Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. Amazon EC2 Auto Scaling only issues forecasts for periods of two days in advance.
SdkInternalList<T> loadForecast
The load forecast.
CapacityForecast capacityForecast
The capacity forecast.
Date updateTime
The time the forecast was made.
String instanceId
The ID of the instance.
String instanceType
The instance type of the EC2 instance.
String availabilityZone
The Availability Zone in which the instance is running.
String lifecycleState
A description of the current lifecycle state. The Quarantined state is not used. For information
about lifecycle states, see Instance
lifecycle in the Amazon EC2 Auto Scaling User Guide.
String healthStatus
The last reported health status of the instance. "Healthy" means that the instance is healthy and should remain in service. "Unhealthy" means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
String launchConfigurationName
The launch configuration associated with the instance.
LaunchTemplateSpecification launchTemplate
The launch template for the instance.
Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
String weightedCapacity
The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
String httpTokens
The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed
token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval
requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
version 1.0 credentials are not available.
Integer httpPutResponseHopLimit
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
String httpEndpoint
This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
Boolean enabled
If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
String instanceRefreshId
The instance refresh ID.
String autoScalingGroupName
The name of the Auto Scaling group.
String status
The current status for the instance refresh operation:
Pending - The request was created, but the operation has not started.
InProgress - The operation is in progress.
Successful - The operation completed successfully.
Failed - The operation failed to complete. You can troubleshoot using the status reason and the
scaling activities.
Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any
replacements that have already been completed, but it prevents new replacements from being started.
Cancelled - The operation is cancelled.
String statusReason
Provides more details about the current status of the instance refresh.
Date startTime
The date and time at which the instance refresh began.
Date endTime
The date and time at which the instance refresh ended.
Integer percentageComplete
The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
Integer instancesToUpdate
The number of instances remaining to update before the instance refresh is complete.
InstanceRefreshProgressDetails progressDetails
Additional progress details for an Auto Scaling group that has a warm pool.
Integer percentageComplete
The percentage of instances in the Auto Scaling group that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
Integer instancesToUpdate
The number of instances remaining to update.
InstanceRefreshLivePoolProgress livePoolProgress
Indicates the progress of an instance refresh on instances that are in the Auto Scaling group.
InstanceRefreshWarmPoolProgress warmPoolProgress
Indicates the progress of an instance refresh on instances that are in the warm pool.
Integer percentageComplete
The percentage of instances in the warm pool that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
Integer instancesToUpdate
The number of instances remaining to update.
String onDemandAllocationStrategy
Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid value is
prioritized, which is also the default value. This strategy uses the order of instance types in the
LaunchTemplateOverrides to define the launch priority of each instance type. The first instance type
in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your
highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority
instance type, and so on.
Integer onDemandBaseCapacity
The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base
portion is provisioned first as your group scales. Defaults to 0 if not specified. If you specify weights for the
instance types in the overrides, set the value of OnDemandBaseCapacity in terms of the number of
capacity units, and not the number of instances.
Integer onDemandPercentageAboveBaseCapacity
Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond
OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80%
Spot Instances). Defaults to 100 if not specified. If set to 100, only On-Demand Instances are provisioned.
String spotAllocationStrategy
Indicates how to allocate instances across Spot Instance pools.
If the allocation strategy is lowest-price, the Auto Scaling group launches instances using the Spot
pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you
specify. Defaults to lowest-price if not specified.
If the allocation strategy is capacity-optimized (recommended), the Auto Scaling group launches
instances using Spot pools that are optimally chosen based on the available Spot capacity. Alternatively, you can
use capacity-optimized-prioritized and set the order of instance types in the list of launch
template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling
honors the instance type priorities on a best-effort basis but optimizes for capacity first.
Integer spotInstancePools
The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined
from the different instance types in the overrides. Valid only when the Spot allocation strategy is
lowest-price. Value must be in the range of 1 to 20. Defaults to 2 if not specified.
String spotMaxPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value at its default (empty), Amazon EC2 Auto Scaling uses the On-Demand price as the maximum Spot price. To remove a value that you previously set, include the property but specify an empty string ("") for the value.
String launchConfigurationName
The name of the launch configuration.
String launchConfigurationARN
The Amazon Resource Name (ARN) of the launch configuration.
String imageId
The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
String keyName
The name of the key pair.
For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
SdkInternalList<T> securityGroups
A list that contains the security groups to assign to the instances in the Auto Scaling group. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
String classicLinkVPCId
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> classicLinkVPCSecurityGroups
The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId.
For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
String userData
The user data to make available to the launched EC2 instances. For more information, see Instance metadata and user data (Linux) and Instance metadata and user data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
String instanceType
The instance type for the instances.
For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
String kernelId
The ID of the kernel associated with the AMI.
String ramdiskId
The ID of the RAM disk associated with the AMI.
SdkInternalList<T> blockDeviceMappings
A block device mapping, which specifies the block devices for the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
InstanceMonitoring instanceMonitoring
Controls whether instances in this group are launched with detailed (true) or basic (
false) monitoring.
For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
String spotPrice
The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.
String iamInstanceProfile
The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM role for applications that run on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
Date createdTime
The creation date and time for the launch configuration.
Boolean ebsOptimized
Specifies whether the launch configuration is optimized for EBS I/O (true) or not (
false). For more information, see Amazon EBS-Optimized Instances
in the Amazon EC2 User Guide for Linux Instances.
Boolean associatePublicIpAddress
For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances. For more information, see Launching Auto Scaling instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
String placementTenancy
The tenancy of the instance, either default or dedicated. An instance with
dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
InstanceMetadataOptions metadataOptions
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the Amazon EC2 Auto Scaling User Guide.
LaunchTemplateSpecification launchTemplateSpecification
The launch template to use.
SdkInternalList<T> overrides
Any properties that you specify override the same properties in the launch template. If not provided, Amazon EC2 Auto Scaling uses the instance type specified in the launch template when it launches an instance.
String instanceType
The instance type, such as m3.xlarge. You must use an instance type that is supported in your
requested Region and Availability Zones. For more information, see Instance types in the
Amazon Elastic Compute Cloud User Guide.
String weightedCapacity
The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage,
throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is provisioned, the
capacity units count toward the desired capacity. Amazon EC2 Auto Scaling provisions instances until the desired
capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to
fulfill capacity, and Amazon EC2 Auto Scaling can only provision an instance with a WeightedCapacity
of 5 units, the instance is provisioned, and the desired capacity is exceeded by 3 units. For more information,
see Instance
weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Value must be in the
range of 1 to 999.
LaunchTemplateSpecification launchTemplateSpecification
Provides the launch template to be used when launching the instance type. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed instances policy. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.
String launchTemplateId
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
String launchTemplateName
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
String version
The version number, $Latest, or $Default. To get the version number, use the Amazon EC2
DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon
EC2
CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the
latest version of the launch template when launching instances. If the value is $Default, Amazon EC2
Auto Scaling selects the default version of the launch template when launching instances. The default value is
$Default.
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group for the lifecycle hook.
String lifecycleTransition
The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
String notificationTargetARN
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
String notificationMetadata
Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
Integer heartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times
out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.
Integer globalTimeout
The maximum time, in seconds, that an instance can remain in a Pending:Wait or
Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times
HeartbeatTimeout, whichever is smaller.
String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected
failure occurs. The possible values are CONTINUE and ABANDON.
String lifecycleHookName
The name of the lifecycle hook.
String lifecycleTransition
The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
String notificationMetadata
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
Integer heartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out.
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the
DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat.
String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected
failure occurs. The valid values are CONTINUE and ABANDON. The default value is
ABANDON.
String notificationTargetARN
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
String loadBalancerName
The name of the load balancer.
String state
One of the following load balancer states:
Adding - The Auto Scaling instances are being registered with the load balancer.
Added - All Auto Scaling instances are registered with the load balancer.
InService - At least one Auto Scaling instance passed an ELB health check.
Removing - The Auto Scaling instances are being deregistered from the load balancer. If connection
draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the
instances.
Removed - All Auto Scaling instances are deregistered from the load balancer.
String loadBalancerTargetGroupARN
The Amazon Resource Name (ARN) of the target group.
String state
The state of the target group.
Adding - The Auto Scaling instances are being registered with the target group.
Added - All Auto Scaling instances are registered with the target group.
InService - At least one Auto Scaling instance passed an ELB health check.
Removing - The Auto Scaling instances are being deregistered from the target group. If connection
draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the
instances.
Removed - All Auto Scaling instances are deregistered from the target group.
SdkInternalList<T> timestamps
The time stamps for the data points, in UTC format.
SdkInternalList<T> values
The values of the data points.
PredictiveScalingMetricSpecification metricSpecification
The metric specification for the load forecast.
String metric
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
String granularity
The granularity. The only valid value is 1Minute.
LaunchTemplate launchTemplate
Specifies the launch template to use and optionally the instance types (overrides) that are used to provision EC2 instances to fulfill On-Demand and Spot capacities. Required when creating a mixed instances policy.
InstancesDistribution instancesDistribution
Specifies the instances distribution. If not provided, the value for each property in
InstancesDistribution uses a default value.
String autoScalingGroupName
The name of the Auto Scaling group.
String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
String notificationType
One of the following event notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
String predefinedMetricType
The metric type. The following predefined metrics are available:
ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling
group.
ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto
Scaling group.
ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer
target group.
String resourceLabel
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
SdkInternalList<T> metricSpecifications
This structure includes the metrics and target utilization to use for predictive scaling.
This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
String mode
The predictive scaling mode. Defaults to ForecastOnly if not specified.
Integer schedulingBufferTime
The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
String maxCapacityBreachBehavior
Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity
of the Auto Scaling group. Defaults to HonorMaxCapacity if not specified.
The following are possible values:
HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than the maximum
capacity. The maximum capacity is enforced as a hard limit.
IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than the maximum
capacity when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by
the forecasted capacity and the value for MaxCapacityBuffer.
Integer maxCapacityBuffer
The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
Required if the MaxCapacityBreachBehavior property is set to IncreaseMaxCapacity, and
cannot be used otherwise.
Double targetValue
Specifies the target utilization.
PredictiveScalingPredefinedMetricPair predefinedMetricPairSpecification
The metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
PredictiveScalingPredefinedScalingMetric predefinedScalingMetricSpecification
The scaling metric specification.
PredictiveScalingPredefinedLoadMetric predefinedLoadMetricSpecification
The load metric specification.
String predefinedMetricType
The metric type.
String resourceLabel
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
String predefinedMetricType
Indicates which metrics to use. There are two different types of metrics for each metric type: one is a load
metric and one is a scaling metric. For example, if the metric type is ASGCPUUtilization, the Auto
Scaling group's total CPU metric is used as the load metric, and the average CPU metric is used for the scaling
metric.
String resourceLabel
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
String predefinedMetricType
The metric type.
String resourceLabel
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
String processName
One of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group.
String lifecycleTransition
The instance state to which you want to attach the lifecycle hook. The valid values are:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
Required for new lifecycle hooks, but optional when updating existing hooks.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
Required for new lifecycle hooks, but optional when updating existing hooks.
String notificationTargetARN
The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.
If you specify an empty string, this overrides the current ARN.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain
the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".
String notificationMetadata
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
Integer heartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30 to 7200 seconds. The default value is 3600 seconds (1 hour).
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the
DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling the
RecordLifecycleActionHeartbeat API.
String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected
failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is
ABANDON.
String autoScalingGroupName
The name of the Auto Scaling group.
String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
SdkInternalList<T> notificationTypes
The type of event that causes the notification to be sent. To query the notification types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.
String autoScalingGroupName
The name of the Auto Scaling group.
String policyName
The name of the policy.
String policyType
One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling (default)
PredictiveScaling
String adjustmentType
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid
values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Required if the policy type is StepScaling or SimpleScaling. For more information, see
Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.
Integer minAdjustmentStep
Available for backward compatibility. Use MinAdjustmentMagnitude instead.
Integer minAdjustmentMagnitude
The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example,
suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a
MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25
percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto
Scaling scales out the group by 2 instances.
Valid only if the policy type is StepScaling or SimpleScaling. For more information,
see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.
Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a
value that is at least as large as your largest instance weight.
Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.
Required if the policy type is SimpleScaling. (Not used with any other policy type.)
Integer cooldown
The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.
Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto
Scaling in the Amazon EC2 Auto Scaling User Guide.
String metricAggregationType
The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum,
and Average. If the aggregation type is null, the value is treated as Average.
Valid only if the policy type is StepScaling.
SdkInternalList<T> stepAdjustments
A set of adjustments that enable you to scale based on the size of the alarm breach.
Required if the policy type is StepScaling. (Not used with any other policy type.)
Integer estimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.
Valid only if the policy type is TargetTrackingScaling or StepScaling.
TargetTrackingConfiguration targetTrackingConfiguration
A target tracking scaling policy. Provides support for predefined or customized metrics.
The following predefined metrics are available:
ASGAverageCPUUtilization
ASGAverageNetworkIn
ASGAverageNetworkOut
ALBRequestCountPerTarget
If you specify ALBRequestCountPerTarget for the metric, you must specify the
ResourceLabel parameter with the PredefinedMetricSpecification.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is TargetTrackingScaling.
Boolean enabled
Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see Disabling a scaling policy for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
PredictiveScalingConfiguration predictiveScalingConfiguration
A predictive scaling policy. Provides support for only predefined metrics.
Predictive scaling works with CPU utilization, network in/out, and the Application Load Balancer request count.
For more information, see PredictiveScalingConfiguration in the Amazon EC2 Auto Scaling API Reference.
Required if the policy type is PredictiveScaling.
String policyARN
The Amazon Resource Name (ARN) of the policy.
SdkInternalList<T> alarms
The CloudWatch alarms created for the target tracking scaling policy.
String autoScalingGroupName
The name of the Auto Scaling group.
String scheduledActionName
The name of this scaling action.
Date time
This parameter is no longer used.
Date startTime
The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for
example, "2019-06-01T00:00:00Z").
If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at
this time, and then performs the action based on the specified recurrence.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
Date endTime
The date and time for the recurring schedule to end, in UTC.
String recurrence
The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute]
[Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example,
"30 0 1 1,6,12 *"). For more information about this format, see Crontab.
When StartTime and EndTime are specified with Recurrence, they form the
boundaries of when the recurring action starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
Integer minSize
The minimum size of the Auto Scaling group.
Integer maxSize
The maximum size of the Auto Scaling group.
Integer desiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.
String timeZone
Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as
Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
String autoScalingGroupName
The name of the Auto Scaling group.
Integer maxGroupPreparedCapacity
Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except
Terminated for the Auto Scaling group. This is an optional property. Specify it only if you do not
want the warm pool size to be determined by the difference between the group's maximum capacity and its desired
capacity.
If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and
maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value
for MaxGroupPreparedCapacity, Amazon EC2 Auto Scaling uses the difference between the
MaxGroupPreparedCapacity and the desired capacity instead.
The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize
are set to the same value does the warm pool have an absolute size.
If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity, the
capacity of the warm pool is 0, unless you specify a value for MinSize. To remove a value that you
previously set, include the property but specify -1 for the value.
Integer minSize
Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.
String poolState
Sets the instance state to transition to after the lifecycle actions are complete. Default is
Stopped.
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group.
String lifecycleActionToken
A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.
String instanceId
The ID of the instance.
Integer minHealthyPercentage
The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the
operation to continue, as a percentage of the desired capacity of the Auto Scaling group (rounded up to the
nearest integer). The default is 90.
Integer instanceWarmup
The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.
SdkInternalList<T> checkpointPercentages
Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in
the Auto Scaling group, the last number in the array must be 100.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
Integer checkpointDelay
The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if
you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify
a value for CheckpointPercentages and not for CheckpointDelay, the
CheckpointDelay defaults to 3600 (1 hour).
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scalingProcesses
One or more of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
If you omit this parameter, all processes are specified.
String autoScalingGroupName
The name of the Auto Scaling group.
String policyName
The name of the scaling policy.
String policyARN
The Amazon Resource Name (ARN) of the policy.
String policyType
One of the following policy types:
TargetTrackingScaling
StepScaling
SimpleScaling (default)
PredictiveScaling
For more information, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
String adjustmentType
Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid
values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
Integer minAdjustmentStep
Available for backward compatibility. Use MinAdjustmentMagnitude instead.
Integer minAdjustmentMagnitude
The minimum value to scale by when the adjustment type is PercentChangeInCapacity.
Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
Integer cooldown
The duration of the policy's cooldown period, in seconds.
SdkInternalList<T> stepAdjustments
A set of adjustments that enable you to scale based on the size of the alarm breach.
String metricAggregationType
The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum,
and Average.
Integer estimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
SdkInternalList<T> alarms
The CloudWatch alarms related to the policy.
TargetTrackingConfiguration targetTrackingConfiguration
A target tracking scaling policy.
Boolean enabled
Indicates whether the policy is enabled (true) or disabled (false).
PredictiveScalingConfiguration predictiveScalingConfiguration
A predictive scaling policy.
String autoScalingGroupName
The name of the Auto Scaling group.
String scheduledActionName
The name of the scheduled action.
String scheduledActionARN
The Amazon Resource Name (ARN) of the scheduled action.
Date time
This parameter is no longer used.
Date startTime
The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z".
Date endTime
The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z".
String recurrence
The recurring schedule for the action, in Unix cron syntax format.
When StartTime and EndTime are specified with Recurrence, they form the
boundaries of when the recurring action starts and stops.
Integer minSize
The minimum size of the Auto Scaling group.
Integer maxSize
The maximum size of the Auto Scaling group.
Integer desiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
String timeZone
The time zone for the cron expression.
String scheduledActionName
The name of the scaling action.
Date startTime
The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for
example, "2019-06-01T00:00:00Z").
If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at
this time, and then performs the action based on the specified recurrence.
If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.
Date endTime
The date and time for the recurring schedule to end, in UTC.
String recurrence
The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated
by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for
example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.
When StartTime and EndTime are specified with Recurrence, they form the
boundaries of when the recurring action starts and stops.
Cron expressions use Universal Coordinated Time (UTC) by default.
Integer minSize
The minimum size of the Auto Scaling group.
Integer maxSize
The maximum size of the Auto Scaling group.
Integer desiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
String timeZone
Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as
Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
String autoScalingGroupName
The name of the Auto Scaling group.
Integer desiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain.
Boolean honorCooldown
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.
String instanceId
The ID of the instance.
String healthStatus
The health status of the instance. Set to Healthy to have the instance remain in service. Set to
Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces
the unhealthy instance.
Boolean shouldRespectGracePeriod
If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the
group, by default, this call respects the grace period. Set this to False, to have the call not
respect the grace period associated with the group.
For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.
SdkInternalList<T> instanceIds
One or more instance IDs. You can specify up to 50 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean protectedFromScaleIn
Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
String autoScalingGroupName
The name of the Auto Scaling group.
String strategy
The strategy to use for the instance refresh. The only valid value is Rolling.
A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.
RefreshPreferences preferences
Set of preferences associated with the instance refresh request.
If not provided, the default values are used. For MinHealthyPercentage, the default value is
90. For InstanceWarmup, the default is to use the value specified for the health check
grace period for the Auto Scaling group.
For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API Reference.
String instanceRefreshId
A unique ID for tracking the progress of the request.
Double metricIntervalLowerBound
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
Double metricIntervalUpperBound
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scalingProcesses
One or more of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
InstanceRefresh
ReplaceUnhealthy
ScheduledActions
If you omit this parameter, all processes are specified.
String resourceId
The name of the Auto Scaling group.
String resourceType
The type of resource. The only supported value is auto-scaling-group.
String key
The tag key.
String value
The tag value.
Boolean propagateAtLaunch
Determines whether the tag is added to new instances as they are launched in the group.
String resourceId
The name of the group.
String resourceType
The type of resource. The only supported value is auto-scaling-group.
String key
The tag key.
String value
The tag value.
Boolean propagateAtLaunch
Determines whether the tag is added to new instances as they are launched in the group.
PredefinedMetricSpecification predefinedMetricSpecification
A predefined metric. You must specify either a predefined metric or a customized metric.
CustomizedMetricSpecification customizedMetricSpecification
A customized metric. You must specify either a predefined metric or a customized metric.
Double targetValue
The target value for the metric.
Boolean disableScaleIn
Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the
target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target
tracking scaling policy can remove instances from the Auto Scaling group. The default is false.
Activity activity
A scaling activity.
String autoScalingGroupName
The name of the Auto Scaling group.
String launchConfigurationName
The name of the launch configuration. If you specify LaunchConfigurationName in your update request,
you can't specify LaunchTemplate or MixedInstancesPolicy.
LaunchTemplateSpecification launchTemplate
The launch template and version to use to specify the updates. If you specify LaunchTemplate in your
update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.
MixedInstancesPolicy mixedInstancesPolicy
An embedded object that specifies a mixed instances policy. When you make changes to an existing policy, all optional properties are left unchanged if not specified. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
Integer minSize
The minimum size of the Auto Scaling group.
Integer maxSize
The maximum size of the Auto Scaling group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go
above MaxSize by more than your largest instance weight (weights that define how many units each
instance contributes to the desired capacity of the group).
Integer desiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The
default value is 300. This setting applies when using simple scaling policies, but not when using
other scaling policies or scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto
Scaling in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> availabilityZones
One or more Availability Zones for the group.
String healthCheckType
The service to use for the health checks. The valid values are EC2 and ELB. If you
configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it
fails either the EC2 status checks or the load balancer health checks.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2
instance that has come into service. The default value is 0. For more information, see Health
check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB health check.
String placementGroup
The name of an existing placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
String vPCZoneIdentifier
A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify
VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this
parameter must reside in those Availability Zones.
SdkInternalList<T> terminationPolicies
A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Controlling which Auto Scaling instances terminate during scale in in the Amazon EC2 Auto Scaling User Guide.
Boolean 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 Instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
String 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. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
Integer maxInstanceLifetime
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
Boolean capacityRebalance
Enables or disables Capacity Rebalancing. For more information, see Amazon EC2 Auto Scaling Capacity Rebalancing in the Amazon EC2 Auto Scaling User Guide.
String context
Reserved.
Integer maxGroupPreparedCapacity
The maximum number of instances that are allowed to be in the warm pool or in any state except
Terminated for the Auto Scaling group.
Integer minSize
The minimum number of instances to maintain in the warm pool.
String poolState
The instance state to transition to after the lifecycle actions are complete.
String status
The status of a warm pool that is marked for deletion.
Copyright © 2021. All rights reserved.