Class AwsClustersClient (0.6.16) 

AwsClustersClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.gke_multicloud_v1.services.aws_clusters.transports.base.AwsClustersTransport, typing.Callable[[...], google.cloud.gke_multicloud_v1.services.aws_clusters.transports.base.AwsClustersTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
AwsClustersTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

AwsClustersClient

AwsClustersClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.gke_multicloud_v1.services.aws_clusters.transports.base.AwsClustersTransport, typing.Callable[[...], google.cloud.gke_multicloud_v1.services.aws_clusters.transports.base.AwsClustersTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the aws clusters client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,AwsClustersTransport,Callable[..., AwsClustersTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the AwsClustersTransport constructor. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

aws_cluster_path

aws_cluster_path(project: str, location: str, aws_cluster: str) -> str

Returns a fully-qualified aws_cluster string.

aws_node_pool_path

aws_node_pool_path(
    project: str, location: str, aws_cluster: str, aws_node_pool: str
) -> str

Returns a fully-qualified aws_node_pool string.

aws_server_config_path

aws_server_config_path(project: str, location: str) -> str

Returns a fully-qualified aws_server_config string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_aws_cluster

create_aws_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.CreateAwsClusterRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    aws_cluster: typing.Optional[
        google.cloud.gke_multicloud_v1.types.aws_resources.AwsCluster
    ] = None,
    aws_cluster_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a new xref_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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_create_aws_cluster():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    aws_cluster = gke_multicloud_v1.AwsCluster()
    aws_cluster.networking.vpc_id = "vpc_id_value"
    aws_cluster.networking.pod_address_cidr_blocks = ['pod_address_cidr_blocks_value1', 'pod_address_cidr_blocks_value2']
    aws_cluster.networking.service_address_cidr_blocks = ['service_address_cidr_blocks_value1', 'service_address_cidr_blocks_value2']
    aws_cluster.aws_region = "aws_region_value"
    aws_cluster.control_plane.version = "version_value"
    aws_cluster.control_plane.subnet_ids = ['subnet_ids_value1', 'subnet_ids_value2']
    aws_cluster.control_plane.iam_instance_profile = "iam_instance_profile_value"
    aws_cluster.control_plane.database_encryption.kms_key_arn = "kms_key_arn_value"
    aws_cluster.control_plane.aws_services_authentication.role_arn = "role_arn_value"
    aws_cluster.control_plane.config_encryption.kms_key_arn = "kms_key_arn_value"
    aws_cluster.fleet.project = "project_value"

    request = gke_multicloud_v1.CreateAwsClusterRequest(
        parent="parent_value",
        aws_cluster=aws_cluster,
        aws_cluster_id="aws_cluster_id_value",
    )

    # Make the request
    operation = client.create_aws_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.CreateAwsClusterRequest, dict]

The request object. Request message for AwsClusters.CreateAwsCluster method.
parent str

Required. The parent location where this AwsCluster resource will be created. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
aws_cluster google.cloud.gke_multicloud_v1.types.AwsCluster

Required. The specification of the AwsCluster to create. This corresponds to the aws_cluster field on the request instance; if request is provided, this should not be set.
aws_cluster_id str

Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AwsCluster resource name formatted as projects/. Valid characters are /a-z][0-9]-/. Cannot be longer than 63 characters. This corresponds to the aws_cluster_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AwsCluster An Anthos cluster running on AWS.

create_aws_node_pool

create_aws_node_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.CreateAwsNodePoolRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    aws_node_pool: typing.Optional[
        google.cloud.gke_multicloud_v1.types.aws_resources.AwsNodePool
    ] = None,
    aws_node_pool_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a new xref_AwsNodePool, attached to a given xref_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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_create_aws_node_pool():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    aws_node_pool = gke_multicloud_v1.AwsNodePool()
    aws_node_pool.version = "version_value"
    aws_node_pool.config.iam_instance_profile = "iam_instance_profile_value"
    aws_node_pool.config.config_encryption.kms_key_arn = "kms_key_arn_value"
    aws_node_pool.autoscaling.min_node_count = 1489
    aws_node_pool.autoscaling.max_node_count = 1491
    aws_node_pool.subnet_id = "subnet_id_value"
    aws_node_pool.max_pods_constraint.max_pods_per_node = 1798

    request = gke_multicloud_v1.CreateAwsNodePoolRequest(
        parent="parent_value",
        aws_node_pool=aws_node_pool,
        aws_node_pool_id="aws_node_pool_id_value",
    )

    # Make the request
    operation = client.create_aws_node_pool(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.CreateAwsNodePoolRequest, dict]

The request object. Response message for AwsClusters.CreateAwsNodePool method.
parent str

Required. The AwsCluster resource where this node pool will be created. AwsCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
aws_node_pool google.cloud.gke_multicloud_v1.types.AwsNodePool

Required. The specification of the AwsNodePool to create. This corresponds to the aws_node_pool field on the request instance; if request is provided, this should not be set.
aws_node_pool_id str

Required. A client provided ID the resource. Must be unique within the parent resource. The provided ID will be part of the AwsNodePool resource name formatted as projects/. Valid characters are /a-z][0-9]-/. Cannot be longer than 63 characters. This corresponds to the aws_node_pool_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AwsNodePool An Anthos node pool running on AWS.

delete_aws_cluster

delete_aws_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.DeleteAwsClusterRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a specific xref_AwsCluster resource.

Fails if the cluster has one or more associated xref_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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_delete_aws_cluster():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.DeleteAwsClusterRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_aws_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.DeleteAwsClusterRequest, dict]

The request object. Request message for AwsClusters.DeleteAwsCluster method.
name str

Required. The resource name the AwsCluster to delete. AwsCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud Platform resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_aws_node_pool

delete_aws_node_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.DeleteAwsNodePoolRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a specific xref_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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_delete_aws_node_pool():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.DeleteAwsNodePoolRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_aws_node_pool(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.DeleteAwsNodePoolRequest, dict]

The request object. Request message for AwsClusters.DeleteAwsNodePool method.
name str

Required. The resource name the AwsNodePool to delete. AwsNodePool names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
AwsClustersClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
AwsClustersClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
AwsClustersClient The constructed client.

generate_aws_access_token

generate_aws_access_token(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.GenerateAwsAccessTokenRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gke_multicloud_v1.types.aws_service.GenerateAwsAccessTokenResponse

Generates a short-lived access token to authenticate to a given xref_AwsCluster resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_generate_aws_access_token():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GenerateAwsAccessTokenRequest(
        aws_cluster="aws_cluster_value",
    )

    # Make the request
    response = client.generate_aws_access_token(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GenerateAwsAccessTokenRequest, dict]

The request object. Request message for AwsClusters.GenerateAwsAccessToken method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.gke_multicloud_v1.types.GenerateAwsAccessTokenResponse Response message for AwsClusters.GenerateAwsAccessToken method.

generate_aws_cluster_agent_token

generate_aws_cluster_agent_token(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.GenerateAwsClusterAgentTokenRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.gke_multicloud_v1.types.aws_service.GenerateAwsClusterAgentTokenResponse
)

Generates an access token for a cluster agent.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_generate_aws_cluster_agent_token():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GenerateAwsClusterAgentTokenRequest(
        aws_cluster="aws_cluster_value",
        subject_token="subject_token_value",
        subject_token_type="subject_token_type_value",
        version="version_value",
    )

    # Make the request
    response = client.generate_aws_cluster_agent_token(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GenerateAwsClusterAgentTokenRequest, dict]

The request object.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

get_aws_cluster

get_aws_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.GetAwsClusterRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gke_multicloud_v1.types.aws_resources.AwsCluster

Describes a specific xref_AwsCluster resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_get_aws_cluster():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAwsClusterRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_aws_cluster(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GetAwsClusterRequest, dict]

The request object. Request message for AwsClusters.GetAwsCluster method.
name str

Required. The name of the AwsCluster resource to describe. AwsCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud Platform resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.gke_multicloud_v1.types.AwsCluster An Anthos cluster running on AWS.

get_aws_json_web_keys

get_aws_json_web_keys(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.GetAwsJsonWebKeysRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gke_multicloud_v1.types.aws_resources.AwsJsonWebKeys

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_get_aws_json_web_keys():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAwsJsonWebKeysRequest(
        aws_cluster="aws_cluster_value",
    )

    # Make the request
    response = client.get_aws_json_web_keys(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GetAwsJsonWebKeysRequest, dict]

The request object. GetAwsJsonWebKeysRequest gets the public component of the keys used by the cluster to sign token requests. This will be the jwks_uri for the discover document returned by getOpenIDConfig. See the OpenID Connect Discovery 1.0 specification for details.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.gke_multicloud_v1.types.AwsJsonWebKeys AwsJsonWebKeys is a valid JSON Web Key Set as specififed in RFC 7517.

get_aws_node_pool

get_aws_node_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.GetAwsNodePoolRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gke_multicloud_v1.types.aws_resources.AwsNodePool

Describes a specific xref_AwsNodePool resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_get_aws_node_pool():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAwsNodePoolRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_aws_node_pool(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GetAwsNodePoolRequest, dict]

The request object. Request message for AwsClusters.GetAwsNodePool method.
name str

Required. The name of the AwsNodePool resource to describe. AwsNodePool names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.gke_multicloud_v1.types.AwsNodePool An Anthos node pool running on AWS.

get_aws_open_id_config

get_aws_open_id_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.GetAwsOpenIdConfigRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gke_multicloud_v1.types.aws_resources.AwsOpenIdConfig

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification <https://openid.net/specs/openid-connect-discovery-1_0.html>__ for details.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_get_aws_open_id_config():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAwsOpenIdConfigRequest(
        aws_cluster="aws_cluster_value",
    )

    # Make the request
    response = client.get_aws_open_id_config(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GetAwsOpenIdConfigRequest, dict]

The request object. GetAwsOpenIdConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.gke_multicloud_v1.types.AwsOpenIdConfig AwsOpenIdConfig is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

get_aws_server_config

get_aws_server_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.GetAwsServerConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gke_multicloud_v1.types.aws_resources.AwsServerConfig

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_get_aws_server_config():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.GetAwsServerConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_aws_server_config(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.GetAwsServerConfigRequest, dict]

The request object. GetAwsServerConfigRequest gets the server config of GKE cluster on AWS.
name str

Required. The name of the AwsServerConfig resource to describe. AwsServerConfig names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.gke_multicloud_v1.types.AwsServerConfig AwsServerConfig is the configuration of GKE cluster on AWS.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.Operation An Operation object.

list_aws_clusters

list_aws_clusters(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.ListAwsClustersRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gke_multicloud_v1.services.aws_clusters.pagers.ListAwsClustersPager

Lists all xref_AwsCluster resources on a given Google Cloud project and region.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_list_aws_clusters():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.ListAwsClustersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_aws_clusters(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.ListAwsClustersRequest, dict]

The request object. Request message for AwsClusters.ListAwsClusters method.
parent str

Required. The parent location which owns this collection of AwsCluster resources. Location names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud Platform resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.gke_multicloud_v1.services.aws_clusters.pagers.ListAwsClustersPager Response message for AwsClusters.ListAwsClusters method. Iterating over this object will yield results and resolve additional pages automatically.

list_aws_node_pools

list_aws_node_pools(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.ListAwsNodePoolsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.gke_multicloud_v1.services.aws_clusters.pagers.ListAwsNodePoolsPager

Lists all xref_AwsNodePool resources on a given xref_AwsCluster.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_list_aws_node_pools():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.ListAwsNodePoolsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_aws_node_pools(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.ListAwsNodePoolsRequest, dict]

The request object. Request message for AwsClusters.ListAwsNodePools method.
parent str

Required. The parent AwsCluster which owns this collection of AwsNodePool resources. AwsCluster names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.gke_multicloud_v1.services.aws_clusters.pagers.ListAwsNodePoolsPager Response message for AwsClusters.ListAwsNodePools method. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

parse_aws_cluster_path

parse_aws_cluster_path(path: str) -> typing.Dict[str, str]

Parses a aws_cluster path into its component segments.

parse_aws_node_pool_path

parse_aws_node_pool_path(path: str) -> typing.Dict[str, str]

Parses a aws_node_pool path into its component segments.

parse_aws_server_config_path

parse_aws_server_config_path(path: str) -> typing.Dict[str, str]

Parses a aws_server_config path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

rollback_aws_node_pool_update

rollback_aws_node_pool_update(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.RollbackAwsNodePoolUpdateRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Rolls back a previously aborted or failed xref_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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_rollback_aws_node_pool_update():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    request = gke_multicloud_v1.RollbackAwsNodePoolUpdateRequest(
        name="name_value",
    )

    # Make the request
    operation = client.rollback_aws_node_pool_update(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.RollbackAwsNodePoolUpdateRequest, dict]

The request object. Request message for AwsClusters.RollbackAwsNodePoolUpdate method.
name str

Required. The name of the AwsNodePool resource to rollback. AwsNodePool names are formatted as projects/. See Resource Names https://cloud.google.com/apis/design/resource_names__ for more details on Google Cloud resource names. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AwsNodePool An Anthos node pool running on AWS.

update_aws_cluster

update_aws_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.UpdateAwsClusterRequest,
            dict,
        ]
    ] = None,
    *,
    aws_cluster: typing.Optional[
        google.cloud.gke_multicloud_v1.types.aws_resources.AwsCluster
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates an xref_AwsCluster.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_update_aws_cluster():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    aws_cluster = gke_multicloud_v1.AwsCluster()
    aws_cluster.networking.vpc_id = "vpc_id_value"
    aws_cluster.networking.pod_address_cidr_blocks = ['pod_address_cidr_blocks_value1', 'pod_address_cidr_blocks_value2']
    aws_cluster.networking.service_address_cidr_blocks = ['service_address_cidr_blocks_value1', 'service_address_cidr_blocks_value2']
    aws_cluster.aws_region = "aws_region_value"
    aws_cluster.control_plane.version = "version_value"
    aws_cluster.control_plane.subnet_ids = ['subnet_ids_value1', 'subnet_ids_value2']
    aws_cluster.control_plane.iam_instance_profile = "iam_instance_profile_value"
    aws_cluster.control_plane.database_encryption.kms_key_arn = "kms_key_arn_value"
    aws_cluster.control_plane.aws_services_authentication.role_arn = "role_arn_value"
    aws_cluster.control_plane.config_encryption.kms_key_arn = "kms_key_arn_value"
    aws_cluster.fleet.project = "project_value"

    request = gke_multicloud_v1.UpdateAwsClusterRequest(
        aws_cluster=aws_cluster,
    )

    # Make the request
    operation = client.update_aws_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.UpdateAwsClusterRequest, dict]

The request object. Request message for AwsClusters.UpdateAwsCluster method.
aws_cluster google.cloud.gke_multicloud_v1.types.AwsCluster

Required. The AwsCluster resource to update. This corresponds to the aws_cluster field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

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. - control_plane.version. - authorization.admin_users. - authorization.admin_groups. - binary_authorization.evaluation_mode. - control_plane.aws_services_authentication.role_arn. - control_plane.aws_services_authentication.role_session_name. - control_plane.config_encryption.kms_key_arn. - control_plane.instance_type. - control_plane.security_group_ids. - control_plane.proxy_config. - control_plane.proxy_config.secret_arn. - control_plane.proxy_config.secret_version. - control_plane.root_volume.size_gib. - control_plane.root_volume.volume_type. - control_plane.root_volume.iops. - control_plane.root_volume.throughput. - control_plane.root_volume.kms_key_arn. - control_plane.ssh_config. - control_plane.ssh_config.ec2_key_pair. - control_plane.instance_placement.tenancy. - control_plane.iam_instance_profile. - logging_config.component_config.enable_components. - control_plane.tags. - monitoring_config.managed_prometheus_config.enabled. - networking.per_node_pool_sg_rules_disabled. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AwsCluster An Anthos cluster running on AWS.

update_aws_node_pool

update_aws_node_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.gke_multicloud_v1.types.aws_service.UpdateAwsNodePoolRequest,
            dict,
        ]
    ] = None,
    *,
    aws_node_pool: typing.Optional[
        google.cloud.gke_multicloud_v1.types.aws_resources.AwsNodePool
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates an xref_AwsNodePool.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import gke_multicloud_v1

def sample_update_aws_node_pool():
    # Create a client
    client = gke_multicloud_v1.AwsClustersClient()

    # Initialize request argument(s)
    aws_node_pool = gke_multicloud_v1.AwsNodePool()
    aws_node_pool.version = "version_value"
    aws_node_pool.config.iam_instance_profile = "iam_instance_profile_value"
    aws_node_pool.config.config_encryption.kms_key_arn = "kms_key_arn_value"
    aws_node_pool.autoscaling.min_node_count = 1489
    aws_node_pool.autoscaling.max_node_count = 1491
    aws_node_pool.subnet_id = "subnet_id_value"
    aws_node_pool.max_pods_constraint.max_pods_per_node = 1798

    request = gke_multicloud_v1.UpdateAwsNodePoolRequest(
        aws_node_pool=aws_node_pool,
    )

    # Make the request
    operation = client.update_aws_node_pool(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.gke_multicloud_v1.types.UpdateAwsNodePoolRequest, dict]

The request object. Request message for AwsClusters.UpdateAwsNodePool method.
aws_node_pool google.cloud.gke_multicloud_v1.types.AwsNodePool

Required. The AwsNodePool resource to update. This corresponds to the aws_node_pool field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

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. - update_settings. - update_settings.surge_settings. - update_settings.surge_settings.max_surge. - update_settings.surge_settings.max_unavailable. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AwsNodePool An Anthos node pool running on AWS.