Anthos Multi-Cloud V1 API - Class Google::Cloud::GkeMultiCloud::V1::AwsControlPlane (v0.8.0)

Version 0.8.0

• 0.12.0 (latest)
• 0.11.0
• 0.10.1
• 0.9.0
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Anthos Multi-Cloud V1 API class Google::Cloud::GkeMultiCloud::V1::AwsControlPlane.

ControlPlane defines common parameters between control plane nodes.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#aws_services_authentication

def aws_services_authentication() -> ::Google::Cloud::GkeMultiCloud::V1::AwsServicesAuthentication

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsServicesAuthentication) — Required. Authentication configuration for management of AWS resources.

#aws_services_authentication=

def aws_services_authentication=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsServicesAuthentication

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AwsServicesAuthentication) — Required. Authentication configuration for management of AWS resources.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsServicesAuthentication) — Required. Authentication configuration for management of AWS resources.

#config_encryption

def config_encryption() -> ::Google::Cloud::GkeMultiCloud::V1::AwsConfigEncryption

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsConfigEncryption) — Required. Config encryption for user data.

#config_encryption=

def config_encryption=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsConfigEncryption

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AwsConfigEncryption) — Required. Config encryption for user data.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsConfigEncryption) — Required. Config encryption for user data.

#database_encryption

def database_encryption() -> ::Google::Cloud::GkeMultiCloud::V1::AwsDatabaseEncryption

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsDatabaseEncryption) — Required. The ARN of the AWS KMS key used to encrypt cluster secrets.

#database_encryption=

def database_encryption=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsDatabaseEncryption

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AwsDatabaseEncryption) — Required. The ARN of the AWS KMS key used to encrypt cluster secrets.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsDatabaseEncryption) — Required. The ARN of the AWS KMS key used to encrypt cluster secrets.

#iam_instance_profile

def iam_instance_profile() -> ::String

Returns

• (::String) — Required. The name or ARN of the AWS IAM instance profile to assign to each control plane replica.

#iam_instance_profile=

def iam_instance_profile=(value) -> ::String

Parameter

• value (::String) — Required. The name or ARN of the AWS IAM instance profile to assign to each control plane replica.

Returns

• (::String) — Required. The name or ARN of the AWS IAM instance profile to assign to each control plane replica.

#instance_placement

def instance_placement() -> ::Google::Cloud::GkeMultiCloud::V1::AwsInstancePlacement

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsInstancePlacement) — Optional. The placement to use on control plane instances. When unspecified, the VPC's default tenancy will be used.

#instance_placement=

def instance_placement=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsInstancePlacement

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AwsInstancePlacement) — Optional. The placement to use on control plane instances. When unspecified, the VPC's default tenancy will be used.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsInstancePlacement) — Optional. The placement to use on control plane instances. When unspecified, the VPC's default tenancy will be used.

#instance_type

def instance_type() -> ::String

Returns

• (::String) — Optional. The AWS instance type.

  When unspecified, it uses a default based on the cluster's version.

#instance_type=

def instance_type=(value) -> ::String

Parameter

• value (::String) — Optional. The AWS instance type.

  When unspecified, it uses a default based on the cluster's version.

Returns

• (::String) — Optional. The AWS instance type.

  When unspecified, it uses a default based on the cluster's version.

#main_volume

def main_volume() -> ::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate) — Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state.

  Volumes will be provisioned in the availability zone associated with the corresponding subnet.

  When unspecified, it defaults to 8 GiB with the GP2 volume type.

#main_volume=

def main_volume=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate) — Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state.

  Volumes will be provisioned in the availability zone associated with the corresponding subnet.

  When unspecified, it defaults to 8 GiB with the GP2 volume type.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate) — Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state.

  Volumes will be provisioned in the availability zone associated with the corresponding subnet.

  When unspecified, it defaults to 8 GiB with the GP2 volume type.

#proxy_config

def proxy_config() -> ::Google::Cloud::GkeMultiCloud::V1::AwsProxyConfig

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsProxyConfig) — Optional. Proxy configuration for outbound HTTP(S) traffic.

#proxy_config=

def proxy_config=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsProxyConfig

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AwsProxyConfig) — Optional. Proxy configuration for outbound HTTP(S) traffic.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsProxyConfig) — Optional. Proxy configuration for outbound HTTP(S) traffic.

#root_volume

def root_volume() -> ::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate) — Optional. Configuration related to the root volume provisioned for each control plane replica.

  Volumes will be provisioned in the availability zone associated with the corresponding subnet.

  When unspecified, it defaults to 32 GiB with the GP2 volume type.

#root_volume=

def root_volume=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate) — Optional. Configuration related to the root volume provisioned for each control plane replica.

  Volumes will be provisioned in the availability zone associated with the corresponding subnet.

  When unspecified, it defaults to 32 GiB with the GP2 volume type.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsVolumeTemplate) — Optional. Configuration related to the root volume provisioned for each control plane replica.

  Volumes will be provisioned in the availability zone associated with the corresponding subnet.

  When unspecified, it defaults to 32 GiB with the GP2 volume type.

#security_group_ids

def security_group_ids() -> ::Array<::String>

Returns

• (::Array<::String>) — Optional. The IDs of additional security groups to add to control plane replicas. The Anthos Multi-Cloud API will automatically create and manage security groups with the minimum rules needed for a functioning cluster.

#security_group_ids=

def security_group_ids=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Optional. The IDs of additional security groups to add to control plane replicas. The Anthos Multi-Cloud API will automatically create and manage security groups with the minimum rules needed for a functioning cluster.

Returns

• (::Array<::String>) — Optional. The IDs of additional security groups to add to control plane replicas. The Anthos Multi-Cloud API will automatically create and manage security groups with the minimum rules needed for a functioning cluster.

#ssh_config

def ssh_config() -> ::Google::Cloud::GkeMultiCloud::V1::AwsSshConfig

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsSshConfig) — Optional. SSH configuration for how to access the underlying control plane machines.

#ssh_config=

def ssh_config=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsSshConfig

Parameter

• value (::Google::Cloud::GkeMultiCloud::V1::AwsSshConfig) — Optional. SSH configuration for how to access the underlying control plane machines.

Returns

• (::Google::Cloud::GkeMultiCloud::V1::AwsSshConfig) — Optional. SSH configuration for how to access the underlying control plane machines.

#subnet_ids

def subnet_ids() -> ::Array<::String>

Returns

• (::Array<::String>) — Required. The list of subnets where control plane replicas will run. A replica will be provisioned on each subnet and up to three values can be provided. Each subnet must be in a different AWS Availability Zone (AZ).

#subnet_ids=

def subnet_ids=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Required. The list of subnets where control plane replicas will run. A replica will be provisioned on each subnet and up to three values can be provided. Each subnet must be in a different AWS Availability Zone (AZ).

Returns

• (::Array<::String>) — Required. The list of subnets where control plane replicas will run. A replica will be provisioned on each subnet and up to three values can be provided. Each subnet must be in a different AWS Availability Zone (AZ).

#tags

def tags() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of AWS resource tags to propagate to all underlying managed AWS resources.

  Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

#tags=

def tags=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of AWS resource tags to propagate to all underlying managed AWS resources.

  Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of AWS resource tags to propagate to all underlying managed AWS resources.

  Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

#version

def version() -> ::String

Returns

• (::String) — Required. The Kubernetes version to run on control plane replicas (e.g. 1.19.10-gke.1000).

  You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.

#version=

def version=(value) -> ::String

Parameter

• value (::String) — Required. The Kubernetes version to run on control plane replicas (e.g. 1.19.10-gke.1000).

  You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.

Returns

• (::String) — Required. The Kubernetes version to run on control plane replicas (e.g. 1.19.10-gke.1000).

  You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.