Package software.amazon.awscdk.services.autoscaling

Class UpdatePolicy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.autoscaling.UpdatePolicy
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-08-13T16:20:00.193Z") @Stability(Stable) public abstract class UpdatePolicy extends software.amazon.jsii.JsiiObject
How existing instances should be updated.

Example: 

 Vpc vpc;
 InstanceType instanceType;
 IMachineImage machineImage;
 Alarm alarm;
 AutoScalingGroup.Builder.create(this, "ASG")
         .vpc(vpc)
         .instanceType(instanceType)
         .machineImage(machineImage)
         .updatePolicy(UpdatePolicy.instanceRefresh(InstanceRefreshOptions.builder()
                 .strategy(InstanceRefreshStrategy.ROLLING)
                 .minHealthyPercentage(90)
                 .maxHealthyPercentage(100)
                 .instanceWarmup(Duration.seconds(300))
                 .checkpointPercentages(List.of(50, 100))
                 .checkpointDelay(Duration.minutes(10))
                 .alarms(List.of(alarm))
                 .build()))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    UpdatePolicy()
     
    protected
    UpdatePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    UpdatePolicy(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static UpdatePolicy
    instanceRefresh(InstanceRefreshOptions options)
    Use instance refresh to update the instances in the AutoScalingGroup.
    static UpdatePolicy
    replacingUpdate()
    Create a new AutoScalingGroup and switch over to it.
    static UpdatePolicy
    rollingUpdate()
    Replace the instances in the AutoScalingGroup one by one, or in batches.
    static UpdatePolicy
    rollingUpdate(RollingUpdateOptions options)
    Replace the instances in the AutoScalingGroup one by one, or in batches.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • UpdatePolicy

      protected UpdatePolicy(software.amazon.jsii.JsiiObjectRef objRef)

    • UpdatePolicy

      protected UpdatePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • UpdatePolicy

      @Stability(Stable) protected UpdatePolicy()

  • Method Details

    • instanceRefresh

      @Stability(Stable) @NotNull public static UpdatePolicy instanceRefresh(@NotNull InstanceRefreshOptions options)
      Use instance refresh to update the instances in the AutoScalingGroup.

      When properties that trigger an instance refresh change (such as LaunchTemplate or MixedInstancesPolicy), CloudFormation starts an instance refresh to replace instances gradually while maintaining availability.

      Parameters:
      options - This parameter is required.

    • replacingUpdate

      @Stability(Stable) @NotNull public static UpdatePolicy replacingUpdate()
      Create a new AutoScalingGroup and switch over to it.

    • rollingUpdate

      @Stability(Stable) @NotNull public static UpdatePolicy rollingUpdate(@Nullable RollingUpdateOptions options)
      Replace the instances in the AutoScalingGroup one by one, or in batches.

      Parameters:
      options -

    • rollingUpdate

      @Stability(Stable) @NotNull public static UpdatePolicy rollingUpdate()
      Replace the instances in the AutoScalingGroup one by one, or in batches.