interface WarmPoolOptions

Language	Type name
.NET	`Amazon.CDK.AWS.AutoScaling.WarmPoolOptions`
Java	`software.amazon.awscdk.services.autoscaling.WarmPoolOptions`
Python	`aws_cdk.aws_autoscaling.WarmPoolOptions`
TypeScript (source)	`@aws-cdk/aws-autoscaling` » `WarmPoolOptions`

Options for a warm pool.

Example

declare const autoScalingGroup: autoscaling.AutoScalingGroup;

autoScalingGroup.addWarmPool({
  minSize: 1,
  reuseOnScaleIn: true,
});

Properties

Name	Type	Description
maxGroupPreparedCapacity?	`number`	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.
minSize?	`number`	The minimum number of instances to maintain in the warm pool.
poolState?	`PoolState`	The instance state to transition to after the lifecycle actions are complete.
reuseOnScaleIn?	`boolean`	Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

maxGroupPreparedCapacity?

Type: number (optional, default: max size of the Auto Scaling group)

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.

minSize?

Type: number (optional, default: 0)

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

poolState?

Type: PoolState (optional, default: PoolState.STOPPED)

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

reuseOnScaleIn?

Type: boolean (optional, default: false)

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.