software.amazon.awscdk.services.autoscaling

Class CfnWarmPoolProps.Builder

java.lang.Object

software.amazon.awscdk.services.autoscaling.CfnWarmPoolProps.Builder

Enclosing interface:

CfnWarmPoolProps

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

A builder for CfnWarmPoolProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnWarmPoolProps.Builder	autoScalingGroupName(java.lang.String autoScalingGroupName) Sets the value of CfnWarmPoolProps.getAutoScalingGroupName()
CfnWarmPoolProps	build() Builds the configured instance.
CfnWarmPoolProps.Builder	instanceReusePolicy(CfnWarmPool.InstanceReusePolicyProperty instanceReusePolicy) Sets the value of CfnWarmPoolProps.getInstanceReusePolicy()
CfnWarmPoolProps.Builder	instanceReusePolicy(IResolvable instanceReusePolicy) Sets the value of CfnWarmPoolProps.getInstanceReusePolicy()
CfnWarmPoolProps.Builder	maxGroupPreparedCapacity(java.lang.Number maxGroupPreparedCapacity) Sets the value of CfnWarmPoolProps.getMaxGroupPreparedCapacity()
CfnWarmPoolProps.Builder	minSize(java.lang.Number minSize) Sets the value of CfnWarmPoolProps.getMinSize()
CfnWarmPoolProps.Builder	poolState(java.lang.String poolState) Sets the value of CfnWarmPoolProps.getPoolState()

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

autoScalingGroupName

public CfnWarmPoolProps.Builder autoScalingGroupName(java.lang.String autoScalingGroupName)

Sets the value of CfnWarmPoolProps.getAutoScalingGroupName()

Parameters:

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

Returns:

this

instanceReusePolicy

public CfnWarmPoolProps.Builder instanceReusePolicy(IResolvable instanceReusePolicy)

Sets the value of CfnWarmPoolProps.getInstanceReusePolicy()

Parameters:

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.

Returns:

this

instanceReusePolicy

public CfnWarmPoolProps.Builder instanceReusePolicy(CfnWarmPool.InstanceReusePolicyProperty instanceReusePolicy)

Sets the value of CfnWarmPoolProps.getInstanceReusePolicy()

Parameters:

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.

Returns:

this

maxGroupPreparedCapacity

public CfnWarmPoolProps.Builder maxGroupPreparedCapacity(java.lang.Number maxGroupPreparedCapacity)

Sets the value of CfnWarmPoolProps.getMaxGroupPreparedCapacity()

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

Returns:

this

minSize

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

Sets the value of CfnWarmPoolProps.getMinSize()

Parameters:

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.

Returns:

this

poolState

public CfnWarmPoolProps.Builder poolState(java.lang.String poolState)

Sets the value of CfnWarmPoolProps.getPoolState()

Parameters:

poolState - Sets the instance state to transition to after the lifecycle actions are complete. Default is Stopped .

Returns:

this

build

public CfnWarmPoolProps build()

Builds the configured instance.

Returns:

a new instance of CfnWarmPoolProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided