Method: projects.locations.awsClusters.patch

Updates an AwsCluster.

HTTP request

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

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
awsCluster.name

string

The name of this resource.

Cluster names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>.

See Resource Names for more details on Google Cloud Platform resource names.

Query parameters

Parameters
validateOnly

boolean

If set, only validate the request, but do not actually update the cluster.
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 AwsCluster:

  • description.
  • annotations.
  • controlPlane.version.
  • authorization.admin_users.
  • authorization.admin_groups.
  • binaryAuthorization.evaluation_mode.
  • controlPlane.aws_services_authentication.role_arn.
  • controlPlane.aws_services_authentication.role_session_name.
  • controlPlane.config_encryption.kms_key_arn.
  • controlPlane.instance_type.
  • controlPlane.security_group_ids.
  • controlPlane.proxy_config.
  • controlPlane.proxy_config.secret_arn.
  • controlPlane.proxy_config.secret_version.
  • controlPlane.root_volume.size_gib.
  • controlPlane.root_volume.volume_type.
  • controlPlane.root_volume.iops.
  • controlPlane.root_volume.throughput.
  • controlPlane.root_volume.kms_key_arn.
  • controlPlane.ssh_config.
  • controlPlane.ssh_config.ec2_key_pair.
  • controlPlane.instance_placement.tenancy.
  • controlPlane.iam_instance_profile.
  • loggingConfig.component_config.enable_components.
  • controlPlane.tags.
  • monitoringConfig.managed_prometheus_config.enabled.
  • networking.per_node_pool_sg_rules_disabled.

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 AwsCluster.

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.awsClusters.update

For more information, see the IAM documentation.