Method: projects.locations.awsClusters.awsNodePools.delete

Deletes a specific AwsNodePool resource.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

HTTP request

DELETE https://{endpoint}/v1/{name=projects/*/locations/*/awsClusters/*/awsNodePools/*}

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name the AwsNodePool to delete.

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

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

Query parameters

Parameters
validateOnly

boolean

If set, only validate the request, but do not actually delete the node pool.

allowMissing

boolean

If set to true, and the AwsNodePool resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

Useful for idempotent deletion.

ignoreErrors

boolean

Optional. If set to true, the deletion of AwsNodePool resource will succeed even if errors occur during deleting in node pool resources. Using this parameter may result in orphaned resources in the node pool.

etag

string

The current ETag of the AwsNodePool.

Allows clients to perform deletions through optimistic concurrency control.

If the provided ETag does not match the current etag of the node pool, the request will fail and an ABORTED error will be returned.

Request body

The request body must be empty.

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

For more information, see the IAM documentation.