Skip to content

/AWS1/CL_EKSNODEGROUPSCACONFIG

An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group. When creating a node group, you must specify all or none of the properties. When updating a node group, you can specify any or none of the properties.

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_MINSIZE TYPE /AWS1/EKSZEROCAPACITY /AWS1/EKSZEROCAPACITY

The minimum number of nodes that the managed node group can scale in to.

IV_MAXSIZE TYPE /AWS1/EKSCAPACITY /AWS1/EKSCAPACITY

The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

IV_DESIREDSIZE TYPE /AWS1/EKSZEROCAPACITY /AWS1/EKSZEROCAPACITY

The current number of nodes that the managed node group should maintain.

If you use the Kubernetes Cluster Autoscaler, you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value.

When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize.


Queryable Attributes

minSize

The minimum number of nodes that the managed node group can scale in to.

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

maxSize

The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.

Accessible with the following methods

Method Description
GET_MAXSIZE() Getter for MAXSIZE, with configurable default
ASK_MAXSIZE() Getter for MAXSIZE w/ exceptions if field has no value
HAS_MAXSIZE() Determine if MAXSIZE has a value

desiredSize

The current number of nodes that the managed node group should maintain.

If you use the Kubernetes Cluster Autoscaler, you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value.

When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize.

Accessible with the following methods

Method Description
GET_DESIREDSIZE() Getter for DESIREDSIZE, with configurable default
ASK_DESIREDSIZE() Getter for DESIREDSIZE w/ exceptions if field has no value
HAS_DESIREDSIZE() Determine if DESIREDSIZE has a value