Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.
optional
MetricValue
double
The metric value compared to BreachThreshold.
optional
Output
Metadata, containing information related to the execution of the action.
Set desired capacity
Sets the size of the specified Auto Scaling group.
Inputs
Field
Type
Description
Required
Region
string
The region to use.
required
AutoScalingGroupName
string
The name of the Auto Scaling group.
required
DesiredCapacity
number
The desired capacity is the Auto Scaling group's initial capacity after this operation is completed and the capacity it attempts to maintain.
required
HonorCooldown
Boolean
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.
optional
Output
Metadata, containing information related to the execution of the action.
Start instance refresh
Starts an instance refresh.
Inputs
Field
Type
Description
Required
Region
string
The region to use.
required
AutoScalingGroupName
string
The name of the Auto Scaling group.
required
LaunchTemplateId
string
The ID of the launch template, can only be set if DesiredConfigurationType is set to LaunchTemplateId.
optional
DesiredConfiguration
string
The desired configuration in JSON format, can only be set if DesiredConfigurationType is set to Custom JSON value.
optional
Alarms
string or string array
The names of one or more CloudWatch alarms to monitor for the instance refresh.
optional
AutoRollback
boolean
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.
optional
CheckpointDelay
number
The amount of time, in seconds, to wait after a checkpoint before continuing.
optional
CheckpointPercentages
string or string array
Threshold values for each checkpoint in ascending order.
optional
InstanceWarmup
number
A time period, in seconds, during which an instance refresh waits before replacing the next instance after a new instance enters the InService state.
optional
MaxHealthyPercentage
number
It specifies the maximum percentage of the group that can be in service, healthy, or pending to support your workload when replacing instances.
optional
MinHealthyPercentage
number
It specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload and allow the operation to continue.
optional
ScaleInProtectedInstances
Enum
Choose the behavior you want Amazon EC2 Auto Scaling to use if instances protected from scale are found. Possible values: Ignore, Refresh, Wait.
optional
SkipMatching
Boolean
Indicates whether skip matching is enabled.
optional
StandbyInstances
Enum
If instances in the Standby state are found, choose the behavior you want Amazon EC2 Auto Scaling to use. Possible values: Ignore, Terminate, Wait.