AwsClustersAsyncClient(*, 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]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = 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
AwsClustersAsyncClient
AwsClustersAsyncClient(*, 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]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the aws clusters async 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 to use. 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 |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError |
If mutual TLS transport creation failed for any reason. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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 |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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
async def sample_create_aws_cluster():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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 = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.CreateAwsClusterRequest, dict]]
The request object. Request message for |
parent |
Required. The parent location where this AwsCluster resource will be created. Location names are formatted as |
aws_cluster |
AwsCluster
Required. The specification of the AwsCluster to create. This corresponds to the |
aws_cluster_id |
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 |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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
async def sample_create_aws_node_pool():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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 = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.CreateAwsNodePoolRequest, dict]]
The request object. Response message for |
parent |
Required. The AwsCluster resource where this node pool will be created. |
aws_node_pool |
AwsNodePool
Required. The specification of the AwsNodePool to create. This corresponds to the |
aws_node_pool_id |
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 |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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
async def sample_delete_aws_cluster():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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 = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.DeleteAwsClusterRequest, dict]]
The request object. Request message for |
name |
Required. The resource name the AwsCluster to delete. |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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
async def sample_delete_aws_node_pool():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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 = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.DeleteAwsNodePoolRequest, dict]]
The request object. Request message for |
name |
Required. The resource name the AwsNodePool to delete. |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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 |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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 |
AwsClustersAsyncClient |
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 |
AwsClustersAsyncClient |
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 |
AwsClustersAsyncClient |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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
async def sample_generate_aws_access_token():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# Initialize request argument(s)
request = gke_multicloud_v1.GenerateAwsAccessTokenRequest(
aws_cluster="aws_cluster_value",
)
# Make the request
response = await client.generate_aws_access_token(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.GenerateAwsAccessTokenRequest, dict]]
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
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
async def sample_generate_aws_cluster_agent_token():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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 = await client.generate_aws_cluster_agent_token(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.GenerateAwsClusterAgentTokenRequest, dict]]
The request object. |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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
async def sample_get_aws_cluster():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# Initialize request argument(s)
request = gke_multicloud_v1.GetAwsClusterRequest(
name="name_value",
)
# Make the request
response = await client.get_aws_cluster(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.GetAwsClusterRequest, dict]]
The request object. Request message for |
name |
Required. The name of the AwsCluster resource to describe. |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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
async def sample_get_aws_json_web_keys():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# Initialize request argument(s)
request = gke_multicloud_v1.GetAwsJsonWebKeysRequest(
aws_cluster="aws_cluster_value",
)
# Make the request
response = await client.get_aws_json_web_keys(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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
async def sample_get_aws_node_pool():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# Initialize request argument(s)
request = gke_multicloud_v1.GetAwsNodePoolRequest(
name="name_value",
)
# Make the request
response = await client.get_aws_node_pool(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.GetAwsNodePoolRequest, dict]]
The request object. Request message for |
name |
Required. The name of the AwsNodePool resource to describe. |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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
async def sample_get_aws_open_id_config():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# Initialize request argument(s)
request = gke_multicloud_v1.GetAwsOpenIdConfigRequest(
aws_cluster="aws_cluster_value",
)
# Make the request
response = await client.get_aws_open_id_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[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_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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
async def sample_get_aws_server_config():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# Initialize request argument(s)
request = gke_multicloud_v1.GetAwsServerConfigRequest(
name="name_value",
)
# Make the request
response = await client.get_aws_server_config(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.GetAwsServerConfigRequest, dict]]
The request object. GetAwsServerConfigRequest gets the server config of GKE cluster on AWS. |
name |
Required. The name of the AwsServerConfig resource to describe. |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
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,
)
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 |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
|
An Operation object. |
get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.gke_multicloud_v1.services.aws_clusters.transports.base.AwsClustersTransport
]
)
Returns an appropriate transport class.
Parameter | |
---|---|
Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.gke_multicloud_v1.services.aws_clusters.pagers.ListAwsClustersAsyncPager
)
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
async def sample_list_aws_clusters():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.ListAwsClustersRequest, dict]]
The request object. Request message for |
parent |
Required. The parent location which owns this collection of AwsCluster resources. Location names are formatted as |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.gke_multicloud_v1.services.aws_clusters.pagers.ListAwsClustersAsyncPager |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.gke_multicloud_v1.services.aws_clusters.pagers.ListAwsNodePoolsAsyncPager
)
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
async def sample_list_aws_node_pools():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.ListAwsNodePoolsRequest, dict]]
The request object. Request message for |
parent |
Required. The parent |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.gke_multicloud_v1.services.aws_clusters.pagers.ListAwsNodePoolsAsyncPager |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
|
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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
async def sample_rollback_aws_node_pool_update():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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 = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.RollbackAwsNodePoolUpdateRequest, dict]]
The request object. Request message for |
name |
Required. The name of the AwsNodePool resource to rollback. |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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
async def sample_update_aws_cluster():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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 = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.UpdateAwsClusterRequest, dict]]
The request object. Request message for |
aws_cluster |
AwsCluster
Required. The AwsCluster resource to update. This corresponds to the |
update_mask |
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: - |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
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
async def sample_update_aws_node_pool():
# Create a client
client = gke_multicloud_v1.AwsClustersAsyncClient()
# 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 = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.gke_multicloud_v1.types.UpdateAwsNodePoolRequest, dict]]
The request object. Request message for |
aws_node_pool |
AwsNodePool
Required. The AwsNodePool resource to update. This corresponds to the |
update_mask |
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: - |
retry |
google.api_core.retry_async.AsyncRetry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be AwsNodePool An Anthos node pool running on AWS. |