Package software.amazon.awscdk.services.autoscaling

Interface RollingUpdateConfiguration

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
RollingUpdateConfiguration.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.402Z") @Stability(Deprecated) @Deprecated public interface RollingUpdateConfiguration extends software.amazon.jsii.JsiiSerializable
Deprecated.
use UpdatePolicy.rollingUpdate()
(deprecated) Additional settings when a rolling update is selected.

Example: 

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

  • Method Details

    • getMaxBatchSize

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

      Default: 1

    • getMinInstancesInService

      @Stability(Deprecated) @Deprecated @Nullable default Number getMinInstancesInService()
      Deprecated.
      (deprecated) 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

    • getMinSuccessfulInstancesPercent

      @Stability(Deprecated) @Deprecated @Nullable default Number getMinSuccessfulInstancesPercent()
      Deprecated.
      (deprecated) The percentage of instances that must signal success for an update to succeed.

      If an instance doesn't send a signal within the time specified in the pauseTime property, AWS CloudFormation assumes that the instance wasn't updated.

      This number affects the success of the replacement.

      If you specify this property, you must also enable the waitOnResourceSignals and pauseTime properties.

      Default: 100

    • getPauseTime

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

      This is intended to give those instances time to start software applications.

      Specify PauseTime in the ISO8601 duration format (in the format PT#H#M#S, where each # is the number of hours, minutes, and seconds, respectively). The maximum PauseTime is one hour (PT1H).

      Default: Duration.minutes(5) if the waitOnResourceSignals property is true, otherwise 0

    • getSuspendProcesses

      @Stability(Deprecated) @Deprecated @Nullable default List<ScalingProcess> getSuspendProcesses()
      Deprecated.
      (deprecated) 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(Deprecated) @Deprecated @Nullable default Boolean getWaitOnResourceSignals()
      Deprecated.
      (deprecated) Specifies whether the Auto Scaling group waits on signals from new instances during an update.

      AWS CloudFormation must receive a signal from each new instance within the specified PauseTime before continuing the update.

      To have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling rolling updates sample template.

      Default: true if you specified the minSuccessfulInstancesPercent property, false otherwise

    • builder

      @Stability(Deprecated) @Deprecated static RollingUpdateConfiguration.Builder builder()
      Deprecated.
      Returns:
      a RollingUpdateConfiguration.Builder of RollingUpdateConfiguration