Package software.amazon.awscdk.services.autoscaling

Interface RollingUpdateOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
RollingUpdateOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)", date="2025-01-25T00:20:51.223Z") @Stability(Stable) public interface RollingUpdateOptions extends software.amazon.jsii.JsiiSerializable
Options for customizing the rolling update.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.autoscaling.*;
 RollingUpdateOptions rollingUpdateOptions = RollingUpdateOptions.builder()
         .maxBatchSize(123)
         .minInstancesInService(123)
         .minSuccessPercentage(123)
         .pauseTime(Duration.minutes(30))
         .suspendProcesses(List.of(ScalingProcess.LAUNCH))
         .waitOnResourceSignals(false)
         .build();

  • Method Details

    • getMaxBatchSize

      @Stability(Stable) @Nullable default Number getMaxBatchSize()
      The maximum number of instances that AWS CloudFormation updates at once.

      This number affects the speed of the replacement.

      Default: 1

    • getMinInstancesInService

      @Stability(Stable) @Nullable default Number getMinInstancesInService()
      The minimum number of instances that must be in service before more instances are replaced.

      This number affects the speed of the replacement.

      Default: 0

    • getMinSuccessPercentage

      @Stability(Stable) @Nullable default Number getMinSuccessPercentage()
      The percentage of instances that must signal success for the update to succeed.

      Default: - The `minSuccessPercentage` configured for `signals` on the AutoScalingGroup

    • getPauseTime

      @Stability(Stable) @Nullable default Duration getPauseTime()
      The pause time after making a change to a batch of instances.

      Default: - The `timeout` configured for `signals` on the AutoScalingGroup

    • getSuspendProcesses

      @Stability(Stable) @Nullable default List<ScalingProcess> getSuspendProcesses()
      Specifies the Auto Scaling processes to suspend during a stack update.

      Suspending processes prevents Auto Scaling from interfering with a stack update.

      Default: HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions.

    • getWaitOnResourceSignals

      @Stability(Stable) @Nullable default Boolean getWaitOnResourceSignals()
      Specifies whether the Auto Scaling group waits on signals from new instances during an update.

      Default: true if you configured `signals` on the AutoScalingGroup, false otherwise

    • builder

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