AwsClustersAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.gke_multicloud_v1.services.aws_clusters.transports.base.AwsClustersTransport] = 'grpc_asyncio', client_options: 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
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
AwsClustersTransport | The transport used by the client instance. |
Methods
AwsClustersAsyncClient
AwsClustersAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.gke_multicloud_v1.services.aws_clusters.transports.base.AwsClustersTransport] = 'grpc_asyncio', client_options: 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 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 |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
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)
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
)
Returns a fully-qualified aws_node_pool string.
aws_server_config_path
aws_server_config_path(project: str, location: str)
Returns a fully-qualified aws_server_config string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_aws_cluster
create_aws_cluster(request: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.CreateAwsClusterRequest, dict]] = None, *, parent: Optional[str] = None, aws_cluster: Optional[google.cloud.gke_multicloud_v1.types.aws_resources.AwsCluster] = None, aws_cluster_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new xref_AwsCluster resource on a given GCP 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.
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_value_1', 'pod_address_cidr_blocks_value_2']
aws_cluster.networking.service_address_cidr_blocks = ['service_address_cidr_blocks_value_1', 'service_address_cidr_blocks_value_2']
aws_cluster.aws_region = "aws_region_value"
aws_cluster.control_plane.version = "version_value"
aws_cluster.control_plane.subnet_ids = ['subnet_ids_value_1', 'subnet_ids_value_2']
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.authorization.admin_users.username = "username_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 |
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.Retry
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: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.CreateAwsNodePoolRequest, dict]] = None, *, parent: Optional[str] = None, aws_node_pool: Optional[google.cloud.gke_multicloud_v1.types.aws_resources.AwsNodePool] = None, aws_node_pool_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
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 |
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.Retry
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: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.DeleteAwsClusterRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
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 |
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.Retry
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: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.DeleteAwsNodePoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
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 |
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.Retry
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); } |
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: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.GenerateAwsAccessTokenRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Generates a short-lived access token to authenticate to a given xref_AwsCluster resource.
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 |
Union[google.cloud.gke_multicloud_v1.types.GenerateAwsAccessTokenRequest, dict]
The request object. Request message for |
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, 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. |
get_aws_cluster
get_aws_cluster(request: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.GetAwsClusterRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Describes a specific xref_AwsCluster resource.
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 |
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.Retry
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_node_pool
get_aws_node_pool(request: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.GetAwsNodePoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Describes a specific xref_AwsNodePool resource.
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 |
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.Retry
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_server_config
get_aws_server_config(request: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.GetAwsServerConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
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 |
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.Retry
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: 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 variabel 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_transport_class
get_transport_class()
Returns an appropriate transport class.
list_aws_clusters
list_aws_clusters(request: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.ListAwsClustersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all xref_AwsCluster resources on a given Google Cloud project and region.
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 |
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.Retry
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: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.ListAwsNodePoolsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all xref_AwsNodePool resources on a given xref_AwsCluster.
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 |
Union[google.cloud.gke_multicloud_v1.types.ListAwsNodePoolsRequest, dict]
The request object. Request message for |
parent |
Required. The parent |
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, 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. |
parse_aws_cluster_path
parse_aws_cluster_path(path: str)
Parses a aws_cluster path into its component segments.
parse_aws_node_pool_path
parse_aws_node_pool_path(path: str)
Parses a aws_node_pool path into its component segments.
parse_aws_server_config_path
parse_aws_server_config_path(path: str)
Parses a aws_server_config path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
update_aws_cluster
update_aws_cluster(request: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.UpdateAwsClusterRequest, dict]] = None, *, aws_cluster: Optional[google.cloud.gke_multicloud_v1.types.aws_resources.AwsCluster] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates an xref_AwsCluster.
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_value_1', 'pod_address_cidr_blocks_value_2']
aws_cluster.networking.service_address_cidr_blocks = ['service_address_cidr_blocks_value_1', 'service_address_cidr_blocks_value_2']
aws_cluster.aws_region = "aws_region_value"
aws_cluster.control_plane.version = "version_value"
aws_cluster.control_plane.subnet_ids = ['subnet_ids_value_1', 'subnet_ids_value_2']
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.authorization.admin_users.username = "username_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 |
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.Retry
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: Optional[Union[google.cloud.gke_multicloud_v1.types.aws_service.UpdateAwsNodePoolRequest, dict]] = None, *, aws_node_pool: Optional[google.cloud.gke_multicloud_v1.types.aws_resources.AwsNodePool] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates an xref_AwsNodePool.
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 |
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.Retry
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. |