Package software.amazon.awscdk.services.autoscaling

Class CfnWarmPool.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnWarmPool.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWarmPool>

Enclosing class:

CfnWarmPool

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

A fluent builder for CfnWarmPool.

Method Summary

Modifier and Type	Method	Description
CfnWarmPool.Builder	autoScalingGroupName(String autoScalingGroupName)	The name of the Auto Scaling group.
CfnWarmPool	build()
static CfnWarmPool.Builder	create(software.constructs.Construct scope, String id)
CfnWarmPool.Builder	instanceReusePolicy(IResolvable instanceReusePolicy)	Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
CfnWarmPool.Builder	instanceReusePolicy(CfnWarmPool.InstanceReusePolicyProperty instanceReusePolicy)	Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
CfnWarmPool.Builder	maxGroupPreparedCapacity(Number maxGroupPreparedCapacity)	Specifies 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.
CfnWarmPool.Builder	minSize(Number minSize)	Specifies the minimum number of instances to maintain in the warm pool.
CfnWarmPool.Builder	poolState(String poolState)	Sets the instance state to transition to after the lifecycle actions are complete.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnWarmPool.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnWarmPool.Builder.

autoScalingGroupName

@Stability(Stable)
public CfnWarmPool.Builder autoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-autoscalinggroupname

instanceReusePolicy

@Stability(Stable)
public CfnWarmPool.Builder instanceReusePolicy(IResolvable instanceReusePolicy)

Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

The default is to terminate instances in the Auto Scaling group when the group scales in.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-instancereusepolicy

instanceReusePolicy

@Stability(Stable)
public CfnWarmPool.Builder instanceReusePolicy(CfnWarmPool.InstanceReusePolicyProperty instanceReusePolicy)

Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

The default is to terminate instances in the Auto Scaling group when the group scales in.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-instancereusepolicy

maxGroupPreparedCapacity

@Stability(Stable)
public CfnWarmPool.Builder maxGroupPreparedCapacity(Number maxGroupPreparedCapacity)

Specifies 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 is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity.

If a value for MaxGroupPreparedCapacity is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for MaxGroupPreparedCapacity , Amazon EC2 Auto Scaling uses the difference between the MaxGroupPreparedCapacity and the desired capacity instead.

The size of the warm pool is dynamic. Only when MaxGroupPreparedCapacity and MinSize are set to the same value does the warm pool have an absolute size.

If the desired capacity of the Auto Scaling group is higher than the MaxGroupPreparedCapacity , the capacity of the warm pool is 0, unless you specify a value for MinSize . To remove a value that you previously set, include the property but specify -1 for the value.

Parameters:

maxGroupPreparedCapacity - Specifies 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-maxgrouppreparedcapacity

minSize

@Stability(Stable)
public CfnWarmPool.Builder minSize(Number minSize)

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

This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-minsize

poolState

@Stability(Stable)
public CfnWarmPool.Builder poolState(String poolState)

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

Default is Stopped .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-warmpool.html#cfn-autoscaling-warmpool-poolstate

build

@Stability(Stable)
public CfnWarmPool build()

Specified by:

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

Returns:

a newly built instance of CfnWarmPool.