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 adjustmentType
The policy adjustment type. The valid values are ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to 20 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> loadBalancerNames
The names of the load balancers. You can specify up to 10 load balancers.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> targetGroupARNs
The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
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 defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
SdkInternalList<T> availabilityZones
One or more Availability Zones for the group.
SdkInternalList<T> loadBalancerNames
One or more load balancers associated with the group.
SdkInternalList<T> targetGroupARNs
The Amazon Resource Names (ARN) of the target groups for your load balancer.
String healthCheckType
The service to use for the health checks. The valid values are EC2
and ELB
. If you
configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either
the EC2 status checks or the load balancer health checks.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
SdkInternalList<T> instances
The EC2 instances associated with the group.
Date createdTime
The date and time the group was created.
SdkInternalList<T> suspendedProcesses
The suspended processes associated with the group.
String placementGroup
The name of the placement group into which to launch your instances, if any.
String vPCZoneIdentifier
One or more subnet IDs, if applicable, separated by commas.
SdkInternalList<T> enabledMetrics
The metrics enabled for the group.
String status
The current state of the group when DeleteAutoScalingGroup 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 AWS services on your behalf.
String instanceId
The ID of the 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.
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 autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scheduledActionNames
The names of the scheduled actions to delete. The maximum number allowed is 50.
SdkInternalList<T> failedScheduledActions
The names of the scheduled actions that could not be deleted, including an error message.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scheduledUpdateGroupActions
One or more scheduled actions. The maximum number allowed is 50.
SdkInternalList<T> failedScheduledUpdateGroupActions
The names of the scheduled actions that could not be created or updated, including an error message.
String virtualName
The name of the virtual device (for example, ephemeral0
).
String deviceName
The device name exposed to the EC2 instance (for example, /dev/sdh
or xvdh
). For more
information, see Device Naming
on Linux Instances in the Amazon EC2 User Guide for Linux Instances.
Ebs ebs
The information about the Amazon EBS volume.
Boolean noDevice
Suppresses a device mapping.
If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group.
String lifecycleActionToken
A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
String lifecycleActionResult
The action for the group to take. This parameter can be either CONTINUE
or ABANDON
.
String instanceId
The ID of the instance.
String autoScalingGroupName
The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.
String launchConfigurationName
The name of the launch configuration. This parameter, a launch template, a mixed instances policy, or an EC2 instance must be specified.
For more information, see Creating an Auto Scaling Group Using a Launch Configuration in the Amazon EC2 Auto Scaling User Guide.
LaunchTemplateSpecification launchTemplate
The launch template to use to launch instances. This parameter, a launch configuration, a mixed instances policy, or an EC2 instance must be specified.
For more information, see Creating an Auto Scaling Group Using a Launch Template in the Amazon EC2 Auto Scaling User Guide.
MixedInstancesPolicy mixedInstancesPolicy
The mixed instances policy to use to launch instances. This parameter, a launch template, a launch configuration, or an EC2 instance must be specified.
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 create a launch configuration for the group. This parameter, a launch configuration, a launch template, or a mixed instances policy must be specified.
When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.
For more information, see Create 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.
Integer desiredCapacity
The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.
Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The
default value is 300
.
For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> availabilityZones
One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for
VPCZoneIdentifier
.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
SdkInternalList<T> loadBalancerNames
One or more Classic Load Balancers. To specify an Application Load Balancer or a Network Load Balancer, use
TargetGroupARNs
instead.
For more information, see Using a Load Balancer With an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> targetGroupARNs
The Amazon Resource Names (ARN) of the target groups.
String healthCheckType
The service to use for the health checks. The valid values are EC2
and ELB
. The default
value is EC2
. If you configure an Auto Scaling group to use ELB health checks, it considers the
instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2
instance that has come into service. During this time, any health check failures for the instance are ignored.
The default value is 0
.
For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
Conditional: This parameter is required if you are adding an ELB
health check.
String placementGroup
The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
String vPCZoneIdentifier
A comma-separated list of subnet IDs for your virtual private cloud (VPC).
If you specify VPCZoneIdentifier
with AvailabilityZones
, the subnets that you specify
for this parameter must reside in those Availability Zones.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
SdkInternalList<T> terminationPolicies
One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.
For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> lifecycleHookSpecificationList
One or more lifecycle hooks.
SdkInternalList<T> tags
One or more tags.
For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
String serviceLinkedRoleARN
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
String launchConfigurationName
The name of the launch configuration. This name must be unique within the scope of your AWS account.
String imageId
The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
If you do not specify InstanceId
, you must specify ImageId
.
For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
String keyName
The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
SdkInternalList<T> securityGroups
One or more security groups with which to associate the instances.
If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.
If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
String classicLinkVPCId
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> classicLinkVPCSecurityGroups
The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise.
String userData
The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.
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.
If you do not specify InstanceId
, you must specify both ImageId
and
InstanceType
.
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 Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.
String instanceType
The instance type of the EC2 instance.
If you do not specify InstanceId
, you must specify InstanceType
.
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
One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
InstanceMonitoring instanceMonitoring
Enables detailed monitoring (true
) or basic monitoring (false
) for the Auto Scaling
instances. The default value is true
.
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 market price. For more information, see Launching Spot Instances in Your Auto Scaling Group 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.
EC2 instances launched with an IAM role automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Use an IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.
Boolean ebsOptimized
Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. 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 usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.
Boolean associatePublicIpAddress
Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this parameter, be sure to specify at least one subnet when you create your group.
Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.
String placementTenancy
The tenancy of the instance. An instance with a tenancy of dedicated
runs on single-tenant hardware
and can only be launched into a VPC.
To launch Dedicated Instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set
to default
), you must set the value of this parameter to dedicated
.
If you specify this parameter, be sure to specify at least one subnet when you create your group.
For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
Valid values: default
| dedicated
SdkInternalList<T> tags
One or more tags.
String metricName
The name of the metric.
String namespace
The namespace of the metric.
SdkInternalList<T> dimensions
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
String statistic
The statistic of the metric.
String unit
The unit of the metric.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean forceDelete
Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.
String launchConfigurationName
The name of the launch configuration.
SdkInternalList<T> tags
One or more tags.
Integer maxNumberOfAutoScalingGroups
The maximum number of groups allowed for your AWS account. The default limit is 200 per region.
Integer maxNumberOfLaunchConfigurations
The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per region.
Integer numberOfAutoScalingGroups
The current number of groups for your AWS account.
Integer numberOfLaunchConfigurations
The current number of launch configurations for your AWS account.
SdkInternalList<T> adjustmentTypes
The policy adjustment types.
SdkInternalList<T> autoScalingGroupNames
The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only
specify up to 50 names. You can optionally increase this limit using the MaxRecords
parameter.
If you omit this parameter, all Auto Scaling groups are described.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50
and the maximum value
is 100
.
SdkInternalList<T> autoScalingGroups
The groups.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken
value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to MaxRecords
IDs. If you omit this parameter, all Auto
Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.
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.
SdkInternalList<T> launchConfigurationNames
The launch configuration names. If you omit this parameter, all launch configurations 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> launchConfigurations
The launch configurations.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken
value when requesting the next set
of items. This value is null when there are no more items to return.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> lifecycleHookNames
The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.
SdkInternalList<T> lifecycleHooks
The lifecycle hooks for the specified group.
SdkInternalList<T> lifecycleHookTypes
The lifecycle hook types.
String autoScalingGroupName
The name of the Auto Scaling group.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 100
and the maximum value
is 100
.
SdkInternalList<T> loadBalancers
The load balancers.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken
value when requesting the next set
of items. This value is null when there are no more items to return.
String autoScalingGroupName
The name of the Auto Scaling group.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 100
and the maximum value
is 100
.
SdkInternalList<T> loadBalancerTargetGroups
Information about the target groups.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken
value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> metrics
One or more metrics.
SdkInternalList<T> granularities
The granularities for the metrics.
SdkInternalList<T> autoScalingGroupNames
The name of the Auto Scaling group.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50
and the maximum value
is 100
.
SdkInternalList<T> notificationConfigurations
The notification configurations.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken
value when requesting the next set
of items. This value is null when there are no more items to return.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> policyNames
The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.
SdkInternalList<T> policyTypes
One or more policy types. The valid values are SimpleScaling
, StepScaling
, and
TargetTrackingScaling
.
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. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
String autoScalingGroupName
The name of the Auto Scaling group.
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. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
Date startTime
The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
Date endTime
The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50
and the maximum value
is 100
.
SdkInternalList<T> scheduledUpdateGroupActions
The scheduled actions.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken
value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> filters
One or more filters to scope the tags to return. The maximum number of filters per filter type (for example,
auto-scaling-group
) is 1000.
String nextToken
The token for the next set of items to return. (You received this token from a previous call.)
Integer maxRecords
The maximum number of items to return with this call. The default value is 50
and the maximum value
is 100
.
SdkInternalList<T> tags
One or more tags.
String nextToken
A string that indicates that the response contains more items than can be returned in a single response. To
receive additional items, specify this string for the NextToken
value when requesting the next set
of items. This value is null when there are no more items to return.
SdkInternalList<T> terminationPolicyTypes
The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance
,
OldestLaunchConfiguration
, NewestInstance
, ClosestToNextInstanceHour
,
Default
, OldestLaunchTemplate
, and AllocationStrategy
.
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to 20 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean shouldDecrementDesiredCapacity
Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.
SdkInternalList<T> activities
The activities related to detaching the instances from the Auto Scaling group.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> loadBalancerNames
The names of the load balancers. You can specify up to 10 load balancers.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> targetGroupARNs
The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> metrics
One or more of the following metrics. If you omit this parameter, all metrics are disabled.
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
String snapshotId
The ID of the snapshot. This parameter is optional if you specify a volume size.
Integer volumeSize
The volume size, in GiB.
Constraints: 1-1,024 for standard
, 4-16,384 for io1
, 1-16,384 for gp2
, and
500-16,384 for st1
and sc1
. If you specify a snapshot, the volume size must be equal to
or larger than the snapshot size.
Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.
At least one of VolumeSize or SnapshotId is required.
String volumeType
The volume type, which can be standard
for Magnetic, io1
for Provisioned IOPS SSD,
gp2
for General Purpose SSD, st1
for Throughput Optimized HDD, or sc1
for
Cold HDD. For more information, see Amazon EBS Volume Types in the
Amazon EC2 User Guide for Linux Instances.
Valid values: standard
| io1
| gp2
| st1
| sc1
Boolean deleteOnTermination
Indicates whether the volume is deleted on instance termination. The default value is true
.
Integer iops
The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.
Conditional: This parameter is required 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 must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.
String metric
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
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
One or more of the following metrics. If you omit this parameter, all metrics are enabled.
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
String granularity
The granularity to associate with the metrics to collect. The only valid value is 1Minute
.
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to 20 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
Boolean shouldDecrementDesiredCapacity
Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to
Standby
mode.
SdkInternalList<T> activities
The activities related to moving instances into Standby
mode.
String autoScalingGroupName
The name of the Auto Scaling group.
String policyName
The name or ARN of the policy.
Boolean honorCooldown
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.
This parameter is not supported if the policy type is StepScaling
.
For more information, see Scaling Cooldowns 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.
Conditional: This parameter is required if the policy type is StepScaling
and not supported
otherwise.
Double breachThreshold
The breach threshold for the alarm.
Conditional: This parameter is required if the policy type is StepScaling
and not supported
otherwise.
SdkInternalList<T> instanceIds
The IDs of the instances. You can specify up to 20 instances.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> activities
The activities related to moving instances out of Standby
mode.
String name
The name of the filter. The valid values are: "auto-scaling-group"
, "key"
,
"value"
, and "propagate-at-launch"
.
SdkInternalList<T> values
The value of the filter.
String instanceId
The ID of the 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.
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.
Boolean enabled
If true
, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
String onDemandAllocationStrategy
Indicates how to allocate instance types to fulfill On-Demand capacity.
The only valid value is prioritized
, which is also the default value. This strategy uses the order
of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The
first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be
fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity
using the second priority instance type, and so on.
Integer onDemandBaseCapacity
The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.
The default value is 0
. If you leave this parameter set to 0
, On-Demand Instances are
launched as a percentage of the Auto Scaling group's desired capacity, per the
OnDemandPercentageAboveBaseCapacity
setting.
Integer onDemandPercentageAboveBaseCapacity
Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond
OnDemandBaseCapacity
.
The range is 0–100. The default value is 100
. If you leave this parameter set to 100
,
the percentages are 100% for On-Demand Instances and 0% for Spot Instances.
String spotAllocationStrategy
Indicates how to allocate Spot capacity across Spot pools.
The only valid value is lowest-price
, which is also the default value. The Auto Scaling group
selects the cheapest Spot pools and evenly allocates your Spot capacity across the number of Spot pools that you
specify.
Integer spotInstancePools
The number of Spot pools to use to allocate your Spot capacity. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate.
The range is 1–20 and the default is 2.
String spotMaxPrice
The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.
To remove a value that you previously set, include the parameter but leave the value blank.
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).
String keyName
The name of the key pair.
SdkInternalList<T> securityGroups
The security groups to associate with the instances.
String classicLinkVPCId
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> classicLinkVPCSecurityGroups
The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId
. For more
information, see ClassicLink in the Amazon
EC2 User Guide for Linux Instances and Linking EC2-Classic
Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise.
String userData
The user data available to the instances.
String instanceType
The instance type for the instances.
String kernelId
The ID of the kernel associated with the AMI.
String ramdiskId
The ID of the RAM disk associated with the AMI.
SdkInternalList<T> blockDeviceMappings
A block device mapping, which specifies the block devices for the instance.
InstanceMonitoring instanceMonitoring
Controls whether instances in this group are launched with detailed (true
) or basic (
false
) monitoring.
String spotPrice
The price to bid when launching Spot Instances.
String iamInstanceProfile
The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
Date createdTime
The creation date and time for the launch configuration.
Boolean ebsOptimized
Controls whether the instance is optimized for EBS I/O (true
) or not (false
).
Boolean associatePublicIpAddress
[EC2-VPC] Indicates whether to assign a public IP address to each instance.
String placementTenancy
The tenancy of the instance, either default
or dedicated
. An instance with
dedicated
tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.
LaunchTemplateSpecification launchTemplateSpecification
The launch template to use. You must specify either the launch template ID or launch template name in the request.
SdkInternalList<T> overrides
Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type.
You must specify between 2 and 20 overrides.
String instanceType
The instance type.
For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
String launchTemplateId
The ID of the launch template. You must specify either a template ID or a template name.
String launchTemplateName
The name of the launch template. You must specify either a template name or a template ID.
String version
The version number, $Latest
, or $Default
. If the value is $Latest
, Amazon
EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is
$Default
, Amazon EC2 Auto Scaling selects the default version of the launch template when launching
instances. The default value is $Default
.
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group for the lifecycle hook.
String lifecycleTransition
The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
String notificationTargetARN
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
String notificationMetadata
Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
Integer heartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times
out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult
parameter.
Integer globalTimeout
The maximum time, in seconds, that an instance can remain in a Pending:Wait
or
Terminating:Wait
state. The maximum is 172800 seconds (48 hours) or 100 times
HeartbeatTimeout
, whichever is smaller.
String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected
failure occurs. The possible values are CONTINUE
and ABANDON
.
String lifecycleHookName
The name of the lifecycle hook.
String lifecycleTransition
The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
String notificationMetadata
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
Integer heartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out.
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the
DefaultResult
parameter. You can prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat.
String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected
failure occurs. The valid values are CONTINUE
and ABANDON
. The default value is
ABANDON
.
String notificationTargetARN
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
String loadBalancerName
The name of the load balancer.
String state
One of the following load balancer states:
Adding
- The instances in the group are being registered with the load balancer.
Added
- All instances in the group are registered with the load balancer.
InService
- At least one instance in the group passed an ELB health check.
Removing
- The instances in the group 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 instances in the group 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.
String metric
One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
String granularity
The granularity. The only valid value is 1Minute
.
LaunchTemplate launchTemplate
The launch template and overrides.
This parameter is required when creating an Auto Scaling group with a mixed instances policy, but is not required when updating the group.
InstancesDistribution instancesDistribution
The instances distribution to use.
If you leave this parameter unspecified when creating the group, the default values are used.
String autoScalingGroupName
The name of the Auto Scaling group.
String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
String notificationType
One of the following event notification types:
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
String predefinedMetricType
The metric type.
String resourceLabel
Identifies the resource associated with the metric type. The following predefined metrics are available:
ASGAverageCPUUtilization
- Average CPU utilization of the Auto Scaling group.
ASGAverageNetworkIn
- Average number of bytes received on all network interfaces by the Auto Scaling
group.
ASGAverageNetworkOut
- Average number of bytes sent out on all network interfaces by the Auto
Scaling group.
ALBRequestCountPerTarget
- Number of requests completed per target in an Application Load Balancer
or a Network Load Balancer target group.
For predefined metric types ASGAverageCPUUtilization
, ASGAverageNetworkIn
, and
ASGAverageNetworkOut
, the parameter must not be specified as the resource associated with the metric
type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget
, the parameter
must be specified in the format:
app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id
, where app/load-balancer-name/load-balancer-id
is the final portion of the load
balancer ARN, and targetgroup/target-group-name/target-group-id
is the final portion
of the target group ARN. The target group must be attached to the Auto Scaling group.
String processName
One of the following processes:
Launch
Terminate
AddToLoadBalancer
AlarmNotification
AZRebalance
HealthCheck
ReplaceUnhealthy
ScheduledActions
String lifecycleHookName
The name of the lifecycle hook.
String autoScalingGroupName
The name of the Auto Scaling group.
String lifecycleTransition
The instance state to which you want to attach the lifecycle hook. The valid values are:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
String roleARN
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
String notificationTargetARN
The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.
If you specify an empty string, this overrides the current ARN.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain
the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION"
.
String notificationMetadata
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
Integer heartbeatTimeout
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30
to 7200
seconds. The default value is 3600
seconds (1 hour).
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the
DefaultResult
parameter. You can prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat.
String defaultResult
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected
failure occurs. This parameter can be either CONTINUE
or ABANDON
. The default value is
ABANDON
.
String autoScalingGroupName
The name of the Auto Scaling group.
String topicARN
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
SdkInternalList<T> notificationTypes
The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes.
String autoScalingGroupName
The name of the Auto Scaling group.
String policyName
The name of the policy.
String policyType
The policy type. The valid values are SimpleScaling
, StepScaling
, and
TargetTrackingScaling
. If the policy type is null, the value is treated as
SimpleScaling
.
String adjustmentType
The adjustment type. The valid values are ChangeInCapacity
, ExactCapacity
, and
PercentChangeInCapacity
.
This parameter is supported if the policy type is SimpleScaling
or StepScaling
.
For more information, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.
Integer minAdjustmentStep
Available for backward compatibility. Use MinAdjustmentMagnitude
instead.
Integer minAdjustmentMagnitude
The minimum number of instances to scale. If the value of AdjustmentType
is
PercentChangeInCapacity
, the scaling policy changes the DesiredCapacity
of the Auto
Scaling group by at least this many instances. Otherwise, the error is ValidationError
.
This parameter is supported if the policy type is SimpleScaling
or StepScaling
.
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.
Conditional: This parameter is required if the policy type is SimpleScaling
and not supported
otherwise.
Integer cooldown
The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.
This parameter is supported if the policy type is SimpleScaling
.
For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
String metricAggregationType
The aggregation type for the CloudWatch metrics. The valid values are Minimum
, Maximum
,
and Average
. If the aggregation type is null, the value is treated as Average
.
This parameter is supported 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.
Conditional: This parameter is required if the policy type is StepScaling
and not supported
otherwise.
Integer estimatedInstanceWarmup
The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.
This parameter is supported if the policy type is StepScaling
or TargetTrackingScaling
.
TargetTrackingConfiguration targetTrackingConfiguration
A target tracking scaling policy. Includes support for predefined or customized metrics.
Conditional: This parameter is required if the policy type is TargetTrackingScaling
and not
supported otherwise.
String policyARN
The Amazon Resource Name (ARN) of the policy.
SdkInternalList<T> alarms
The CloudWatch alarms created for the target tracking scaling policy.
String autoScalingGroupName
The name of the Auto Scaling group.
String scheduledActionName
The name of this scaling action.
Date time
This parameter is deprecated.
Date startTime
The time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example,
"2019-06-01T00:00:00Z"
).
If you specify Recurrence
and StartTime
, Amazon EC2 Auto Scaling performs the action at
this time, and then performs the action based on the specified recurrence.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
Date endTime
The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
String recurrence
The recurring schedule for this 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.
Integer minSize
The minimum size for the Auto Scaling group.
Integer maxSize
The maximum size for the Auto Scaling group.
Integer desiredCapacity
The number of EC2 instances that should be running in the group.
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.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scalingProcesses
One or more of the following processes. If you omit this parameter, all processes are specified.
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
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
The policy type. The valid values are SimpleScaling
and StepScaling
.
String adjustmentType
The adjustment type, which specifies how ScalingAdjustment
is interpreted. The valid values are
ChangeInCapacity
, ExactCapacity
, and PercentChangeInCapacity
.
Integer minAdjustmentStep
Available for backward compatibility. Use MinAdjustmentMagnitude
instead.
Integer minAdjustmentMagnitude
The minimum number of instances to scale. If the value of AdjustmentType
is
PercentChangeInCapacity
, the scaling policy changes the DesiredCapacity
of the Auto
Scaling group by at least this many instances. Otherwise, the error is ValidationError
.
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 amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
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.
String autoScalingGroupName
The name of the Auto Scaling group.
String scheduledActionName
The name of the scheduled action.
String scheduledActionARN
The Amazon Resource Name (ARN) of the scheduled action.
Date time
This parameter is deprecated.
Date startTime
The date and time that the action is scheduled to begin.
When StartTime
and EndTime
are specified with Recurrence
, they form the
boundaries of when the recurring action starts and stops.
Date endTime
The date and time that the action is scheduled to end.
String recurrence
The recurring schedule for the action.
Integer minSize
The minimum size of the group.
Integer maxSize
The maximum size of the group.
Integer desiredCapacity
The number of instances you prefer to maintain in the group.
String scheduledActionName
The name of the scaling action.
Date startTime
The 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 time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
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.
Integer minSize
The minimum size of the group.
Integer maxSize
The maximum size of the group.
Integer desiredCapacity
The number of EC2 instances that should be running in the group.
String autoScalingGroupName
The name of the Auto Scaling group.
Integer desiredCapacity
The number of EC2 instances that should be running in the Auto Scaling group.
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.
SdkInternalList<T> instanceIds
One or more instance IDs.
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.
Double metricIntervalLowerBound
The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
Double metricIntervalUpperBound
The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
The upper bound must be greater than the lower bound.
Integer scalingAdjustment
The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
String autoScalingGroupName
The name of the Auto Scaling group.
SdkInternalList<T> scalingProcesses
One or more of the following processes. If you omit this parameter, all processes are specified.
Launch
Terminate
HealthCheck
ReplaceUnhealthy
AZRebalance
AlarmNotification
ScheduledActions
AddToLoadBalancer
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.
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 can specify either a predefined metric or a customized metric.
CustomizedMetricSpecification customizedMetricSpecification
A customized metric. You can specify either a predefined metric or a customized metric.
Double targetValue
The target value for the metric.
Boolean disableScaleIn
Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is disabled.
Activity activity
A scaling activity.
String autoScalingGroupName
The name of the Auto Scaling group.
String launchConfigurationName
The name of the launch configuration. If you specify this parameter, you can't specify a launch template or a mixed instances policy.
LaunchTemplateSpecification launchTemplate
The launch template and version to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a mixed instances policy.
MixedInstancesPolicy mixedInstancesPolicy
The mixed instances policy to use to specify the updates. If you specify this parameter, you can't specify a launch configuration or a launch template.
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.
Integer desiredCapacity
The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
Integer defaultCooldown
The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The
default value is 300
.
For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
SdkInternalList<T> availabilityZones
One or more Availability Zones for the group.
String healthCheckType
The service to use for the health checks. The valid values are EC2
and ELB
. If you
configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either
the EC2 status checks or the load balancer health checks.
Integer healthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2
instance that has come into service. The default value is 0
.
For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
Conditional: This parameter is required if you are adding an ELB
health check.
String placementGroup
The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
String vPCZoneIdentifier
A comma-separated list of subnet IDs, if you are launching into a VPC.
If you specify VPCZoneIdentifier
with AvailabilityZones
, the subnets that you specify
for this parameter must reside in those Availability Zones.
SdkInternalList<T> terminationPolicies
A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
Boolean newInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
For more information about preventing instances from terminating on scale in, see Instance 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 AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
Copyright © 2019. All rights reserved.