software.amazon.awscdk.services.autoscaling

Class RollingUpdateConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.RollingUpdateConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RollingUpdateConfiguration>

Enclosing interface:

RollingUpdateConfiguration

@Stability(value=Stable)
public static final class RollingUpdateConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<RollingUpdateConfiguration>

A builder for RollingUpdateConfiguration

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RollingUpdateConfiguration	build() Builds the configured instance.
RollingUpdateConfiguration.Builder	maxBatchSize(Number maxBatchSize) Sets the value of RollingUpdateConfiguration.getMaxBatchSize()
RollingUpdateConfiguration.Builder	minInstancesInService(Number minInstancesInService) Sets the value of RollingUpdateConfiguration.getMinInstancesInService()
RollingUpdateConfiguration.Builder	minSuccessfulInstancesPercent(Number minSuccessfulInstancesPercent) Sets the value of RollingUpdateConfiguration.getMinSuccessfulInstancesPercent()
RollingUpdateConfiguration.Builder	pauseTime(Duration pauseTime) Sets the value of RollingUpdateConfiguration.getPauseTime()
RollingUpdateConfiguration.Builder	suspendProcesses(List<? extends ScalingProcess> suspendProcesses) Sets the value of RollingUpdateConfiguration.getSuspendProcesses()
RollingUpdateConfiguration.Builder	waitOnResourceSignals(Boolean waitOnResourceSignals) Sets the value of RollingUpdateConfiguration.getWaitOnResourceSignals()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

maxBatchSize

@Stability(value=Stable)
public RollingUpdateConfiguration.Builder maxBatchSize(Number maxBatchSize)

Sets the value of RollingUpdateConfiguration.getMaxBatchSize()

Parameters:

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

Returns:

this

minInstancesInService

@Stability(value=Stable)
public RollingUpdateConfiguration.Builder minInstancesInService(Number minInstancesInService)

Sets the value of RollingUpdateConfiguration.getMinInstancesInService()

Parameters:

minInstancesInService - The minimum number of instances that must be in service before more instances are replaced. This number affects the speed of the replacement.

Returns:

this

minSuccessfulInstancesPercent

@Stability(value=Stable)
public RollingUpdateConfiguration.Builder minSuccessfulInstancesPercent(Number minSuccessfulInstancesPercent)

Sets the value of RollingUpdateConfiguration.getMinSuccessfulInstancesPercent()

Parameters:

minSuccessfulInstancesPercent - 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.

Returns:

this

pauseTime

@Stability(value=Stable)
public RollingUpdateConfiguration.Builder pauseTime(Duration pauseTime)

Sets the value of RollingUpdateConfiguration.getPauseTime()

Parameters:

pauseTime - 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).

Returns:

this

suspendProcesses

@Stability(value=Stable)
public RollingUpdateConfiguration.Builder suspendProcesses(List<? extends ScalingProcess> suspendProcesses)

Sets the value of RollingUpdateConfiguration.getSuspendProcesses()

Parameters:

suspendProcesses - Specifies the Auto Scaling processes to suspend during a stack update. Suspending processes prevents Auto Scaling from interfering with a stack update.

Returns:

this

waitOnResourceSignals

@Stability(value=Stable)
public RollingUpdateConfiguration.Builder waitOnResourceSignals(Boolean waitOnResourceSignals)

Sets the value of RollingUpdateConfiguration.getWaitOnResourceSignals()

Parameters:

waitOnResourceSignals - 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.

Returns:

this

build

@Stability(value=Stable)
public RollingUpdateConfiguration build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<RollingUpdateConfiguration>

Returns:

a new instance of RollingUpdateConfiguration

Throws:

NullPointerException - if any required attribute was not provided