Anthos Multi-Cloud v1 API - Class AwsClustersClientImpl (2.5.0) 

public sealed class AwsClustersClientImpl : AwsClustersClient

Reference documentation and code samples for the Anthos Multi-Cloud v1 API class AwsClustersClientImpl.

AwsClusters client wrapper implementation, for convenient use.

Inheritance

object > AwsClustersClient > AwsClustersClientImpl

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Remarks

The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure.

Constructors

AwsClustersClientImpl(AwsClustersClient, AwsClustersSettings, ILogger)

public AwsClustersClientImpl(AwsClusters.AwsClustersClient grpcClient, AwsClustersSettings settings, ILogger logger)

Constructs a client wrapper for the AwsClusters service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient AwsClustersAwsClustersClient

The underlying gRPC client.
settings AwsClustersSettings

The base AwsClustersSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateAwsClusterOperationsClient

public override OperationsClient CreateAwsClusterOperationsClient { get; }

The long-running operations client for CreateAwsCluster.

Property Value
Type Description
OperationsClient
Overrides

CreateAwsNodePoolOperationsClient

public override OperationsClient CreateAwsNodePoolOperationsClient { get; }

The long-running operations client for CreateAwsNodePool.

Property Value
Type Description
OperationsClient
Overrides

DeleteAwsClusterOperationsClient

public override OperationsClient DeleteAwsClusterOperationsClient { get; }

The long-running operations client for DeleteAwsCluster.

Property Value
Type Description
OperationsClient
Overrides

DeleteAwsNodePoolOperationsClient

public override OperationsClient DeleteAwsNodePoolOperationsClient { get; }

The long-running operations client for DeleteAwsNodePool.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override AwsClusters.AwsClustersClient GrpcClient { get; }

The underlying gRPC AwsClusters client

Property Value
Type Description
AwsClustersAwsClustersClient
Overrides

RollbackAwsNodePoolUpdateOperationsClient

public override OperationsClient RollbackAwsNodePoolUpdateOperationsClient { get; }

The long-running operations client for RollbackAwsNodePoolUpdate.

Property Value
Type Description
OperationsClient
Overrides

UpdateAwsClusterOperationsClient

public override OperationsClient UpdateAwsClusterOperationsClient { get; }

The long-running operations client for UpdateAwsCluster.

Property Value
Type Description
OperationsClient
Overrides

UpdateAwsNodePoolOperationsClient

public override OperationsClient UpdateAwsNodePoolOperationsClient { get; }

The long-running operations client for UpdateAwsNodePool.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateAwsCluster(CreateAwsClusterRequest, CallSettings)

public override Operation<AwsCluster, OperationMetadata> CreateAwsCluster(CreateAwsClusterRequest request, CallSettings callSettings = null)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given Google Cloud Platform project and region.

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

Parameters
Name Description
request CreateAwsClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAwsClusterOperationMetadata

The RPC response.
Overrides

CreateAwsClusterAsync(CreateAwsClusterRequest, CallSettings)

public override Task<Operation<AwsCluster, OperationMetadata>> CreateAwsClusterAsync(CreateAwsClusterRequest request, CallSettings callSettings = null)

Creates a new [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource on a given Google Cloud Platform project and region.

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

Parameters
Name Description
request CreateAwsClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAwsClusterOperationMetadata

A Task containing the RPC response.
Overrides

CreateAwsNodePool(CreateAwsNodePoolRequest, CallSettings)

public override Operation<AwsNodePool, OperationMetadata> CreateAwsNodePool(CreateAwsNodePoolRequest request, CallSettings callSettings = null)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

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

Parameters
Name Description
request CreateAwsNodePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAwsNodePoolOperationMetadata

The RPC response.
Overrides

CreateAwsNodePoolAsync(CreateAwsNodePoolRequest, CallSettings)

public override Task<Operation<AwsNodePool, OperationMetadata>> CreateAwsNodePoolAsync(CreateAwsNodePoolRequest request, CallSettings callSettings = null)

Creates a new [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool], attached to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

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

Parameters
Name Description
request CreateAwsNodePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAwsNodePoolOperationMetadata

A Task containing the RPC response.
Overrides

DeleteAwsCluster(DeleteAwsClusterRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteAwsCluster(DeleteAwsClusterRequest request, CallSettings callSettings = null)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

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

Parameters
Name Description
request DeleteAwsClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteAwsClusterAsync(DeleteAwsClusterRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteAwsClusterAsync(DeleteAwsClusterRequest request, CallSettings callSettings = null)

Deletes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Fails if the cluster has one or more associated [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources.

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

Parameters
Name Description
request DeleteAwsClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteAwsNodePool(DeleteAwsNodePoolRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteAwsNodePool(DeleteAwsNodePoolRequest request, CallSettings callSettings = null)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

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

Parameters
Name Description
request DeleteAwsNodePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteAwsNodePoolAsync(DeleteAwsNodePoolRequest request, CallSettings callSettings = null)

Deletes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

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

Parameters
Name Description
request DeleteAwsNodePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GenerateAwsAccessToken(GenerateAwsAccessTokenRequest, CallSettings)

public override GenerateAwsAccessTokenResponse GenerateAwsAccessToken(GenerateAwsAccessTokenRequest request, CallSettings callSettings = null)

Generates a short-lived access token to authenticate to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
Name Description
request GenerateAwsAccessTokenRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateAwsAccessTokenResponse

The RPC response.
Overrides

GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest, CallSettings)

public override Task<GenerateAwsAccessTokenResponse> GenerateAwsAccessTokenAsync(GenerateAwsAccessTokenRequest request, CallSettings callSettings = null)

Generates a short-lived access token to authenticate to a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
Name Description
request GenerateAwsAccessTokenRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateAwsAccessTokenResponse

A Task containing the RPC response.
Overrides

GenerateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest, CallSettings)

public override GenerateAwsClusterAgentTokenResponse GenerateAwsClusterAgentToken(GenerateAwsClusterAgentTokenRequest request, CallSettings callSettings = null)

Generates an access token for a cluster agent.

Parameters
Name Description
request GenerateAwsClusterAgentTokenRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateAwsClusterAgentTokenResponse

The RPC response.
Overrides

GenerateAwsClusterAgentTokenAsync(GenerateAwsClusterAgentTokenRequest, CallSettings)

public override Task<GenerateAwsClusterAgentTokenResponse> GenerateAwsClusterAgentTokenAsync(GenerateAwsClusterAgentTokenRequest request, CallSettings callSettings = null)

Generates an access token for a cluster agent.

Parameters
Name Description
request GenerateAwsClusterAgentTokenRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateAwsClusterAgentTokenResponse

A Task containing the RPC response.
Overrides

GetAwsCluster(GetAwsClusterRequest, CallSettings)

public override AwsCluster GetAwsCluster(GetAwsClusterRequest request, CallSettings callSettings = null)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
Name Description
request GetAwsClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AwsCluster

The RPC response.
Overrides

GetAwsClusterAsync(GetAwsClusterRequest, CallSettings)

public override Task<AwsCluster> GetAwsClusterAsync(GetAwsClusterRequest request, CallSettings callSettings = null)

Describes a specific [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resource.

Parameters
Name Description
request GetAwsClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAwsCluster

A Task containing the RPC response.
Overrides

GetAwsJsonWebKeys(GetAwsJsonWebKeysRequest, CallSettings)

public override AwsJsonWebKeys GetAwsJsonWebKeys(GetAwsJsonWebKeysRequest request, CallSettings callSettings = null)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
Name Description
request GetAwsJsonWebKeysRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AwsJsonWebKeys

The RPC response.
Overrides

GetAwsJsonWebKeysAsync(GetAwsJsonWebKeysRequest, CallSettings)

public override Task<AwsJsonWebKeys> GetAwsJsonWebKeysAsync(GetAwsJsonWebKeysRequest request, CallSettings callSettings = null)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
Name Description
request GetAwsJsonWebKeysRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAwsJsonWebKeys

A Task containing the RPC response.
Overrides

GetAwsNodePool(GetAwsNodePoolRequest, CallSettings)

public override AwsNodePool GetAwsNodePool(GetAwsNodePoolRequest request, CallSettings callSettings = null)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
Name Description
request GetAwsNodePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AwsNodePool

The RPC response.
Overrides

GetAwsNodePoolAsync(GetAwsNodePoolRequest, CallSettings)

public override Task<AwsNodePool> GetAwsNodePoolAsync(GetAwsNodePoolRequest request, CallSettings callSettings = null)

Describes a specific [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resource.

Parameters
Name Description
request GetAwsNodePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAwsNodePool

A Task containing the RPC response.
Overrides

GetAwsOpenIdConfig(GetAwsOpenIdConfigRequest, CallSettings)

public override AwsOpenIdConfig GetAwsOpenIdConfig(GetAwsOpenIdConfigRequest request, CallSettings callSettings = null)

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

Parameters
Name Description
request GetAwsOpenIdConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AwsOpenIdConfig

The RPC response.
Overrides

GetAwsOpenIdConfigAsync(GetAwsOpenIdConfigRequest, CallSettings)

public override Task<AwsOpenIdConfig> GetAwsOpenIdConfigAsync(GetAwsOpenIdConfigRequest request, CallSettings callSettings = null)

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

Parameters
Name Description
request GetAwsOpenIdConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAwsOpenIdConfig

A Task containing the RPC response.
Overrides

GetAwsServerConfig(GetAwsServerConfigRequest, CallSettings)

public override AwsServerConfig GetAwsServerConfig(GetAwsServerConfigRequest request, CallSettings callSettings = null)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
Name Description
request GetAwsServerConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AwsServerConfig

The RPC response.
Overrides

GetAwsServerConfigAsync(GetAwsServerConfigRequest, CallSettings)

public override Task<AwsServerConfig> GetAwsServerConfigAsync(GetAwsServerConfigRequest request, CallSettings callSettings = null)

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Parameters
Name Description
request GetAwsServerConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAwsServerConfig

A Task containing the RPC response.
Overrides

ListAwsClusters(ListAwsClustersRequest, CallSettings)

public override PagedEnumerable<ListAwsClustersResponse, AwsCluster> ListAwsClusters(ListAwsClustersRequest request, CallSettings callSettings = null)

Lists all [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources on a given Google Cloud project and region.

Parameters
Name Description
request ListAwsClustersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAwsClustersResponseAwsCluster

A pageable sequence of AwsCluster resources.
Overrides

ListAwsClustersAsync(ListAwsClustersRequest, CallSettings)

public override PagedAsyncEnumerable<ListAwsClustersResponse, AwsCluster> ListAwsClustersAsync(ListAwsClustersRequest request, CallSettings callSettings = null)

Lists all [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster] resources on a given Google Cloud project and region.

Parameters
Name Description
request ListAwsClustersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAwsClustersResponseAwsCluster

A pageable asynchronous sequence of AwsCluster resources.
Overrides

ListAwsNodePools(ListAwsNodePoolsRequest, CallSettings)

public override PagedEnumerable<ListAwsNodePoolsResponse, AwsNodePool> ListAwsNodePools(ListAwsNodePoolsRequest request, CallSettings callSettings = null)

Lists all [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources on a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
Name Description
request ListAwsNodePoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListAwsNodePoolsResponseAwsNodePool

A pageable sequence of AwsNodePool resources.
Overrides

ListAwsNodePoolsAsync(ListAwsNodePoolsRequest, CallSettings)

public override PagedAsyncEnumerable<ListAwsNodePoolsResponse, AwsNodePool> ListAwsNodePoolsAsync(ListAwsNodePoolsRequest request, CallSettings callSettings = null)

Lists all [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] resources on a given [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
Name Description
request ListAwsNodePoolsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListAwsNodePoolsResponseAwsNodePool

A pageable asynchronous sequence of AwsNodePool resources.
Overrides

RollbackAwsNodePoolUpdate(RollbackAwsNodePoolUpdateRequest, CallSettings)

public override Operation<AwsNodePool, OperationMetadata> RollbackAwsNodePoolUpdate(RollbackAwsNodePoolUpdateRequest request, CallSettings callSettings = null)

Rolls back a previously aborted or failed [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] update request. Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.

Parameters
Name Description
request RollbackAwsNodePoolUpdateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAwsNodePoolOperationMetadata

The RPC response.
Overrides

RollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest, CallSettings)

public override Task<Operation<AwsNodePool, OperationMetadata>> RollbackAwsNodePoolUpdateAsync(RollbackAwsNodePoolUpdateRequest request, CallSettings callSettings = null)

Rolls back a previously aborted or failed [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool] update request. Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.

Parameters
Name Description
request RollbackAwsNodePoolUpdateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAwsNodePoolOperationMetadata

A Task containing the RPC response.
Overrides

UpdateAwsCluster(UpdateAwsClusterRequest, CallSettings)

public override Operation<AwsCluster, OperationMetadata> UpdateAwsCluster(UpdateAwsClusterRequest request, CallSettings callSettings = null)

Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
Name Description
request UpdateAwsClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAwsClusterOperationMetadata

The RPC response.
Overrides

UpdateAwsClusterAsync(UpdateAwsClusterRequest, CallSettings)

public override Task<Operation<AwsCluster, OperationMetadata>> UpdateAwsClusterAsync(UpdateAwsClusterRequest request, CallSettings callSettings = null)

Updates an [AwsCluster][google.cloud.gkemulticloud.v1.AwsCluster].

Parameters
Name Description
request UpdateAwsClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAwsClusterOperationMetadata

A Task containing the RPC response.
Overrides

UpdateAwsNodePool(UpdateAwsNodePoolRequest, CallSettings)

public override Operation<AwsNodePool, OperationMetadata> UpdateAwsNodePool(UpdateAwsNodePoolRequest request, CallSettings callSettings = null)

Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].

Parameters
Name Description
request UpdateAwsNodePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationAwsNodePoolOperationMetadata

The RPC response.
Overrides

UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest, CallSettings)

public override Task<Operation<AwsNodePool, OperationMetadata>> UpdateAwsNodePoolAsync(UpdateAwsNodePoolRequest request, CallSettings callSettings = null)

Updates an [AwsNodePool][google.cloud.gkemulticloud.v1.AwsNodePool].

Parameters
Name Description
request UpdateAwsNodePoolRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationAwsNodePoolOperationMetadata

A Task containing the RPC response.
Overrides