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.24.0 (build b722f66)",
           date="2021-03-11T13:47:04.993Z")
 @Stability(value=Stable)
public interface RollingUpdateConfiguration
extends software.amazon.jsii.JsiiSerializable

Additional settings when a rolling update is selected.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RollingUpdateConfiguration.Builder	builder()
default Number	getMaxBatchSize() The maximum number of instances that AWS CloudFormation updates at once.
default Number	getMinInstancesInService() The minimum number of instances that must be in service before more instances are replaced.
default Number	getMinSuccessfulInstancesPercent() The percentage of instances that must signal success for an update to succeed.
default Duration	getPauseTime() The pause time after making a change to a batch of instances.
default List<ScalingProcess>	getSuspendProcesses() Specifies the Auto Scaling processes to suspend during a stack update.
default Boolean	getWaitOnResourceSignals() 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=Stable)
 @Nullable
default Number getMaxBatchSize()

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

Default: 1

getMinInstancesInService

@Stability(value=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

getMinSuccessfulInstancesPercent

@Stability(value=Stable)
 @Nullable
default Number getMinSuccessfulInstancesPercent()

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(value=Stable)
 @Nullable
default Duration getPauseTime()

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

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(value=Stable)
static RollingUpdateConfiguration.Builder builder()

Returns:

a RollingUpdateConfiguration.Builder of RollingUpdateConfiguration