software.amazon.awscdk.services.autoscaling

Class WarmPool.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.WarmPool.Builder

Enclosing class:

WarmPool

public static final class WarmPool.Builder
extends java.lang.Object

A fluent builder for WarmPool.

Method Summary

Modifier and Type	Method and Description
WarmPool.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup) The Auto Scaling group to add the warm pool to.
WarmPool	build()
static WarmPool.Builder	create(software.constructs.Construct scope, java.lang.String id)
WarmPool.Builder	maxGroupPreparedCapacity(java.lang.Number 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.
WarmPool.Builder	minSize(java.lang.Number minSize) The minimum number of instances to maintain in the warm pool.
WarmPool.Builder	poolState(PoolState poolState) The instance state to transition to after the lifecycle actions are complete.
WarmPool.Builder	reuseOnScaleIn(java.lang.Boolean reuseOnScaleIn) Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static WarmPool.Builder create(software.constructs.Construct scope,
                                      java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of WarmPool.Builder.

maxGroupPreparedCapacity

public WarmPool.Builder maxGroupPreparedCapacity(java.lang.Number 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.

Default: - max size of the Auto Scaling group

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. This parameter is required.

Returns:

this

minSize

public WarmPool.Builder minSize(java.lang.Number minSize)

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

Default: 0

Parameters:

minSize - The minimum number of instances to maintain in the warm pool. This parameter is required.

Returns:

this

poolState

public WarmPool.Builder poolState(PoolState poolState)

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

Default: PoolState.STOPPED

Parameters:

poolState - The instance state to transition to after the lifecycle actions are complete. This parameter is required.

Returns:

this

reuseOnScaleIn

public WarmPool.Builder reuseOnScaleIn(java.lang.Boolean 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.

Default: false

Parameters:

reuseOnScaleIn - Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. This parameter is required.

Returns:

this

autoScalingGroup

public WarmPool.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

The Auto Scaling group to add the warm pool to.

Parameters:

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

Returns:

this

build

public WarmPool build()