Package software.amazon.awscdk.services.autoscaling

Class InstanceRefreshOptions.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.InstanceRefreshOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<InstanceRefreshOptions>

Enclosing interface:

InstanceRefreshOptions

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

A builder for InstanceRefreshOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InstanceRefreshOptions.Builder	alarms(List<? extends IAlarmRef> alarms)	Sets the value of InstanceRefreshOptions.getAlarms()
InstanceRefreshOptions.Builder	bakeTime(Duration bakeTime)	Sets the value of InstanceRefreshOptions.getBakeTime()
InstanceRefreshOptions	build()	Builds the configured instance.
InstanceRefreshOptions.Builder	checkpointDelay(Duration checkpointDelay)	Sets the value of InstanceRefreshOptions.getCheckpointDelay()
InstanceRefreshOptions.Builder	checkpointPercentages(List<? extends Number> checkpointPercentages)	Sets the value of InstanceRefreshOptions.getCheckpointPercentages()
InstanceRefreshOptions.Builder	instanceWarmup(Duration instanceWarmup)	Sets the value of InstanceRefreshOptions.getInstanceWarmup()
InstanceRefreshOptions.Builder	maxHealthyPercentage(Number maxHealthyPercentage)	Sets the value of InstanceRefreshOptions.getMaxHealthyPercentage()
InstanceRefreshOptions.Builder	minHealthyPercentage(Number minHealthyPercentage)	Sets the value of InstanceRefreshOptions.getMinHealthyPercentage()
InstanceRefreshOptions.Builder	scaleInProtectedInstances(ScaleInProtectedInstances scaleInProtectedInstances)	Sets the value of InstanceRefreshOptions.getScaleInProtectedInstances()
InstanceRefreshOptions.Builder	skipMatching(Boolean skipMatching)	Sets the value of InstanceRefreshOptions.getSkipMatching()
InstanceRefreshOptions.Builder	standbyInstances(StandbyInstances standbyInstances)	Sets the value of InstanceRefreshOptions.getStandbyInstances()
InstanceRefreshOptions.Builder	strategy(InstanceRefreshStrategy strategy)	Sets the value of InstanceRefreshOptions.getStrategy()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

strategy

@Stability(Stable)
public InstanceRefreshOptions.Builder strategy(InstanceRefreshStrategy strategy)

Sets the value of InstanceRefreshOptions.getStrategy()

Parameters:

strategy - The strategy to use for the instance refresh. This parameter is required.

Returns:

this

alarms

@Stability(Stable)
public InstanceRefreshOptions.Builder alarms(List<? extends IAlarmRef> alarms)

Sets the value of InstanceRefreshOptions.getAlarms()

Parameters:

alarms - The CloudWatch alarms to monitor during the instance refresh. If any of the alarms goes into ALARM state, the instance refresh fails. You can specify up to 10 alarms.

Returns:

this

bakeTime

@Stability(Stable)
public InstanceRefreshOptions.Builder bakeTime(Duration bakeTime)

Sets the value of InstanceRefreshOptions.getBakeTime()

Parameters:

bakeTime - The amount of time after an instance refresh completes successfully before CloudFormation considers the update successful.

Returns:

this

checkpointDelay

@Stability(Stable)
public InstanceRefreshOptions.Builder checkpointDelay(Duration checkpointDelay)

Sets the value of InstanceRefreshOptions.getCheckpointDelay()

Parameters:

checkpointDelay - The amount of time to wait after a checkpoint is reached before continuing.

Returns:

this

checkpointPercentages

@Stability(Stable)
public InstanceRefreshOptions.Builder checkpointPercentages(List<? extends Number> checkpointPercentages)

Sets the value of InstanceRefreshOptions.getCheckpointPercentages()

Parameters:

checkpointPercentages - Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the group, the last number in the array must be 100.

Returns:

this

instanceWarmup

@Stability(Stable)
public InstanceRefreshOptions.Builder instanceWarmup(Duration instanceWarmup)

Sets the value of InstanceRefreshOptions.getInstanceWarmup()

Parameters:

instanceWarmup - The amount of time to wait after a new instance enters the InService state before moving on to refresh the next instance.

Returns:

this

maxHealthyPercentage

@Stability(Stable)
public InstanceRefreshOptions.Builder maxHealthyPercentage(Number maxHealthyPercentage)

Sets the value of InstanceRefreshOptions.getMaxHealthyPercentage()

Parameters:

maxHealthyPercentage - The maximum percentage of the group that can be in service and healthy, or pending, to support your workload during the instance refresh. The difference between maxHealthyPercentage and minHealthyPercentage cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time.

Returns:

this

minHealthyPercentage

@Stability(Stable)
public InstanceRefreshOptions.Builder minHealthyPercentage(Number minHealthyPercentage)

Sets the value of InstanceRefreshOptions.getMinHealthyPercentage()

Parameters:

minHealthyPercentage - The minimum percentage of the group to keep in service, healthy, and ready to use to support your workload during the instance refresh, expressed as a percentage of the group's desired capacity.

Returns:

this

scaleInProtectedInstances

@Stability(Stable)
public InstanceRefreshOptions.Builder scaleInProtectedInstances(ScaleInProtectedInstances scaleInProtectedInstances)

Sets the value of InstanceRefreshOptions.getScaleInProtectedInstances()

Parameters:

scaleInProtectedInstances - Specifies the behavior of instances that are protected from scale in during an instance refresh.

Returns:

this

skipMatching

@Stability(Stable)
public InstanceRefreshOptions.Builder skipMatching(Boolean skipMatching)

Sets the value of InstanceRefreshOptions.getSkipMatching()

Parameters:

skipMatching - Indicates whether skip matching is enabled.

Returns:

this

standbyInstances

@Stability(Stable)
public InstanceRefreshOptions.Builder standbyInstances(StandbyInstances standbyInstances)

Sets the value of InstanceRefreshOptions.getStandbyInstances()

Parameters:

standbyInstances - Specifies the behavior of instances in standby during an instance refresh.

Returns:

this

build

@Stability(Stable)
public InstanceRefreshOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of InstanceRefreshOptions

Throws:

NullPointerException - if any required attribute was not provided