Method: projects.locations.awsClusters.awsNodePools.patch

Updates an AwsNodePool.

HTTP request

PATCH https://{endpoint}/v1/{awsNodePool.name=projects/*/locations/*/awsClusters/*/awsNodePools/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
awsNodePool.name

string

The name of this resource.

Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

For more details on Google Cloud resource names, see Resource Names

Query parameters

Parameters
validateOnly

boolean

If set, only validate the request, but don't actually update the node pool.
updateMask

string (FieldMask format)

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from AwsNodePool:

  • annotations.
  • version.
  • autoscaling.min_node_count.
  • autoscaling.max_node_count.
  • config.config_encryption.kms_key_arn.
  • config.security_group_ids.
  • config.root_volume.iops.
  • config.root_volume.throughput.
  • config.root_volume.kms_key_arn.
  • config.root_volume.volume_type.
  • config.root_volume.size_gib.
  • config.proxy_config.
  • config.proxy_config.secret_arn.
  • config.proxy_config.secret_version.
  • config.ssh_config.
  • config.ssh_config.ec2_key_pair.
  • config.instance_placement.tenancy.
  • config.iam_instance_profile.
  • config.labels.
  • config.tags.
  • config.autoscaling_metrics_collection.
  • config.autoscaling_metrics_collection.granularity.
  • config.autoscaling_metrics_collection.metrics.
  • config.instance_type.
  • management.auto_repair.
  • management.
  • updateSettings.
  • updateSettings.surge_settings.
  • updateSettings.surge_settings.max_surge.
  • updateSettings.surge_settings.max_unavailable.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of AwsNodePool.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • gkemulticloud.awsNodePools.update

For more information, see the IAM documentation.