Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AwsControlPlane.
ControlPlane defines common parameters between control plane nodes.
Generated from protobuf message google.cloud.gkemulticloud.v1.AwsControlPlane
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ version |
string
Required. The Kubernetes version to run on control plane replicas (e.g. |
↳ instance_type |
string
Optional. The AWS instance type. When unspecified, it uses a default based on the cluster's version. |
↳ ssh_config |
Google\Cloud\GkeMultiCloud\V1\AwsSshConfig
Optional. SSH configuration for how to access the underlying control plane machines. |
↳ subnet_ids |
array
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). |
↳ security_group_ids |
array
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. |
↳ iam_instance_profile |
string
Required. The name or ARN of the AWS IAM instance profile to assign to each control plane replica. |
↳ root_volume |
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. |
↳ main_volume |
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. |
↳ database_encryption |
Google\Cloud\GkeMultiCloud\V1\AwsDatabaseEncryption
Required. The ARN of the AWS KMS key used to encrypt cluster secrets. |
↳ tags |
array|Google\Protobuf\Internal\MapField
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. |
↳ aws_services_authentication |
Google\Cloud\GkeMultiCloud\V1\AwsServicesAuthentication
Required. Authentication configuration for management of AWS resources. |
↳ proxy_config |
Google\Cloud\GkeMultiCloud\V1\AwsProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic. |
↳ config_encryption |
Google\Cloud\GkeMultiCloud\V1\AwsConfigEncryption
Required. Config encryption for user data. |
↳ instance_placement |
Google\Cloud\GkeMultiCloud\V1\AwsInstancePlacement
Optional. The placement to use on control plane instances. When unspecified, the VPC's default tenancy will be used. |
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.
Generated from protobuf field string version = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setVersion
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.
Generated from protobuf field string version = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceType
Optional. The AWS instance type.
When unspecified, it uses a default based on the cluster's version.
Generated from protobuf field string instance_type = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setInstanceType
Optional. The AWS instance type.
When unspecified, it uses a default based on the cluster's version.
Generated from protobuf field string instance_type = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSshConfig
Optional. SSH configuration for how to access the underlying control plane machines.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsSshConfig|null | |
hasSshConfig
clearSshConfig
setSshConfig
Optional. SSH configuration for how to access the underlying control plane machines.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsSshConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubnetIds
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).
Generated from protobuf field repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSubnetIds
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).
Generated from protobuf field repeated string subnet_ids = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSecurityGroupIds
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.
Generated from protobuf field repeated string security_group_ids = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSecurityGroupIds
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.
Generated from protobuf field repeated string security_group_ids = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIamInstanceProfile
Required. The name or ARN of the AWS IAM instance profile to assign to each control plane replica.
Generated from protobuf field string iam_instance_profile = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setIamInstanceProfile
Required. The name or ARN of the AWS IAM instance profile to assign to each control plane replica.
Generated from protobuf field string iam_instance_profile = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsVolumeTemplate|null | |
hasRootVolume
clearRootVolume
setRootVolume
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.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsVolumeTemplate
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsVolumeTemplate main_volume = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsVolumeTemplate|null | |
hasMainVolume
clearMainVolume
setMainVolume
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.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsVolumeTemplate main_volume = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsVolumeTemplate
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDatabaseEncryption
Required. The ARN of the AWS KMS key used to encrypt cluster secrets.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsDatabaseEncryption|null | |
hasDatabaseEncryption
clearDatabaseEncryption
setDatabaseEncryption
Required. The ARN of the AWS KMS key used to encrypt cluster secrets.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsDatabaseEncryption
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTags
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.
Generated from protobuf field map<string, string> tags = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setTags
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.
Generated from protobuf field map<string, string> tags = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAwsServicesAuthentication
Required. Authentication configuration for management of AWS resources.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsServicesAuthentication|null | |
hasAwsServicesAuthentication
clearAwsServicesAuthentication
setAwsServicesAuthentication
Required. Authentication configuration for management of AWS resources.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsServicesAuthentication aws_services_authentication = 12 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsServicesAuthentication
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsProxyConfig|null | |
hasProxyConfig
clearProxyConfig
setProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsProxyConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConfigEncryption
Required. Config encryption for user data.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 17 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsConfigEncryption|null | |
hasConfigEncryption
clearConfigEncryption
setConfigEncryption
Required. Config encryption for user data.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 17 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsConfigEncryption
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstancePlacement
Optional. The placement to use on control plane instances.
When unspecified, the VPC's default tenancy will be used.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AwsInstancePlacement|null | |
hasInstancePlacement
clearInstancePlacement
setInstancePlacement
Optional. The placement to use on control plane instances.
When unspecified, the VPC's default tenancy will be used.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AwsInstancePlacement
|
| Returns | |
|---|---|
| Type | Description |
$this | |