View a markdown version of this page

AWS::EKS::Nodegroup WarmPoolConfig - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::EKS::Nodegroup WarmPoolConfig

The configuration for an Amazon EC2 Auto Scaling warm pool attached to an Amazon EKS managed node group. Warm pools maintain pre-initialized EC2 instances alongside your Auto Scaling group that have already completed the bootup initialization process and can be kept in a Stopped, Running, or Hibernated state.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Enabled" : Boolean,
  "MaxGroupPreparedCapacity" : Integer,
  "MinSize" : Integer,
  "PoolState" : String,
  "ReuseOnScaleIn" : Boolean
}

YAML

  Enabled: Boolean
  MaxGroupPreparedCapacity: Integer
  MinSize: Integer
  PoolState: String
  ReuseOnScaleIn: Boolean

Properties

Enabled

Specifies whether to attach warm pools on the managed node group. Set to true to enable the warm pool, or false to disable and remove it. If not specified during an update, the current value is preserved.

Required: No

Type: Boolean

Update requires: No interruption

MaxGroupPreparedCapacity

The maximum total number of instances across the warm pool and Auto Scaling group combined. This value controls the total prepared capacity available for your node group.

Required: No

Type: Integer

Minimum: -1

Update requires: No interruption

MinSize

The minimum number of instances to maintain in the warm pool. Default: 0. Size your warm pool based on scaling patterns to balance cost and availability. Start with 10-20% of expected peak capacity.

Required: No

Type: Integer

Minimum: 0

Update requires: No interruption

PoolState

The desired state for warm pool instances. Default: Stopped. Valid values are Stopped (most cost-effective with EBS storage costs only), Running (fastest transition time with full EC2 costs), and Hibernated (balance between cost and speed, only supported on specific instance types). Warm pool instances in the Hibernated state are not supported with Bottlerocket AMIs.

Required: No

Type: String

Allowed values: STOPPED | RUNNING | HIBERNATED

Update requires: No interruption

ReuseOnScaleIn

Indicates whether instances should return to the warm pool during scale-in events instead of being terminated. Default: false. Enable this to reduce costs by reusing instances. This feature is not supported for Bottlerocket AMIs.

Required: No

Type: Boolean

Update requires: No interruption