Skip to content

WarmPoolConfig

Used by
Source code in docs_src/capo_eks/types/warm_pool_config.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class WarmPoolConfig(TypedDict, closed=True):
    enabled: NotRequired["capo_eks.types.boxed_boolean.BoxedBoolean"]
    """<p>Specifies whether to attach warm pools on the managed node group. Set to <code>true</code> to enable the warm pool, or <code>false</code> to disable and remove it. If not specified during an update, the current value is preserved.</p>"""
    min_size: NotRequired["capo_eks.types.zero_capacity.ZeroCapacity"]
    """<p>The minimum number of instances to maintain in the warm pool. Default: <code>0</code>. Size your warm pool based on scaling patterns to balance cost and availability. Start with 10-20% of expected peak capacity.</p>"""
    max_group_prepared_capacity: NotRequired[
        "capo_eks.types.boxed_integer.BoxedInteger"
    ]
    """<p>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.</p>"""
    pool_state: NotRequired["capo_eks.types.warm_pool_state.WarmPoolState"]
    """<p>The desired state for warm pool instances. Default: <code>Stopped</code>. Valid values are <code>Stopped</code> (most cost-effective with EBS storage costs only), <code>Running</code> (fastest transition time with full EC2 costs), and <code>Hibernated</code> (balance between cost and speed, only supported on specific instance types). Warm pool instances in the <code>Hibernated</code> state are not supported with Bottlerocket AMIs.</p>"""
    reuse_on_scale_in: NotRequired["capo_eks.types.boxed_boolean.BoxedBoolean"]
    """<p>Indicates whether instances should return to the warm pool during scale-in events instead of being terminated. Default: <code>false</code>. Enable this to reduce costs by reusing instances. This feature is not supported for Bottlerocket AMIs.</p>"""

enabled instance-attribute 

enabled: NotRequired[BoxedBoolean]

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.

max_group_prepared_capacity instance-attribute 

max_group_prepared_capacity: NotRequired[BoxedInteger]

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.

min_size instance-attribute 

min_size: NotRequired[ZeroCapacity]

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.

pool_state instance-attribute 

pool_state: NotRequired[WarmPoolState]

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.

reuse_on_scale_in instance-attribute 

reuse_on_scale_in: NotRequired[BoxedBoolean]

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.