/AWS1/CL_EKSWARMPOOLCONFIG¶
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.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_enabled TYPE /AWS1/EKSBOXEDBOOLEAN /AWS1/EKSBOXEDBOOLEAN¶
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.
iv_minsize TYPE /AWS1/EKSZEROCAPACITY /AWS1/EKSZEROCAPACITY¶
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.
iv_maxgrouppreparedcapacity TYPE /AWS1/EKSBOXEDINTEGER /AWS1/EKSBOXEDINTEGER¶
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.
iv_poolstate TYPE /AWS1/EKSWARMPOOLSTATE /AWS1/EKSWARMPOOLSTATE¶
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.
iv_reuseonscalein TYPE /AWS1/EKSBOXEDBOOLEAN /AWS1/EKSBOXEDBOOLEAN¶
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.
Queryable Attributes¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENABLED() |
Getter for ENABLED, with configurable default |
ASK_ENABLED() |
Getter for ENABLED w/ exceptions if field has no value |
HAS_ENABLED() |
Determine if ENABLED has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MINSIZE() |
Getter for MINSIZE, with configurable default |
ASK_MINSIZE() |
Getter for MINSIZE w/ exceptions if field has no value |
HAS_MINSIZE() |
Determine if MINSIZE has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXGROUPPREPAREDCAPACITY() |
Getter for MAXGROUPPREPAREDCAPACITY, with configurable defau |
ASK_MAXGROUPPREPAREDCAPACITY() |
Getter for MAXGROUPPREPAREDCAPACITY w/ exceptions if field h |
HAS_MAXGROUPPREPAREDCAPACITY() |
Determine if MAXGROUPPREPAREDCAPACITY has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POOLSTATE() |
Getter for POOLSTATE, with configurable default |
ASK_POOLSTATE() |
Getter for POOLSTATE w/ exceptions if field has no value |
HAS_POOLSTATE() |
Determine if POOLSTATE has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REUSEONSCALEIN() |
Getter for REUSEONSCALEIN, with configurable default |
ASK_REUSEONSCALEIN() |
Getter for REUSEONSCALEIN w/ exceptions if field has no valu |
HAS_REUSEONSCALEIN() |
Determine if REUSEONSCALEIN has a value |