WarmPoolProps Struct
Properties for a warm pool.
Example
ts
// 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';
import { aws_autoscaling as interfaces_autoscaling } from 'aws-cdk-lib/interfaces';
declare const autoScalingGroupRef: interfaces_autoscaling.IAutoScalingGroupRef;
const warmPoolProps: autoscaling.WarmPoolProps = {
autoScalingGroup: autoScalingGroupRef,
// the properties below are optional
maxGroupPreparedCapacity: 123,
minSize: 123,
poolState: autoscaling.PoolState.HIBERNATED,
reuseOnScaleIn: false,
};
Properties
autoScalingGroupIAutoScalingGroupRefauto_scaling_groupIAutoScalingGroupRefautoScalingGroupIAutoScalingGroupRefAutoScalingGroupIAutoScalingGroupRefAutoScalingGroupIAutoScalingGroupRefrequired#The Auto Scaling group to add the warm pool to.
maxGroupPreparedCapacityoptionalnumbermax_group_prepared_capacityoptionalint | floatmaxGroupPreparedCapacityoptionalNumberMaxGroupPreparedCapacityoptionaldoubleMaxGroupPreparedCapacityoptional*float64#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.
Default: max size of 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.
minSizeoptionalnumbermin_sizeoptionalint | floatminSizeoptionalNumberMinSizeoptionaldoubleMinSizeoptional*float64= 0#The minimum number of instances to maintain in the warm pool.
poolStateoptionalPoolStatepool_stateoptionalPoolStatepoolStateoptionalPoolStatePoolStateoptionalPoolStatePoolStateoptionalPoolState= PoolState.STOPPED#The instance state to transition to after the lifecycle actions are complete.
reuseOnScaleInoptionalbooleanreuse_on_scale_inoptionalboolreuseOnScaleInoptionalBooleanReuseOnScaleInoptionalboolReuseOnScaleInoptional*bool= 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.