Class: Aws::EKS::Types::WarmPoolConfig

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::WarmPoolConfig

Includes:

Structure

Defined in:

lib/aws-sdk-eks/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

  Specifies whether to attach warm pools on the managed node group.

• #max_group_prepared_capacity ⇒ Integer

  The maximum total number of instances across the warm pool and Auto Scaling group combined.

• #min_size ⇒ Integer

  The minimum number of instances to maintain in the warm pool.

• #pool_state ⇒ String

  The desired state for warm pool instances.

• #reuse_on_scale_in ⇒ Boolean

  Indicates whether instances should return to the warm pool during scale-in events instead of being terminated.

Instance Attribute Details

#enabled ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-eks/types.rb', line 8806

class WarmPoolConfig < Struct.new(
  :enabled,
  :min_size,
  :max_group_prepared_capacity,
  :pool_state,
  :reuse_on_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#max_group_prepared_capacity ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-eks/types.rb', line 8806

class WarmPoolConfig < Struct.new(
  :enabled,
  :min_size,
  :max_group_prepared_capacity,
  :pool_state,
  :reuse_on_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#min_size ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-eks/types.rb', line 8806

class WarmPoolConfig < Struct.new(
  :enabled,
  :min_size,
  :max_group_prepared_capacity,
  :pool_state,
  :reuse_on_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#pool_state ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-eks/types.rb', line 8806

class WarmPoolConfig < Struct.new(
  :enabled,
  :min_size,
  :max_group_prepared_capacity,
  :pool_state,
  :reuse_on_scale_in)
  SENSITIVE = []
  include Aws::Structure
end

#reuse_on_scale_in ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-eks/types.rb', line 8806

class WarmPoolConfig < Struct.new(
  :enabled,
  :min_size,
  :max_group_prepared_capacity,
  :pool_state,
  :reuse_on_scale_in)
  SENSITIVE = []
  include Aws::Structure
end