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.58.0 (build f8ba112)",
           date="2022-05-11T19:24:25.175Z")
 @Stability(value=Experimental)
public interface RollingUpdateOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) 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.core.*;
 import software.amazon.awscdk.services.autoscaling.*;
 Duration duration;
 RollingUpdateOptions rollingUpdateOptions = RollingUpdateOptions.builder()
         .maxBatchSize(123)
         .minInstancesInService(123)
         .minSuccessPercentage(123)
         .pauseTime(duration)
         .suspendProcesses(List.of(ScalingProcess.LAUNCH))
         .waitOnResourceSignals(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RollingUpdateOptions.Builder A builder for RollingUpdateOptions
static class	RollingUpdateOptions.Jsii$Proxy An implementation for RollingUpdateOptions

Method Summary

Modifier and Type	Method and Description
static RollingUpdateOptions.Builder	builder()
default Number	getMaxBatchSize() (experimental) The maximum number of instances that AWS CloudFormation updates at once.
default Number	getMinInstancesInService() (experimental) The minimum number of instances that must be in service before more instances are replaced.
default Number	getMinSuccessPercentage() (experimental) The percentage of instances that must signal success for the update to succeed.
default Duration	getPauseTime() (experimental) The pause time after making a change to a batch of instances.
default List<ScalingProcess>	getSuspendProcesses() (experimental) Specifies the Auto Scaling processes to suspend during a stack update.
default Boolean	getWaitOnResourceSignals() (experimental) Specifies whether the Auto Scaling group waits on signals from new instances during an update.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMaxBatchSize

@Stability(value=Experimental)
 @Nullable
default Number getMaxBatchSize()

(experimental) The maximum number of instances that AWS CloudFormation updates at once.

This number affects the speed of the replacement.

Default: 1

getMinInstancesInService

@Stability(value=Experimental)
 @Nullable
default Number getMinInstancesInService()

(experimental) 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(value=Experimental)
 @Nullable
default Number getMinSuccessPercentage()

(experimental) The percentage of instances that must signal success for the update to succeed.

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

getPauseTime

@Stability(value=Experimental)
 @Nullable
default Duration getPauseTime()

(experimental) The pause time after making a change to a batch of instances.

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

getSuspendProcesses

@Stability(value=Experimental)
 @Nullable
default List<ScalingProcess> getSuspendProcesses()

(experimental) 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(value=Experimental)
 @Nullable
default Boolean getWaitOnResourceSignals()

(experimental) 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(value=Experimental)
static RollingUpdateOptions.Builder builder()

Returns:

a RollingUpdateOptions.Builder of RollingUpdateOptions