interface CfnAutoScalingInstanceRefreshPreferences

Language	Type name
.NET	`Amazon.CDK.CfnAutoScalingInstanceRefreshPreferences`
Go	`github.com/aws/aws-cdk-go/awscdk/v2#CfnAutoScalingInstanceRefreshPreferences`
Java	`software.amazon.awscdk.CfnAutoScalingInstanceRefreshPreferences`
Python	`aws_cdk.CfnAutoScalingInstanceRefreshPreferences`
TypeScript (source)	`aws-cdk-lib` » `CfnAutoScalingInstanceRefreshPreferences`

Preferences for the AutoScalingInstanceRefresh update policy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnAutoScalingInstanceRefreshPreferences: cdk.CfnAutoScalingInstanceRefreshPreferences = {
  alarmSpecification: {
    alarms: ['alarms'],
  },
  bakeTime: 123,
  checkpointDelay: 123,
  checkpointPercentages: [123],
  instanceWarmup: 123,
  maxHealthyPercentage: 123,
  minHealthyPercentage: 123,
  scaleInProtectedInstances: 'scaleInProtectedInstances',
  skipMatching: false,
  standbyInstances: 'standbyInstances',
};

Properties

Name	Type	Description
alarmSpecification?	`CfnAutoScalingInstanceRefreshAlarmSpecification`	The CloudWatch alarms to monitor during the instance refresh.
bakeTime?	`number`	The number of seconds after an instance refresh completes successfully before CloudFormation considers the update successful.
checkpointDelay?	`number`	The number of seconds to wait after a checkpoint is reached before continuing.
checkpointPercentages?	`number[]`	Threshold values for each checkpoint in ascending order.
instanceWarmup?	`number`	The number of seconds to wait after a new instance enters the InService state before moving on to replacing the next instance.
maxHealthyPercentage?	`number`	The maximum percentage of the group that can be in service and healthy, or pending, to support your workload during the instance refresh.
minHealthyPercentage?	`number`	The minimum percentage of the group to keep in service, healthy, and ready to use to support your workload during the instance refresh.
scaleInProtectedInstances?	`string`	Specifies the behavior of instances that are protected from scale in during an instance refresh.
skipMatching?	`boolean`	Indicates whether skip matching is enabled.
standbyInstances?	`string`	Specifies the behavior of instances in standby during an instance refresh.

alarmSpecification?

Type: CfnAutoScalingInstanceRefreshAlarmSpecification (optional)

The CloudWatch alarms to monitor during the instance refresh.

If any alarm goes into ALARM state, the instance refresh fails.

bakeTime?

Type: number (optional, default: 0)

The number of seconds after an instance refresh completes successfully before CloudFormation considers the update successful.

checkpointDelay?

Type: number (optional, default: 3600 seconds (1 hour), applied only when checkpointPercentages is set)

The number of seconds to wait after a checkpoint is reached before continuing.

checkpointPercentages?

Type: number[] (optional, default: no checkpoints)

Threshold values for each checkpoint in ascending order.

Each number is a percentage of the total number of instances in the group. When the percentage of instances that have been replaced reaches a checkpoint, the refresh waits for the configured checkpoint delay before continuing.

instanceWarmup?

Type: number (optional, default: the group's DefaultInstanceWarmup if defined; otherwise the group's HealthCheckGracePeriod)

The number of seconds to wait after a new instance enters the InService state before moving on to replacing the next instance.

maxHealthyPercentage?

Type: number (optional, default: the value set in the Auto Scaling group's instance maintenance policy, if defined; otherwise 110 when the strategy is Rolling, or 100 when the strategy is ReplaceRootVolume)

The maximum percentage of the group that can be in service and healthy, or pending, to support your workload during the instance refresh.

Used to control batch size.

minHealthyPercentage?

Type: number (optional, default: the value set in the Auto Scaling group's instance maintenance policy, if defined; otherwise 100 when the strategy is Rolling, or 90 when the strategy is ReplaceRootVolume)

The minimum percentage of the group to keep in service, healthy, and ready to use to support your workload during the instance refresh.

scaleInProtectedInstances?

Type: string (optional, default: 'Wait')

Specifies the behavior of instances that are protected from scale in during an instance refresh.

skipMatching?

Type: boolean (optional, default: true)

Indicates whether skip matching is enabled.

If true, instances that already match the desired configuration are not replaced.

standbyInstances?