Package software.amazon.awscdk

Interface CfnAutoScalingInstanceRefreshPreferences

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnAutoScalingInstanceRefreshPreferences.Jsii$Proxy
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-07-31T10:49:21.581Z") @Stability(Stable) public interface CfnAutoScalingInstanceRefreshPreferences extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.*;
 CfnAutoScalingInstanceRefreshPreferences cfnAutoScalingInstanceRefreshPreferences = CfnAutoScalingInstanceRefreshPreferences.builder()
         .alarmSpecification(CfnAutoScalingInstanceRefreshAlarmSpecification.builder()
                 .alarms(List.of("alarms"))
                 .build())
         .bakeTime(123)
         .checkpointDelay(123)
         .checkpointPercentages(List.of(123))
         .instanceWarmup(123)
         .maxHealthyPercentage(123)
         .minHealthyPercentage(123)
         .scaleInProtectedInstances("scaleInProtectedInstances")
         .skipMatching(false)
         .standbyInstances("standbyInstances")
         .build();

  • Method Details

    • getAlarmSpecification

      @Stability(Stable) @Nullable default CfnAutoScalingInstanceRefreshAlarmSpecification getAlarmSpecification()
      The CloudWatch alarms to monitor during the instance refresh.

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

    • getBakeTime

      @Stability(Stable) @Nullable default Number getBakeTime()
      The number of seconds after an instance refresh completes successfully before CloudFormation considers the update successful.

      Default: 0

    • getCheckpointDelay

      @Stability(Stable) @Nullable default Number getCheckpointDelay()
      The number of seconds to wait after a checkpoint is reached before continuing.

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

    • getCheckpointPercentages

      @Stability(Stable) @Nullable default List<Number> getCheckpointPercentages()
      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.

      Default: - no checkpoints

    • getInstanceWarmup

      @Stability(Stable) @Nullable default Number getInstanceWarmup()
      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

    • getMaxHealthyPercentage

      @Stability(Stable) @Nullable default Number getMaxHealthyPercentage()
      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.

      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

    • getMinHealthyPercentage

      @Stability(Stable) @Nullable default Number getMinHealthyPercentage()
      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

    • getScaleInProtectedInstances

      @Stability(Stable) @Nullable default String getScaleInProtectedInstances()
      Specifies the behavior of instances that are protected from scale in during an instance refresh.

      Default: 'Wait'

    • getSkipMatching

      @Stability(Stable) @Nullable default Boolean getSkipMatching()
      Indicates whether skip matching is enabled.

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

      Default: true

    • getStandbyInstances

      @Stability(Stable) @Nullable default String getStandbyInstances()
      Specifies the behavior of instances in standby during an instance refresh.

      Default: 'Wait'

    • builder

      @Stability(Stable) static CfnAutoScalingInstanceRefreshPreferences.Builder builder()
      Returns:
      a CfnAutoScalingInstanceRefreshPreferences.Builder of CfnAutoScalingInstanceRefreshPreferences