software.amazon.awscdk.services.autoscaling

Class WarmPoolProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.WarmPoolProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WarmPoolProps>

Enclosing interface:

WarmPoolProps

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

A builder for WarmPoolProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
WarmPoolProps.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup) Sets the value of WarmPoolProps.getAutoScalingGroup()
WarmPoolProps	build() Builds the configured instance.
WarmPoolProps.Builder	maxGroupPreparedCapacity(Number maxGroupPreparedCapacity) Sets the value of WarmPoolOptions.getMaxGroupPreparedCapacity()
WarmPoolProps.Builder	minSize(Number minSize) Sets the value of WarmPoolOptions.getMinSize()
WarmPoolProps.Builder	poolState(PoolState poolState) Sets the value of WarmPoolOptions.getPoolState()
WarmPoolProps.Builder	reuseOnScaleIn(Boolean reuseOnScaleIn) Sets the value of WarmPoolOptions.getReuseOnScaleIn()

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

autoScalingGroup

@Stability(value=Stable)
public WarmPoolProps.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

Sets the value of WarmPoolProps.getAutoScalingGroup()

Parameters:

autoScalingGroup - The Auto Scaling group to add the warm pool to. This parameter is required.

Returns:

this

maxGroupPreparedCapacity

@Stability(value=Stable)
public WarmPoolProps.Builder maxGroupPreparedCapacity(Number maxGroupPreparedCapacity)

Sets the value of WarmPoolOptions.getMaxGroupPreparedCapacity()

Parameters:

maxGroupPreparedCapacity - The maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group. If the value is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity.

Returns:

this

minSize

@Stability(value=Stable)
public WarmPoolProps.Builder minSize(Number minSize)

Sets the value of WarmPoolOptions.getMinSize()

Parameters:

minSize - The minimum number of instances to maintain in the warm pool.

Returns:

this

poolState

@Stability(value=Stable)
public WarmPoolProps.Builder poolState(PoolState poolState)

Sets the value of WarmPoolOptions.getPoolState()

Parameters:

poolState - The instance state to transition to after the lifecycle actions are complete.

Returns:

this

reuseOnScaleIn

@Stability(value=Stable)
public WarmPoolProps.Builder reuseOnScaleIn(Boolean reuseOnScaleIn)

Sets the value of WarmPoolOptions.getReuseOnScaleIn()

Parameters:

reuseOnScaleIn - Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. If the value is not specified, instances in the Auto Scaling group will be terminated when the group scales in.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of WarmPoolProps

Throws:

NullPointerException - if any required attribute was not provided