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.
Contents
- enabled
-
Specifies whether to attach warm pools on the managed node group. Set to
trueto enable the warm pool, orfalseto disable and remove it. If not specified during an update, the current value is preserved.Type: Boolean
Required: No
- 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.
Type: Integer
Required: No
- 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.Type: Integer
Valid Range: Minimum value of 0.
Required: No
- poolState
-
The desired state for warm pool instances. Default:
Stopped. Valid values areStopped(most cost-effective with EBS storage costs only),Running(fastest transition time with full EC2 costs), andHibernated(balance between cost and speed, only supported on specific instance types). Warm pool instances in theHibernatedstate are not supported with Bottlerocket AMIs.Type: String
Valid Values:
STOPPED | RUNNING | HIBERNATEDRequired: No
- 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.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: