gcloud alpha container aws node-pools update

NAME
gcloud alpha container aws node-pools update - update a node pool in an Anthos cluster on AWS
SYNOPSIS
gcloud alpha container aws node-pools update(NODE_POOL :--cluster=CLUSTER--location=LOCATION)[--async][--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN][--enable-autorepair][--iam-instance-profile=IAM_INSTANCE_PROFILE][--instance-type=INSTANCE_TYPE][--max-surge-update=MAX_SURGE_UPDATE][--max-unavailable-update=MAX_UNAVAILABLE_UPDATE][--node-version=NODE_VERSION][--root-volume-iops=ROOT_VOLUME_IOPS][--root-volume-kms-key-arn=ROOT_VOLUME_KMS_KEY_ARN][--root-volume-size=ROOT_VOLUME_SIZE][--root-volume-throughput=ROOT_VOLUME_THROUGHPUT][--root-volume-type=ROOT_VOLUME_TYPE][--validate-only][--annotations=ANNOTATION,[ANNOTATION,…]    |--clear-annotations][--clear-autoscaling-metrics    |--autoscaling-metrics=[AUTOSCALING_METRIC,…]--autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY][--clear-node-labels    |--node-labels=NODE_LABEL,[NODE_LABEL,…]][--clear-proxy-config    |--proxy-secret-arn=PROXY_SECRET_ARN--proxy-secret-version-id=PROXY_SECRET_VERSION_ID][--clear-security-group-ids    |--security-group-ids=[SECURITY_GROUP_ID,…]][--clear-ssh-ec2-key-pair    |--ssh-ec2-key-pair=SSH_EC2_KEY_PAIR][--clear-tags    |--tags=TAG,[TAG,…]][--max-nodes=MAX_NODES--min-nodes=MIN_NODES][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA)(DEPRECATED) Update a node pool in an Anthoscluster on AWS.

This command is deprecated. Seehttps://cloud.google.com/kubernetes-engine/multi-cloud/docs/aws/deprecations/deprecation-announcementfor more details.

EXAMPLES
To update a node pool namedmy-node-pool ina cluster namedmy-cluster managed inlocationus-west1, run:
gcloudalphacontainerawsnode-poolsupdatemy-node-pool--cluster=my-cluster--location=us-west1--node-version=NODE_VERSION
POSITIONAL ARGUMENTS
Node pool resource - node pool to update. The arguments in this group can beused to specify the attributes of this resource. (NOTE) Some attributes are notgiven arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentnode_pool on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

NODE_POOL
ID of the node_pool or fully qualified identifier for the node_pool.

To set thenode_pool attribute:

  • provide the argumentnode_pool on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--cluster=CLUSTER
cluster of the node_pool.

To set thecluster attribute:

  • provide the argumentnode_pool on the command line with a fullyspecified name;
  • provide the argument--cluster on the command line.
--location=LOCATION
Google Cloud location for the node_pool.

To set thelocation attribute:

  • provide the argumentnode_pool on the command line with a fullyspecified name;
  • provide the argument--location on the command line;
  • set the propertycontainer_aws/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--config-encryption-kms-key-arn=CONFIG_ENCRYPTION_KMS_KEY_ARN
Amazon Resource Name (ARN) of the AWS KMS key to encrypt the user data.
--enable-autorepair
Enable node autorepair feature for a node pool. Use --no-enable-autorepair todisable.
gcloudalphacontainerawsnode-poolsupdate--enable-autorepair
--iam-instance-profile=IAM_INSTANCE_PROFILE
Name or ARN of the IAM instance profile associated with the node pool.
--instance-type=INSTANCE_TYPE
AWS EC2 instance type for the node pool's nodes.
--max-surge-update=MAX_SURGE_UPDATE
Maximum number of extra (surge) nodes to be created beyond the current size ofthe node pool during its update process. Use --max-unavailable-update as well,if needed, to control the overall surge settings.

To create an extra node each time the node pool is rolling updated, run:

gcloudalphacontainerawsnode-poolsupdate--max-surge-update=1--max-unavailable-update=0
--max-unavailable-update=MAX_UNAVAILABLE_UPDATE
Maximum number of nodes that can be simultaneously unavailable during this nodepool's update process. Use --max-surge-update as well, if needed, to control theoverall surge settings.

To modify a node pool with 6 nodes such that, 3 nodes are updated in parallel (1+ 2), but keep at least 4 nodes (6 - 2) available each time this node pool isrolling updated, run:

gcloudalphacontainerawsnode-poolsupdate--max-surge-update=1--max-unavailable-update=2
--node-version=NODE_VERSION
Kubernetes version to use for the node pool.
--root-volume-iops=ROOT_VOLUME_IOPS
Number of I/O operations per second (IOPS) to provision for the root volume.
--root-volume-kms-key-arn=ROOT_VOLUME_KMS_KEY_ARN
Amazon Resource Name (ARN) of the AWS KMS key to encrypt the root volume.
--root-volume-size=ROOT_VOLUME_SIZE
Size of the root volume. The value must be a whole number followed by a sizeunit ofGB for gigabyte, orTB for terabyte. If nosize unit is specified, GB is assumed.
--root-volume-throughput=ROOT_VOLUME_THROUGHPUT
Throughput to provision for the root volume, in MiB/s. Only valid if the volumetype is GP3. If volume type is GP3 and throughput is not provided, it defaultsto 125.
--root-volume-type=ROOT_VOLUME_TYPE
Type of the root volume.ROOT_VOLUME_TYPE must be oneof:gp2,gp3.
--validate-only
Validate the node pool to update, but don't actually perform it.
Annotations

At most one of these can be specified:

--annotations=ANNOTATION,[ANNOTATION,…]
Annotations for the node pool.
--clear-annotations
Clear the annotations for the node pool.
Node pool autoscaling metrics collection

At most one of these can be specified:

--clear-autoscaling-metrics
Clear the cloudwatch autoscaling metrics collection associated with thenodepool.
Or at least one of these can be specified:
Update existing cloudwatch autoscaling metrics collection parameters
--autoscaling-metrics=[AUTOSCALING_METRIC,…]
Autoscaling metrics to enable. For a list of valid metrics, refer tohttps://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html.If granularity is specified but not any metrics, all metrics are enabled.
--autoscaling-metrics-granularity=AUTOSCALING_METRICS_GRANULARITY
Frequency at which EC2 Auto Scaling sends aggregated data to AWS CloudWatch. Theonly valid value is "1Minute".
Node labels

At most one of these can be specified:

--clear-node-labels
Clear the labels assigned to the node pool's nodes.
--node-labels=NODE_LABEL,[NODE_LABEL,…]
Labels assigned to the node pool's nodes.
Proxy config

At most one of these can be specified:

--clear-proxy-config
Clear the proxy configuration associated with the node pool.
Or at least one of these can be specified:
Update existing proxy config parameters
--proxy-secret-arn=PROXY_SECRET_ARN
ARN of the AWS Secrets Manager secret that contains a proxy configuration.
--proxy-secret-version-id=PROXY_SECRET_VERSION_ID
Version ID string of the AWS Secrets Manager secret that contains a proxyconfiguration.
Security groups

At most one of these can be specified:

--clear-security-group-ids
Clear any additional security groups associated with the node pool's nodes. Thisdoes not remove the default security groups.
--security-group-ids=[SECURITY_GROUP_ID,…]
IDs of additional security groups to add to the node pool's nodes.
SSH config

At most one of these can be specified:

--clear-ssh-ec2-key-pair
Clear the EC2 key pair authorized to login to the node pool's nodes.
--ssh-ec2-key-pair=SSH_EC2_KEY_PAIR
Name of the EC2 key pair authorized to login to the node pool's nodes.
Tags

At most one of these can be specified:

--clear-tags
Clear any tags associated with the node pool's nodes.
--tags=TAG,[TAG,…]
Applies the given tags (comma separated) on the node pool. Example:
gcloudalphacontainerawsnode-poolsupdateEXAMPLE_NODE_POOL--tags=tag1=one,tag2=two
Node pool autoscaling
--max-nodes=MAX_NODES
Maximum number of nodes in the node pool.
--min-nodes=MIN_NODES
Minimum number of nodes in the node pool.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gcloudcontainerawsnode-poolsupdate

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-21 UTC.