interface CfnWarmPoolProps

Language	Type name
.NET	`Amazon.CDK.AWS.AutoScaling.CfnWarmPoolProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#CfnWarmPoolProps`
Java	`software.amazon.awscdk.services.autoscaling.CfnWarmPoolProps`
Python	`aws_cdk.aws_autoscaling.CfnWarmPoolProps`
TypeScript	`aws-cdk-lib` » `aws_autoscaling` » `CfnWarmPoolProps`

Properties for defining a CfnWarmPool.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
const cfnWarmPoolProps: autoscaling.CfnWarmPoolProps = {
  autoScalingGroupName: 'autoScalingGroupName',

  // the properties below are optional
  instanceReusePolicy: {
    reuseOnScaleIn: false,
  },
  maxGroupPreparedCapacity: 123,
  minSize: 123,
  poolState: 'poolState',
};

Properties

Name	Type	Description
autoScalingGroupName	`string`	The name of the Auto Scaling group.
instanceReusePolicy?	`IResolvable` `\|` `InstanceReusePolicyProperty`	Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
maxGroupPreparedCapacity?	`number`	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.
minSize?	`number`	Specifies the minimum number of instances to maintain in the warm pool.
poolState?	`string`	Sets the instance state to transition to after the lifecycle actions are complete.

autoScalingGroupName

Type: string

The name of the Auto Scaling group.

instanceReusePolicy?

Type: IResolvable | InstanceReusePolicyProperty (optional)

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.

maxGroupPreparedCapacity?

Type: number (optional)

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.

minSize?

Type: number (optional)

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.

poolState?

Type: string (optional)

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

Default is Stopped .