Skip to content
v2.274.0

CfnAutoScalingInstanceRefreshPreferences Struct ​

Preferences for the AutoScalingInstanceRefresh update policy.

Example ​

ts
// 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 ​

The CloudWatch alarms to monitor during the instance refresh.

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

bakeTimeoptionalnumberbake_timeoptionalint | floatbakeTimeoptionalNumberBakeTimeoptionaldoubleBakeTimeoptional*float64= 0#
The number of seconds after an instance refresh completes successfully before CloudFormation considers the update successful.
checkpointDelayoptionalnumbercheckpoint_delayoptionalint | floatcheckpointDelayoptionalNumberCheckpointDelayoptionaldoubleCheckpointDelayoptional*float64#
The number of seconds to wait after a checkpoint is reached before continuing.

Default: 3600 seconds (1 hour), applied only when checkpointPercentages is set

checkpointPercentagesoptionalnumber[]checkpoint_percentagesoptionaltyping.List[int | float]checkpointPercentagesoptionalList<Number>CheckpointPercentagesoptionaldouble[]CheckpointPercentagesoptional*[]*float64#
Threshold values for each checkpoint in ascending order.

Default: no checkpoints

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.

instanceWarmupoptionalnumberinstance_warmupoptionalint | floatinstanceWarmupoptionalNumberInstanceWarmupoptionaldoubleInstanceWarmupoptional*float64#
The number of seconds to wait after a new instance enters the InService state before moving on to replacing the next instance.

Default: the group's DefaultInstanceWarmup if defined; otherwise the group's HealthCheckGracePeriod

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

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

Used to control batch size.

minHealthyPercentageoptionalnumbermin_healthy_percentageoptionalint | floatminHealthyPercentageoptionalNumberMinHealthyPercentageoptionaldoubleMinHealthyPercentageoptional*float64#
The minimum percentage of the group to keep in service, healthy, and ready to use to support your workload during the instance refresh.

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

scaleInProtectedInstancesoptionalstringscale_in_protected_instancesoptionalstrscaleInProtectedInstancesoptionalStringScaleInProtectedInstancesoptionalstringScaleInProtectedInstancesoptional*string= 'Wait'#
Specifies the behavior of instances that are protected from scale in during an instance refresh.
skipMatchingoptionalbooleanskip_matchingoptionalboolskipMatchingoptionalBooleanSkipMatchingoptionalboolSkipMatchingoptional*bool= true#
Indicates whether skip matching is enabled.

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

standbyInstancesoptionalstringstandby_instancesoptionalstrstandbyInstancesoptionalStringStandbyInstancesoptionalstringStandbyInstancesoptional*string= 'Wait'#
Specifies the behavior of instances in standby during an instance refresh.