update-nodegroup-config¶

Description¶

Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.

Synopsis¶

  update-nodegroup-config
--cluster-name <value>
--nodegroup-name <value>
[--labels <value>]
[--taints <value>]
[--scaling-config <value>]
[--update-config <value>]
[--client-request-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--cluster-name (string)

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

--nodegroup-name (string)

The name of the managed node group to update.

--labels (structure)

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

addOrUpdateLabels -> (map)

Kubernetes labels to be added or updated.

key -> (string)

value -> (string)

removeLabels -> (list)

Kubernetes labels to be removed.

(string)

Shorthand Syntax:

addOrUpdateLabels={KeyName1=string,KeyName2=string},removeLabels=string,string

JSON Syntax:

{
  "addOrUpdateLabels": {"string": "string"
    ...},
  "removeLabels": ["string", ...]
}

--taints (structure)

The Kubernetes taints to be applied to the nodes in the node group after the update. For more information, see Node taints on managed node groups .

addOrUpdateTaints -> (list)

Kubernetes taints to be added or updated.

(structure)

A property that allows a node to repel a set of pods. For more information, see Node taints on managed node groups .

key -> (string)

The key of the taint.

value -> (string)

The value of the taint.

effect -> (string)

The effect of the taint.

removeTaints -> (list)

Kubernetes taints to be removed.

(structure)

A property that allows a node to repel a set of pods. For more information, see Node taints on managed node groups .

key -> (string)

The key of the taint.

value -> (string)

The value of the taint.

effect -> (string)

The effect of the taint.

Shorthand Syntax:

addOrUpdateTaints=[{key=string,value=string,effect=string},{key=string,value=string,effect=string}],removeTaints=[{key=string,value=string,effect=string},{key=string,value=string,effect=string}]

JSON Syntax:

{
  "addOrUpdateTaints": [
    {
      "key": "string",
      "value": "string",
      "effect": "NO_SCHEDULE"|"NO_EXECUTE"|"PREFER_NO_SCHEDULE"
    }
    ...
  ],
  "removeTaints": [
    {
      "key": "string",
      "value": "string",
      "effect": "NO_SCHEDULE"|"NO_EXECUTE"|"PREFER_NO_SCHEDULE"
    }
    ...
  ]
}

--scaling-config (structure)

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

minSize -> (integer)

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

maxSize -> (integer)

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 -> (integer)

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

Warning

If you use 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 Cluster Autoscaler reduce the number if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is altered by Cluster Autoscaler (but can be out-of-date for short periods of time). Cluster Autoscaler doesn’t scale a managed node group lower than minSize or higher than maxSize.

Shorthand Syntax:

minSize=integer,maxSize=integer,desiredSize=integer

JSON Syntax:

{
  "minSize": integer,
  "maxSize": integer,
  "desiredSize": integer
}

--update-config (structure)

The node group update configuration.

maxUnavailable -> (integer)

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

maxUnavailablePercentage -> (integer)

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

Shorthand Syntax:

maxUnavailable=integer,maxUnavailablePercentage=integer

JSON Syntax:

{
  "maxUnavailable": integer,
  "maxUnavailablePercentage": integer
}

--client-request-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output¶

update -> (structure)

An object representing an asynchronous update.

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 -> (list)

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

(structure)

An object representing the details of an update request.

type -> (string)

The keys associated with an update request.

value -> (string)

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

createdAt -> (timestamp)

The Unix epoch timestamp in seconds for when the update was created.

errors -> (list)

Any errors associated with a Failed update.

(structure)

An object representing an error when an asynchronous operation fails.

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 free 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 -> (list)

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

(string)

Table of Contents

Feedback

User Guide

update-nodegroup-config¶

Description¶

Synopsis¶

Options¶

Output¶