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> alarms
The names of one or more CloudWatch alarms to monitor for the instance refresh. You can specify up to 10 alarms.
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 (ARNs) 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.
SdkInternalList<T> trafficSources
The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources.
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
A comma-separated value string of one or more health check types.
Integer healthCheckGracePeriod
The duration of the health check grace period, in seconds.
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 desiredCapacityType
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityType for attribute-based instance type selection only.
Integer defaultInstanceWarmup
The duration of the default instance warmup, in seconds.
SdkInternalList<T> trafficSources
The traffic sources associated with this Auto Scaling group.
InstanceMaintenancePolicy instanceMaintenancePolicy
An instance maintenance policy.
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 instance store volume (virtual device) to attach to an instance at launch. The name must be in
the form ephemeralX where X is a number starting from zero (0), for example,
ephemeral0.
String deviceName
The device name assigned to the volume (for example, /dev/sdh or xvdh). For more
information, see Device naming
on Linux instances in the Amazon EC2 User Guide for Linux Instances.
To define a block device mapping, set the device name and exactly one of the following properties:
Ebs, NoDevice, or VirtualName.
Ebs ebs
Information to attach an EBS volume to an instance at launch.
Boolean noDevice
Setting this value to true prevents a volume that is included in the block device mapping of the AMI
from being mapped to the specified device name at launch.
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.
String autoScalingGroupName
The name of the Auto Scaling group.
String instanceRefreshId
The instance refresh ID associated with the request. This is the unique ID assigned to the instance refresh when it was started.
SdkInternalList<T> timestamps
The timestamps 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. You can specify 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.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
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
Information 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
The mixed instances policy. 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
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: 300 seconds
SdkInternalList<T> availabilityZones
A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into
the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or
for attaching a network interface when an existing network interface ID is specified in a launch template.
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 Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
String healthCheckType
A comma-separated value string of one or more health check types.
The valid values are EC2, ELB, and VPC_LATTICE. EC2 is the
default health check and cannot be disabled. For more information, see Health checks for Auto Scaling
instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously set.
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 and marking it unhealthy due to a failed health check. This is useful if your
instances do not immediately pass their health checks after they enter the InService state. For more
information, see Set the health check
grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
Default: 0 seconds
String placementGroup
The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
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 must reside in those Availability Zones.
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 Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour |
NewestInstance | OldestInstance | OldestLaunchConfiguration |
OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
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 Using 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 Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> lifecycleHookSpecificationList
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
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 Tag 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 service 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 desiredCapacityType
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityType for attribute-based instance type selection only. For more information, see Creating
an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User
Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
Integer defaultInstanceWarmup
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource
consumption to become stable after it enters the InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup,
even if it is set to 0 seconds. To remove a value that you previously set, include the property but
specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled
by specifying a value of 0 or other nominal value.
Default: None
SdkInternalList<T> trafficSources
The list of traffic sources to attach to this Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and VPC Lattice.
InstanceMaintenancePolicy instanceMaintenancePolicy
An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
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 a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
If you specify InstanceId, an ImageId is not required.
String keyName
The name of the key pair. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon EC2 User Guide for Linux Instances.
SdkInternalList<T> securityGroups
A list that contains the security group IDs to assign to the instances in the Auto Scaling group. For more information, see Control traffic to resources using security groups in the Amazon Virtual Private Cloud User Guide.
String classicLinkVPCId
Available for backward compatibility.
SdkInternalList<T> classicLinkVPCSecurityGroups
Available for backward compatibility.
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.
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 specify InstanceId, an InstanceType is not required.
String kernelId
The ID of the kernel associated with the AMI.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
String ramdiskId
The ID of the RAM disk to select.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide for Linux Instances.
SdkInternalList<T> blockDeviceMappings
The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see Block device mappings 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 Request Spot Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
Valid Range: Minimum value of 0.001
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
Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.
If you specify true, each instance in the Auto Scaling group receives a unique public IPv4 address.
For more information, see Launching Auto Scaling instances in
a VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for VPCZoneIdentifier when you
create your group.
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. 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 property to dedicated. For more information,
see Configuring
instance tenancy with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy, you must specify at least one subnet for
VPCZoneIdentifier when you create your group.
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. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
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. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
SdkInternalList<T> metrics
The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
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 action 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 property.
If you omit this property, 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> filters
One or more filters to limit the results based on specific tags.
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 property, 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, sorted by creation timestamp in descending order.
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 property, 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 property, 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
The 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 property, 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 property, 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 property, 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 property is ignored.
Date endTime
The latest scheduled start time to return. If scheduled action names are provided, this property 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.
String trafficSourceType
The traffic source type that you want to describe.
The following lists the valid values:
elb if the traffic source is a Classic Load Balancer.
elbv2 if the traffic source is a Application Load Balancer, Gateway Load Balancer, or Network Load
Balancer.
vpc-lattice if the traffic source is VPC Lattice.
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 maximum value is 50.
SdkInternalList<T> trafficSources
Information about the traffic sources.
String nextToken
This string 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.
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
This string 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.
LaunchTemplateSpecification launchTemplate
Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
MixedInstancesPolicy mixedInstancesPolicy
Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
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> trafficSources
The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> metrics
Identifies the metrics to disable.
You can specify 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 property, all metrics are disabled.
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
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 create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.
If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted.
For more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS 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
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
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
Identifies the metrics to enable.
You can specify 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 specify Granularity and don't specify any metrics, all metrics are enabled.
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
String granularity
The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. 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 for Name depend on which API operation you're using with the filter
(DescribeAutoScalingGroups or DescribeTags).
DescribeAutoScalingGroups
Valid values for Name include the following:
tag-key - Accepts tag keys. The results only include information about the Auto Scaling groups
associated with these tag keys.
tag-value - Accepts tag values. The results only include information about the Auto Scaling groups
associated with these tag values.
tag:<key> - Accepts the key/value combination of the tag. Use the tag key in the filter name
and the tag value as the filter value. The results only include information about the Auto Scaling groups
associated with the specified key/value combination.
DescribeTags
Valid values for Name include the following:
auto-scaling-group - Accepts the names of Auto Scaling groups. The results only include information
about the tags associated with these Auto Scaling groups.
key - Accepts tag keys. The results only include information about the tags associated with these
tag keys.
value - Accepts tag values. The results only include information about the tags associated with
these tag values.
propagate-at-launch - Accepts a Boolean value, which specifies whether tags propagate to instances
at launch. The results only include information about the tags associated with the specified Boolean value.
SdkInternalList<T> values
One or more filter values. Filter values are case-sensitive.
If you specify multiple values for a filter, the values are automatically logically joined with an
OR, and the request returns all results that match any of the specified values. For example, specify
"tag:environment" for the filter name and "production,development" for the filter values to find Auto Scaling
groups with the tag "environment=production" or "environment=development".
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.
Integer minHealthyPercentage
Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents
the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when
replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of -1
.
Integer maxHealthyPercentage
Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents
the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when
replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of
-1.
Both MinHealthyPercentage and MaxHealthyPercentage must be specified, and the
difference between them cannot be greater than 100. A large range increases the number of instances that can be
replaced at the same time.
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 instance refresh has not started.
InProgress - An instance refresh is in progress.
Successful - An instance refresh completed successfully.
Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and
the scaling activities.
Cancelling - An ongoing instance refresh is being cancelled.
Cancelled - The instance refresh is cancelled.
RollbackInProgress - An instance refresh is being rolled back.
RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and
the scaling activities.
RollbackSuccessful - The rollback completed successfully.
String statusReason
The explanation for the specific status assigned to this operation.
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.
PercentageComplete does not include instances that are replaced during a rollback. This value
gradually goes back down to zero during a rollback.
Integer instancesToUpdate
The number of instances remaining to update before the instance refresh is complete.
If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were
not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the
rollback.
InstanceRefreshProgressDetails progressDetails
Additional progress details for an Auto Scaling group that has a warm pool.
RefreshPreferences preferences
The preferences for an instance refresh.
DesiredConfiguration desiredConfiguration
Describes the desired configuration for the instance refresh.
RollbackDetails rollbackDetails
The rollback details.
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
Reports progress on replacing instances that are in the Auto Scaling group.
InstanceRefreshWarmPoolProgress warmPoolProgress
Reports progress on replacing 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.
VCpuCountRequest vCpuCount
The minimum and maximum number of vCPUs for an instance type.
MemoryMiBRequest memoryMiB
The minimum and maximum instance memory size for an instance type, in MiB.
SdkInternalList<T> cpuManufacturers
Lists which specific CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
MemoryGiBPerVCpuRequest memoryGiBPerVCpu
The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
Default: No minimum or maximum limits
SdkInternalList<T> excludedInstanceTypes
The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (
*), to exclude an instance family, type, size, or generation. The following are examples:
m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*, you are excluding the entire C5 instance family, which includes all
C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a
instance types, but not the M5n instance types.
If you specify ExcludedInstanceTypes, you can't specify AllowedInstanceTypes.
Default: No excluded instance types
SdkInternalList<T> instanceGenerations
Indicates whether current or previous generation instance types are included.
For current generation instance types, specify current. The current generation includes EC2 instance
types currently recommended for use. This typically includes the latest two to three generations in each instance
family. For more information, see Instance types in the
Amazon EC2 User Guide for Linux Instances.
For previous generation instance types, specify previous.
Default: Any current or previous generation
Integer spotMaxPricePercentageOverLowestPrice
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection
threshold is based on the per-vCPU or per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon
EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of
instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all
instance types that match your attributes, include one of these parameters and specify a high value, such as
999999.
Integer maxSpotPriceAsPercentageOfOptimalOnDemandPrice
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection
threshold is based on the per-vCPU or per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon
EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of
instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all
instance types that match your attributes, include one of these parameters and specify a high value, such as
999999.
Integer onDemandMaxPricePercentageOverLowestPrice
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection
threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.
Default: 20
String bareMetal
Indicates whether bare metal instance types are included, excluded, or required.
Default: excluded
String burstablePerformance
Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.
Default: excluded
Boolean requireHibernateSupport
Indicates whether instance types must provide On-Demand Instance hibernation support.
Default: false
NetworkInterfaceCountRequest networkInterfaceCount
The minimum and maximum number of network interfaces for an instance type.
Default: No minimum or maximum limits
String localStorage
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.
Default: included
SdkInternalList<T> localStorageTypes
Indicates the type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: Any local storage type
TotalLocalStorageGBRequest totalLocalStorageGB
The minimum and maximum total local storage size for an instance type, in GB.
Default: No minimum or maximum limits
BaselineEbsBandwidthMbpsRequest baselineEbsBandwidthMbps
The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.
Default: No minimum or maximum limits
SdkInternalList<T> acceleratorTypes
Lists the accelerator types that must be on an instance type.
For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
AcceleratorCountRequest acceleratorCount
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
SdkInternalList<T> acceleratorManufacturers
Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
SdkInternalList<T> acceleratorNames
Lists the accelerators that must be on an instance type.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
AcceleratorTotalMemoryMiBRequest acceleratorTotalMemoryMiB
The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
Default: No minimum or maximum limits
NetworkBandwidthGbpsRequest networkBandwidthGbps
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
SdkInternalList<T> allowedInstanceTypes
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (*), to allow an
instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*,
m5a.*, r*, *3*.
For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family,
which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will
allow all the M5a instance types, but not the M5n instance types.
If you specify AllowedInstanceTypes, you can't specify ExcludedInstanceTypes.
Default: All instance types
Boolean reuseOnScaleIn
Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
String onDemandAllocationStrategy
The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
The following lists the valid values:
Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.
Integer onDemandBaseCapacity
The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.
This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.
Default: 0
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). If set to 100, only On-Demand Instances are used.
Default: 100
String spotAllocationStrategy
The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
The following lists the valid values:
Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy
has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use
capacity-optimized-prioritized.
You set the order of instance types for the 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. Note that if the On-Demand allocation strategy is set to prioritized,
the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling
groups that specify InstanceRequirements.
Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot
pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is
met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high
interruption rates because this strategy only considers instance price and not available capacity.
The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.
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 SpotAllocationStrategy is
lowest-price. Value must be in the range of 1–20.
Default: 2
String spotMaxPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.
Valid Range: Minimum value of 0.001
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 Find a Linux 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
Available for backward compatibility.
SdkInternalList<T> classicLinkVPCSecurityGroups
Available for backward compatibility.
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
The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. 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
Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet. 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.
SdkInternalList<T> overrides
Any properties that you specify override the same properties in the launch template.
String instanceType
The instance type, such as m3.xlarge. You must specify 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.
You can specify up to 40 instance types per Auto Scaling group.
String weightedCapacity
If you provide a list of instance types to use, you can specify the number of capacity units provided by each
instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance
characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired
capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if
this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2
Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is
launched, and the desired capacity is exceeded by three units. For more information, see Configuring instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Value must be in the range of 1–999.
If you specify a value for WeightedCapacity for one instance type, you must specify a value for
WeightedCapacity for all of them.
Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and
MinSize). Usually, you set these sizes based on a specific number of instances. However, if you
configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with
the same units that you use for weighting instances.
LaunchTemplateSpecification launchTemplateSpecification
Provides a launch template for the specified instance type or set of instance requirements. 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 specified in the LaunchTemplate definition. For more information,
see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User
Guide.
You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides
and in the LaunchTemplate definition count towards this limit.
InstanceRequirements instanceRequirements
The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.
You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.
If you specify InstanceRequirements, you can't specify InstanceType.
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 lifecycle transition.
Valid 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 a wait state for the lifecycle hook.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).
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 property.
Integer globalTimeout
The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48
hours) or 100 times HeartbeatTimeout, whichever is smaller.
String defaultResult
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
Valid values: CONTINUE | ABANDON
String lifecycleHookName
The name of the lifecycle hook.
String lifecycleTransition
The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify 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. The range is from
30 to 7200 seconds. The default value is 3600 seconds (1 hour).
String defaultResult
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure
occurs. The default value is ABANDON.
Valid values: CONTINUE | ABANDON
String notificationTargetARN
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide.
Valid only if the notification target is 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 timestamps 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 namespace
The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
String metricName
The name of the metric.
SdkInternalList<T> dimensions
The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
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 id
A short name that identifies the object's results in the response. This name must be unique among all
MetricDataQuery objects specified for a single scaling policy. If you are performing math
expressions on this set of data, this name represents that data and can serve as a variable in the mathematical
expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase
letter.
String expression
The math expression to perform on the returned data, if this object is performing a math expression. This
expression can use the Id of the other metrics to refer to those metrics, and can also use the
Id of other expressions to use the result of those expressions.
Conditional: Within each MetricDataQuery object, you must specify either Expression or
MetricStat, but not both.
MetricStat metricStat
Information about the metric data to return.
Conditional: Within each MetricDataQuery object, you must specify either Expression or
MetricStat, but not both.
String label
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
Boolean returnData
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true for this value for only the final math expression that
the metric specification is based on. You must specify false for ReturnData for all the
other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData. This sets it to its default (true).
String granularity
The granularity. The only valid value is 1Minute.
Metric metric
The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
String stat
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are Average and Sum.
String unit
The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
LaunchTemplate launchTemplate
One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
InstancesDistribution instancesDistribution
The instances distribution.
String autoScalingGroupName
The name of the Auto Scaling group.
String topicARN
The Amazon Resource Name (ARN) of the 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 - Average Application Load Balancer request count per target for your Auto
Scaling 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.
SdkInternalList<T> metricDataQueries
One or more metric data queries to provide the data points for a capacity metric. Use multiple metric data queries only if you are performing a math expression on returned data.
SdkInternalList<T> metricDataQueries
One or more metric data queries to provide the data points for a load metric. Use multiple metric data queries only if you are performing a math expression on returned data.
SdkInternalList<T> metricDataQueries
One or more metric data queries to provide the data points for a scaling metric. Use multiple metric data queries only if you are performing a math expression on returned data.
Double targetValue
Specifies the target utilization.
Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.
PredictiveScalingPredefinedMetricPair predefinedMetricPairSpecification
The predefined metric pair specification from which Amazon EC2 Auto Scaling determines the appropriate scaling metric and load metric to use.
PredictiveScalingPredefinedScalingMetric predefinedScalingMetricSpecification
The predefined scaling metric specification.
PredictiveScalingPredefinedLoadMetric predefinedLoadMetricSpecification
The predefined load metric specification.
PredictiveScalingCustomizedScalingMetric customizedScalingMetricSpecification
The customized scaling metric specification.
PredictiveScalingCustomizedLoadMetric customizedLoadMetricSpecification
The customized load metric specification.
PredictiveScalingCustomizedCapacityMetric customizedCapacityMetricSpecification
The customized capacity 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 lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.
To create a lifecycle hook for scale-in events, specify 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.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.
String notificationTargetARN
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.
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).
String defaultResult
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure
occurs. The default value is ABANDON.
Valid values: CONTINUE | ABANDON
String autoScalingGroupName
The name of the Auto Scaling group.
String topicARN
The Amazon Resource Name (ARN) of the 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 non-negative value.
Required if the policy type is SimpleScaling. (Not used with any other policy type.)
Integer cooldown
A cooldown period, in seconds, that applies to a specific simple scaling policy. When a cooldown period is specified here, it overrides the default cooldown.
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.
Default: None
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
Not needed if the default instance warmup is defined for the group.
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This warm-up period applies to instances launched due to a specific target tracking or step scaling policy. When a warm-up period is specified here, it overrides the default instance warmup.
Valid only if the policy type is TargetTrackingScaling or StepScaling.
The default is to use the value for the default instance warmup defined for the group. If default instance warmup
is null, then EstimatedInstanceWarmup falls back to the value of default cooldown.
TargetTrackingConfiguration targetTrackingConfiguration
A target tracking scaling policy. Provides support for predefined or custom metrics.
The following predefined metrics are available:
ASGAverageCPUUtilization
ASGAverageNetworkIn
ASGAverageNetworkOut
ALBRequestCountPerTarget
If you specify ALBRequestCountPerTarget for the metric, you must specify the
ResourceLabel property 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 predefined and custom metrics.
Predefined metrics include 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 property 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, "2021-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.
Date endTime
The date and time for the recurring schedule to end, in UTC. For example, "2021-06-01T00:00:00Z".
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.
You must specify at least one of the following properties: MaxSize, MinSize, or
DesiredCapacity.
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.
InstanceReusePolicy instanceReusePolicy
Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.
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
Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100.
If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.
Integer instanceWarmup
A time period, in seconds, during which an instance refresh waits before moving on to replacing the next instance
after a new instance enters the InService state.
This property is not required for normal usage. Instead, use the DefaultInstanceWarmup property of
the Auto Scaling group. The InstanceWarmup and DefaultInstanceWarmup properties work
the same way. Only specify this property if you must override the DefaultInstanceWarmup property.
If you do not specify this property, the instance warmup by default is the value of the
DefaultInstanceWarmup property, if defined (which is recommended in all cases), or the
HealthCheckGracePeriod property otherwise.
SdkInternalList<T> checkpointPercentages
(Optional) 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
(Optional) 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).
Boolean skipMatching
(Optional) Indicates whether skip matching is enabled. If enabled (true), then Amazon EC2 Auto
Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified,
then it skips replacing instances that have the same launch template and instance types that the Auto Scaling
group was using before the start of the instance refresh. The default is false.
For more information, see Use an instance refresh with skip matching in the Amazon EC2 Auto Scaling User Guide.
Boolean autoRollback
(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the instance
refresh fails or a CloudWatch alarm threshold is met. The default is false.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead
of an AMI ID for the ImageId property.
The Auto Scaling group uses the launch template's $Latest or $Default version.
For more information, see Undo changes with a rollback in the Amazon EC2 Auto Scaling User Guide.
String scaleInProtectedInstances
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
The following lists the valid values:
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
String standbyInstances
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are
found.
The following lists the valid values:
Amazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances
that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
AlarmSpecification alarmSpecification
(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues and fail the operation if an alarm threshold is met.
Integer maxHealthyPercentage
Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.
If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and
the difference between them cannot be greater than 100. A larger range increases the number of instances that can
be replaced at the same time.
If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.
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 property, all processes are specified.
String rollbackReason
The reason for this instance refresh rollback (for example, whether a manual or automatic rollback was initiated).
Date rollbackStartTime
The date and time at which the rollback began.
Integer percentageCompleteOnRollback
Indicates the value of PercentageComplete at the time the rollback started.
Integer instancesToUpdateOnRollback
Indicates the value of InstancesToUpdate at the time the rollback started.
InstanceRefreshProgressDetails progressDetailsOnRollback
Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool).
String autoScalingGroupName
The name of the Auto Scaling group.
String instanceRefreshId
The instance refresh ID associated with the request. This is the unique ID assigned to the instance refresh when it was started.
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 property 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.
DesiredConfiguration desiredConfiguration
The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.
Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.
When you specify a new launch template or a new version of the current launch template for your desired
configuration, consider enabling the SkipMatching property in preferences. If it's enabled, Amazon
EC2 Auto Scaling skips replacing instances that already use the specified launch template and instance types.
This can help you reduce the number of replacements that are required to apply updates.
RefreshPreferences preferences
Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the
instance warmup time, the minimum and maximum healthy percentages, and the behaviors that you want Amazon EC2
Auto Scaling to use if instances that are in Standby state or protected from scale in are found. You
can also choose to enable additional features, such as the following:
Auto rollback
Checkpoints
CloudWatch alarms
Skip matching
String instanceRefreshId
A unique ID for tracking the progress of the instance refresh.
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. For exact capacity, you must specify a non-negative value.
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 property, 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.
Some metrics are based on a count instead of a percentage, such as the request count for an Application Load Balancer or the number of messages in an SQS queue. If the scaling policy specifies one of these metrics, specify the target utilization as the optimal average request or message count per instance during any one-minute interval.
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.
String id
A short name that identifies the object's results in the response. This name must be unique among all
TargetTrackingMetricDataQuery objects specified for a single scaling policy. If you are performing
math expressions on this set of data, this name represents that data and can serve as a variable in the
mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be
a lowercase letter.
String expression
The math expression to perform on the returned data, if this object is performing a math expression. This
expression can use the Id of the other metrics to refer to those metrics, and can also use the
Id of other expressions to use the result of those expressions.
Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either
Expression or MetricStat, but not both.
TargetTrackingMetricStat metricStat
Information about the metric data to return.
Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either
Expression or MetricStat, but not both.
String label
A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
Boolean returnData
Indicates whether to return the timestamps and raw data values of this metric.
If you use any math expressions, specify true for this value for only the final math expression that
the metric specification is based on. You must specify false for ReturnData for all the
other metrics and expressions used in the metric specification.
If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData. This sets it to its default (true).
Metric metric
The metric to use.
String stat
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metric for scaling is Average.
String unit
The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
Activity activity
A scaling activity.
String identifier
Identifies the traffic source.
For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.
For example:
Application Load Balancer ARN:
arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
Classic Load Balancer name: my-classic-load-balancer
VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
String type
Provides additional context for the value of Identifier.
The following lists the valid values:
elb if Identifier is the name of a Classic Load Balancer.
elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer,
or Network Load Balancer target group.
vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
String trafficSource
This is replaced by Identifier.
String state
Describes the current state of a traffic source.
The state values are as follows:
Adding - The Auto Scaling instances are being registered with the load balancer or target group.
Added - All Auto Scaling instances are registered with the load balancer or target group.
InService - For an Elastic Load Balancing load balancer or target group, at least one Auto Scaling
instance passed an ELB health check. For VPC Lattice, at least one Auto Scaling instance passed an
VPC_LATTICE health check.
Removing - The Auto Scaling instances are being deregistered from the load balancer or target group.
If connection draining (deregistration delay) is enabled, Elastic Load Balancing or VPC Lattice waits for
in-flight requests to complete before deregistering the instances.
Removed - All Auto Scaling instances are deregistered from the load balancer or target group.
String identifier
The unique identifier of the traffic source.
String type
Provides additional context for the value of Identifier.
The following lists the valid values:
elb if Identifier is the name of a Classic Load Balancer.
elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer,
or Network Load Balancer target group.
vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
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
The mixed instances policy. 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
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. 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
A comma-separated value string of one or more health check types.
The valid values are EC2, ELB, and VPC_LATTICE. EC2 is the
default health check and cannot be disabled. For more information, see Health checks for Auto Scaling
instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously set.
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 and marking it unhealthy due to a failed health check. This is useful if your
instances do not immediately pass their health checks after they enter the InService state. For more
information, see Set the health check
grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
String placementGroup
The name of an existing placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
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 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 Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour |
NewestInstance | OldestInstance | OldestLaunchConfiguration |
OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
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 Using 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 Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.
String context
Reserved.
String desiredCapacityType
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityType for attribute-based instance type selection only. For more information, see Creating
an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User
Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of instances.
Valid values: units | vcpu | memory-mib
Integer defaultInstanceWarmup
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource
consumption to become stable after it enters the InService state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup,
even if it is set to 0 seconds. To remove a value that you previously set, include the property but
specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled
by specifying a value of 0 or other nominal value.
InstanceMaintenancePolicy instanceMaintenancePolicy
An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
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.
InstanceReusePolicy instanceReusePolicy
The instance reuse policy.
Copyright © 2024. All rights reserved.