|
| 1 | +import { Lazy, Names, Resource } from '@aws-cdk/core'; |
| 2 | +import { Construct } from 'constructs'; |
| 3 | +import { IAutoScalingGroup } from './auto-scaling-group'; |
| 4 | +import { CfnWarmPool } from './autoscaling.generated'; |
| 5 | + |
| 6 | +/** |
| 7 | + * Options for a warm pool |
| 8 | + */ |
| 9 | +export interface WarmPoolOptions { |
| 10 | + /** |
| 11 | + * Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. |
| 12 | + * |
| 13 | + * If the value is not specified, instances in the Auto Scaling group will be terminated |
| 14 | + * when the group scales in. |
| 15 | + * |
| 16 | + * @default false |
| 17 | + */ |
| 18 | + readonly reuseOnScaleIn?: boolean; |
| 19 | + |
| 20 | + /** |
| 21 | + * The maximum number of instances that are allowed to be in the warm pool |
| 22 | + * or in any state except Terminated for the Auto Scaling group. |
| 23 | + * |
| 24 | + * If the value is not specified, Amazon EC2 Auto Scaling launches and maintains |
| 25 | + * the difference between the group's maximum capacity and its desired capacity. |
| 26 | + * |
| 27 | + * @default - max size of the Auto Scaling group |
| 28 | + */ |
| 29 | + readonly maxGroupPreparedCapacity?: number; |
| 30 | + /** |
| 31 | + * The minimum number of instances to maintain in the warm pool. |
| 32 | + * |
| 33 | + * @default 0 |
| 34 | + */ |
| 35 | + readonly minSize?: number; |
| 36 | + /** |
| 37 | + * The instance state to transition to after the lifecycle actions are complete. |
| 38 | + * |
| 39 | + * @default PoolState.STOPPED |
| 40 | + */ |
| 41 | + readonly poolState?: PoolState; |
| 42 | +} |
| 43 | + |
| 44 | +/** |
| 45 | + * Properties for a warm pool |
| 46 | + */ |
| 47 | +export interface WarmPoolProps extends WarmPoolOptions { |
| 48 | + /** |
| 49 | + * The Auto Scaling group to add the warm pool to. |
| 50 | + */ |
| 51 | + readonly autoScalingGroup: IAutoScalingGroup; |
| 52 | +} |
| 53 | + |
| 54 | +/** |
| 55 | + * Define a warm pool |
| 56 | + */ |
| 57 | +export class WarmPool extends Resource { |
| 58 | + constructor(scope: Construct, id: string, props: WarmPoolProps) { |
| 59 | + super(scope, id, { |
| 60 | + physicalName: Lazy.string({ produce: () => Names.uniqueId(this) }), |
| 61 | + }); |
| 62 | + |
| 63 | + if (props.maxGroupPreparedCapacity && props.maxGroupPreparedCapacity < -1) { |
| 64 | + throw new Error('\'maxGroupPreparedCapacity\' parameter should be greater than or equal to -1'); |
| 65 | + } |
| 66 | + |
| 67 | + if (props.minSize && props.minSize < 0) { |
| 68 | + throw new Error('\'minSize\' parameter should be greater than or equal to 0'); |
| 69 | + } |
| 70 | + |
| 71 | + new CfnWarmPool(this, 'Resource', { |
| 72 | + autoScalingGroupName: props.autoScalingGroup.autoScalingGroupName, |
| 73 | + instanceReusePolicy: props.reuseOnScaleIn !== undefined ? { |
| 74 | + reuseOnScaleIn: props.reuseOnScaleIn, |
| 75 | + } : undefined, |
| 76 | + maxGroupPreparedCapacity: props.maxGroupPreparedCapacity, |
| 77 | + minSize: props.minSize, |
| 78 | + poolState: props.poolState, |
| 79 | + }); |
| 80 | + } |
| 81 | +} |
| 82 | + |
| 83 | +/** |
| 84 | + * The instance state in the warm pool |
| 85 | + */ |
| 86 | +export enum PoolState { |
| 87 | + /** |
| 88 | + * Hibernated |
| 89 | + * |
| 90 | + * To use this state, prerequisites must be in place. |
| 91 | + * @see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html |
| 92 | + */ |
| 93 | + HIBERNATED = 'Hibernated', |
| 94 | + |
| 95 | + /** |
| 96 | + * Running |
| 97 | + */ |
| 98 | + RUNNING = 'Running', |
| 99 | + |
| 100 | + /** |
| 101 | + * Stopped |
| 102 | + */ |
| 103 | + STOPPED = 'Stopped', |
| 104 | +} |
0 commit comments