Interface AwsControlPlaneOrBuilder (0.35.0)

Version 0.35.0

• 0.52.0 (latest)
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.6
• 0.1.0

public interface AwsControlPlaneOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsTags(String key)

public abstract boolean containsTags(String key)

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.

map<string, string> tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAwsServicesAuthentication()

public abstract AwsServicesAuthentication getAwsServicesAuthentication()

Required. Authentication configuration for management of AWS resources.

.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsServicesAuthentication	The awsServicesAuthentication.

getAwsServicesAuthenticationOrBuilder()

public abstract AwsServicesAuthenticationOrBuilder getAwsServicesAuthenticationOrBuilder()

Required. Authentication configuration for management of AWS resources.

.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsServicesAuthenticationOrBuilder

getConfigEncryption()

public abstract AwsConfigEncryption getConfigEncryption()

Required. Config encryption for user data.

.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsConfigEncryption	The configEncryption.

getConfigEncryptionOrBuilder()

public abstract AwsConfigEncryptionOrBuilder getConfigEncryptionOrBuilder()

Required. Config encryption for user data.

.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsConfigEncryptionOrBuilder

getDatabaseEncryption()

public abstract AwsDatabaseEncryption getDatabaseEncryption()

Required. The ARN of the AWS KMS key used to encrypt cluster secrets.

.google.cloud.gkemulticloud.v1.AwsDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsDatabaseEncryption	The databaseEncryption.

getDatabaseEncryptionOrBuilder()

public abstract AwsDatabaseEncryptionOrBuilder getDatabaseEncryptionOrBuilder()

Required. The ARN of the AWS KMS key used to encrypt cluster secrets.

.google.cloud.gkemulticloud.v1.AwsDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AwsDatabaseEncryptionOrBuilder

getIamInstanceProfile()

public abstract String getIamInstanceProfile()

Required. The name or ARN of the AWS IAM instance profile to assign to each control plane replica.

string iam_instance_profile = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The iamInstanceProfile.

getIamInstanceProfileBytes()

public abstract ByteString getIamInstanceProfileBytes()

Required. The name or ARN of the AWS IAM instance profile to assign to each control plane replica.

string iam_instance_profile = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for iamInstanceProfile.

getInstancePlacement()

public abstract AwsInstancePlacement getInstancePlacement()

Optional. The placement to use on control plane instances. When unspecified, the VPC's default tenancy will be used.

.google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsInstancePlacement	The instancePlacement.

getInstancePlacementOrBuilder()

public abstract AwsInstancePlacementOrBuilder getInstancePlacementOrBuilder()

Optional. The placement to use on control plane instances. When unspecified, the VPC's default tenancy will be used.

.google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsInstancePlacementOrBuilder

getInstanceType()

public abstract String getInstanceType()

Optional. The AWS instance type.

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

string instance_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The instanceType.

getInstanceTypeBytes()

public abstract ByteString getInstanceTypeBytes()

Optional. The AWS instance type.

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

string instance_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for instanceType.

getMainVolume()

public abstract AwsVolumeTemplate getMainVolume()

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.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate main_volume = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsVolumeTemplate	The mainVolume.

getMainVolumeOrBuilder()

public abstract AwsVolumeTemplateOrBuilder getMainVolumeOrBuilder()

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.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate main_volume = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsVolumeTemplateOrBuilder

getProxyConfig()

public abstract AwsProxyConfig getProxyConfig()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsProxyConfig	The proxyConfig.

getProxyConfigOrBuilder()

public abstract AwsProxyConfigOrBuilder getProxyConfigOrBuilder()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsProxyConfigOrBuilder

getRootVolume()

public abstract AwsVolumeTemplate getRootVolume()

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.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsVolumeTemplate	The rootVolume.

getRootVolumeOrBuilder()

public abstract AwsVolumeTemplateOrBuilder getRootVolumeOrBuilder()

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.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsVolumeTemplateOrBuilder

getSecurityGroupIds(int index)

public abstract String getSecurityGroupIds(int index)

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.

repeated string security_group_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The securityGroupIds at the given index.

getSecurityGroupIdsBytes(int index)

public abstract ByteString getSecurityGroupIdsBytes(int index)

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.

repeated string security_group_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the securityGroupIds at the given index.

getSecurityGroupIdsCount()

public abstract int getSecurityGroupIdsCount()

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.

repeated string security_group_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of securityGroupIds.

getSecurityGroupIdsList()

public abstract List<String> getSecurityGroupIdsList()

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.

repeated string security_group_ids = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the securityGroupIds.

getSshConfig()

public abstract AwsSshConfig getSshConfig()

Optional. SSH configuration for how to access the underlying control plane machines.

.google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsSshConfig	The sshConfig.

getSshConfigOrBuilder()

public abstract AwsSshConfigOrBuilder getSshConfigOrBuilder()

Optional. SSH configuration for how to access the underlying control plane machines.

.google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AwsSshConfigOrBuilder

getSubnetIds(int index)

public abstract String getSubnetIds(int index)

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).

repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The subnetIds at the given index.

getSubnetIdsBytes(int index)

public abstract ByteString getSubnetIdsBytes(int index)

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).

repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the subnetIds at the given index.

getSubnetIdsCount()

public abstract int getSubnetIdsCount()

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).

repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of subnetIds.

getSubnetIdsList()

public abstract List<String> getSubnetIdsList()

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).

repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<String>	A list containing the subnetIds.

getTags() (deprecated)

public abstract Map<String,String> getTags()

Use #getTagsMap() instead.

Returns
Type	Description
Map<String,String>

getTagsCount()

public abstract int getTagsCount()

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.

map<string, string> tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getTagsMap()

public abstract Map<String,String> getTagsMap()

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.

map<string, string> tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getTagsOrDefault(String key, String defaultValue)

public abstract String getTagsOrDefault(String key, String defaultValue)

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.

map<string, string> tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getTagsOrThrow(String key)

public abstract String getTagsOrThrow(String key)

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.

map<string, string> tags = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getVersion()

public abstract String getVersion()

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.

string version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The version.

getVersionBytes()

public abstract ByteString getVersionBytes()

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.

string version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for version.

hasAwsServicesAuthentication()

public abstract boolean hasAwsServicesAuthentication()

Required. Authentication configuration for management of AWS resources.

.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the awsServicesAuthentication field is set.

hasConfigEncryption()

public abstract boolean hasConfigEncryption()

Required. Config encryption for user data.

.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 17 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the configEncryption field is set.

hasDatabaseEncryption()

public abstract boolean hasDatabaseEncryption()

Required. The ARN of the AWS KMS key used to encrypt cluster secrets.

.google.cloud.gkemulticloud.v1.AwsDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the databaseEncryption field is set.

hasInstancePlacement()

public abstract boolean hasInstancePlacement()

Optional. The placement to use on control plane instances. When unspecified, the VPC's default tenancy will be used.

.google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the instancePlacement field is set.

hasMainVolume()

public abstract boolean hasMainVolume()

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.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate main_volume = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the mainVolume field is set.

hasProxyConfig()

public abstract boolean hasProxyConfig()

Optional. Proxy configuration for outbound HTTP(S) traffic.

.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the proxyConfig field is set.

hasRootVolume()

public abstract boolean hasRootVolume()

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.

.google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the rootVolume field is set.

hasSshConfig()

public abstract boolean hasSshConfig()

Optional. SSH configuration for how to access the underlying control plane machines.

.google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the sshConfig field is set.