public final class AwsControlPlane extends GeneratedMessageV3 implements AwsControlPlaneOrBuilder
ControlPlane defines common parameters between control plane nodes.
Protobuf type google.cloud.gkemulticloud.v1.AwsControlPlane
Static Fields
AWS_SERVICES_AUTHENTICATION_FIELD_NUMBER
public static final int AWS_SERVICES_AUTHENTICATION_FIELD_NUMBER
Field Value
CONFIG_ENCRYPTION_FIELD_NUMBER
public static final int CONFIG_ENCRYPTION_FIELD_NUMBER
Field Value
DATABASE_ENCRYPTION_FIELD_NUMBER
public static final int DATABASE_ENCRYPTION_FIELD_NUMBER
Field Value
IAM_INSTANCE_PROFILE_FIELD_NUMBER
public static final int IAM_INSTANCE_PROFILE_FIELD_NUMBER
Field Value
INSTANCE_PLACEMENT_FIELD_NUMBER
public static final int INSTANCE_PLACEMENT_FIELD_NUMBER
Field Value
INSTANCE_TYPE_FIELD_NUMBER
public static final int INSTANCE_TYPE_FIELD_NUMBER
Field Value
MAIN_VOLUME_FIELD_NUMBER
public static final int MAIN_VOLUME_FIELD_NUMBER
Field Value
PROXY_CONFIG_FIELD_NUMBER
public static final int PROXY_CONFIG_FIELD_NUMBER
Field Value
ROOT_VOLUME_FIELD_NUMBER
public static final int ROOT_VOLUME_FIELD_NUMBER
Field Value
SECURITY_GROUP_IDS_FIELD_NUMBER
public static final int SECURITY_GROUP_IDS_FIELD_NUMBER
Field Value
SSH_CONFIG_FIELD_NUMBER
public static final int SSH_CONFIG_FIELD_NUMBER
Field Value
SUBNET_IDS_FIELD_NUMBER
public static final int SUBNET_IDS_FIELD_NUMBER
Field Value
public static final int TAGS_FIELD_NUMBER
Field Value
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AwsControlPlane getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AwsControlPlane.Builder newBuilder()
Returns
newBuilder(AwsControlPlane prototype)
public static AwsControlPlane.Builder newBuilder(AwsControlPlane prototype)
Parameter
Returns
public static AwsControlPlane parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AwsControlPlane parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AwsControlPlane parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AwsControlPlane parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AwsControlPlane parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AwsControlPlane parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AwsControlPlane parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AwsControlPlane parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AwsControlPlane parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AwsControlPlane parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AwsControlPlane parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AwsControlPlane parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AwsControlPlane> parser()
Returns
Methods
public 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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAwsServicesAuthentication()
public AwsServicesAuthentication getAwsServicesAuthentication()
Required. Authentication configuration for management of AWS resources.
.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];
getAwsServicesAuthenticationOrBuilder()
public AwsServicesAuthenticationOrBuilder getAwsServicesAuthenticationOrBuilder()
Required. Authentication configuration for management of AWS resources.
.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];
getConfigEncryption()
public AwsConfigEncryption getConfigEncryption()
Required. Config encryption for user data.
.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 17 [(.google.api.field_behavior) = REQUIRED];
getConfigEncryptionOrBuilder()
public AwsConfigEncryptionOrBuilder getConfigEncryptionOrBuilder()
Required. Config encryption for user data.
.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 17 [(.google.api.field_behavior) = REQUIRED];
getDatabaseEncryption()
public 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];
getDatabaseEncryptionOrBuilder()
public 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];
getDefaultInstanceForType()
public AwsControlPlane getDefaultInstanceForType()
Returns
getIamInstanceProfile()
public 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];
| Type | Description |
| String | The iamInstanceProfile.
|
getIamInstanceProfileBytes()
public 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];
| Type | Description |
| ByteString | The bytes for iamInstanceProfile.
|
getInstancePlacement()
public 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];
getInstancePlacementOrBuilder()
public 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];
getInstanceType()
public 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];
| Type | Description |
| String | The instanceType.
|
getInstanceTypeBytes()
public 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];
| Type | Description |
| ByteString | The bytes for instanceType.
|
getMainVolume()
public 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];
getMainVolumeOrBuilder()
public 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];
getParserForType()
public Parser<AwsControlPlane> getParserForType()
Returns
Overrides
getProxyConfig()
public AwsProxyConfig getProxyConfig()
Optional. Proxy configuration for outbound HTTP(S) traffic.
.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 16 [(.google.api.field_behavior) = OPTIONAL];
getProxyConfigOrBuilder()
public AwsProxyConfigOrBuilder getProxyConfigOrBuilder()
Optional. Proxy configuration for outbound HTTP(S) traffic.
.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 16 [(.google.api.field_behavior) = OPTIONAL];
getRootVolume()
public 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];
getRootVolumeOrBuilder()
public 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];
getSecurityGroupIds(int index)
public 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];
| 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 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];
| 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 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];
| Type | Description |
| int | The count of securityGroupIds.
|
getSecurityGroupIdsList()
public ProtocolStringList 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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSshConfig()
public 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];
getSshConfigOrBuilder()
public 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];
getSubnetIds(int index)
public 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];
| 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 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];
| 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 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];
| Type | Description |
| int | The count of subnetIds.
|
getSubnetIdsList()
public ProtocolStringList 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];
public Map<String,String> getTags()
Returns
public 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];
public 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];
public 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];
public 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getVersion()
public 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];
| Type | Description |
| String | The version.
|
getVersionBytes()
public 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];
hasAwsServicesAuthentication()
public boolean hasAwsServicesAuthentication()
Required. Authentication configuration for management of AWS resources.
.google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the awsServicesAuthentication field is set.
|
hasConfigEncryption()
public boolean hasConfigEncryption()
Required. Config encryption for user data.
.google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 17 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the configEncryption field is set.
|
hasDatabaseEncryption()
public 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];
| Type | Description |
| boolean | Whether the databaseEncryption field is set.
|
hasInstancePlacement()
public 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];
| Type | Description |
| boolean | Whether the instancePlacement field is set.
|
hasMainVolume()
public 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];
| Type | Description |
| boolean | Whether the mainVolume field is set.
|
hasProxyConfig()
public boolean hasProxyConfig()
Optional. Proxy configuration for outbound HTTP(S) traffic.
.google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the proxyConfig field is set.
|
hasRootVolume()
public 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];
| Type | Description |
| boolean | Whether the rootVolume field is set.
|
hasSshConfig()
public 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];
| Type | Description |
| boolean | Whether the sshConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AwsControlPlane.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AwsControlPlane.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AwsControlPlane.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
