AWS EKS

Update node group configuration

Update an Amazon EKS managed node group configuration. Node groups continue to function during the update.

Inputs

Expand All

Field

Type

Description

region [required]

enum

default: us-east-1

clusterName [required]

string

The name of the Amazon EKS cluster that contains the managed node group.

nodegroupName [required]

string

The name of the managed node group to update.

labels

object

The Kubernetes labels to be applied to the nodes in the node group after the update.

addOrUpdateLabels

object

The Kubernetes labels to add or update.

removeLabels

[string]

The Kubernetes labels to remove.

taints

object

The Kubernetes taints to be applied to the nodes in the node group after the update.

addOrUpdateTaints

[object]

Kubernetes taints to be added or updated.

key

string

The key of the taint.

value

string

The value of the taint.

effect

string

The effect of the taint.

removeTaints

[object]

Kubernetes taints to remove.

key

string

The key of the taint.

value

string

The value of the taint.

effect

string

The effect of the taint.

scalingConfig

object

The scaling configuration details for the Auto Scaling group after the update.

minSize

number

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

maxSize

number

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.

desiredSize

number

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.

updateConfig

object

The node group update configuration.

maxUnavailable

number

The maximum number of nodes unavailable at once during a version update. Nodes are updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.

maxUnavailablePercentage

number

The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.

Outputs

Expand All

Field

Type

Description

update

object

id

string

A UUID that is used to track the update.

status

string

The current status of the update.

type

string

The type of the update.

params

[object]

A key-value map that contains the parameters associated with the update.

type

string

The keys associated with an update request.

value

string

The value of the keys submitted as part of an update request.

createdAt

date-time

The Unix epoch timestamp at object creation.

errors

[object]

Any errors associated with a Failed update.

errorCode

string

A brief description of the error. SubnetNotFound: We couldn't find one of the subnets associated with the cluster. SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster. EniLimitReached: You have reached the elastic network interface limit for your account. IpNotAvailable: A subnet associated with the cluster doesn't have any available IP addresses. AccessDenied: You don't have permissions to perform the specified operation. OperationNotPermitted: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS. VpcIdNotFound: We couldn't find the VPC associated with the cluster.

errorMessage

string

A more complete description of the error.

resourceIds

[string]

An optional field that contains the resource IDs associated with the error.

amzRequestId [required]

string