Google Anthos Multi Cloud V1 Client - Class AwsNodeConfig (0.1.4)

Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AwsNodeConfig.

Parameters that describe the nodes in a cluster.

Generated from protobuf message google.cloud.gkemulticloud.v1.AwsNodeConfig

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ instance_type
string

Optional. The AWS instance type. When unspecified, it uses a default based on the node pool's version.

↳ root_volume
Google\Cloud\GkeMultiCloud\V1\AwsVolumeTemplate

Optional. Template for the root volume provisioned for node pool nodes. Volumes will be provisioned in the availability zone assigned to the node pool subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type.

↳ taints
array< Google\Cloud\GkeMultiCloud\V1\NodeTaint >

Optional. The initial taints assigned to nodes of this node pool.

↳ labels
array|Google\Protobuf\Internal\MapField

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

↳ tags
array|Google\Protobuf\Internal\MapField

Optional. Key/value metadata to assign to each underlying AWS resource. 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.

↳ iam_instance_profile
string

Required. The name or ARN of the AWS IAM role assigned to nodes in the pool.

↳ image_type
string

Optional. The OS image type to use on node pool instances. Can have a value of ubuntu , or windows if the cluster enables the Windows node pool preview feature. When unspecified, it defaults to ubuntu .

↳ ssh_config
Google\Cloud\GkeMultiCloud\V1\AwsSshConfig

Optional. The SSH configuration.

↳ security_group_ids
array

Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster.

↳ 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. Placement related info for this node. When unspecified, the VPC's default tenancy will be used.

getInstanceType

Optional. The AWS instance type.

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

Generated from protobuf field string instance_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
string

setInstanceType

Optional. The AWS instance type.

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

Generated from protobuf field string instance_type = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getRootVolume

Optional. Template for the root volume provisioned for node pool nodes.

Volumes will be provisioned in the availability zone assigned to the node pool subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

hasRootVolume

clearRootVolume

setRootVolume

Optional. Template for the root volume provisioned for node pool nodes.

Volumes will be provisioned in the availability zone assigned to the node pool subnet. When unspecified, it defaults to 32 GiB with the GP2 volume type.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsVolumeTemplate root_volume = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
Returns
Type
Description
$this

getTaints

Optional. The initial taints assigned to nodes of this node pool.

Generated from protobuf field repeated .google.cloud.gkemulticloud.v1.NodeTaint taints = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setTaints

Optional. The initial taints assigned to nodes of this node pool.

Generated from protobuf field repeated .google.cloud.gkemulticloud.v1.NodeTaint taints = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Generated from protobuf field map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
Google\Protobuf\Internal\MapField

setLabels

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Generated from protobuf field map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
array|Google\Protobuf\Internal\MapField
Returns
Type
Description
$this

getTags

Optional. Key/value metadata to assign to each underlying AWS resource. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
Google\Protobuf\Internal\MapField

setTags

Optional. Key/value metadata to assign to each underlying AWS resource. 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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
array|Google\Protobuf\Internal\MapField
Returns
Type
Description
$this

getIamInstanceProfile

Required. The name or ARN of the AWS IAM role assigned to nodes in the pool.

Generated from protobuf field string iam_instance_profile = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description
string

setIamInstanceProfile

Required. The name or ARN of the AWS IAM role assigned to nodes in the pool.

Generated from protobuf field string iam_instance_profile = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getImageType

Optional. The OS image type to use on node pool instances.

Can have a value of ubuntu , or windows if the cluster enables the Windows node pool preview feature. When unspecified, it defaults to ubuntu .

Generated from protobuf field string image_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
string

setImageType

Optional. The OS image type to use on node pool instances.

Can have a value of ubuntu , or windows if the cluster enables the Windows node pool preview feature. When unspecified, it defaults to ubuntu .

Generated from protobuf field string image_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSshConfig

Optional. The SSH configuration.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

hasSshConfig

clearSshConfig

setSshConfig

Optional. The SSH configuration.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsSshConfig ssh_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
Returns
Type
Description
$this

getSecurityGroupIds

Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster.

Generated from protobuf field repeated string security_group_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setSecurityGroupIds

Optional. The IDs of additional security groups to add to nodes in this pool. The manager will automatically create security groups with minimum rules needed for a functioning cluster.

Generated from protobuf field repeated string security_group_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getProxyConfig

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

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description

hasProxyConfig

clearProxyConfig

setProxyConfig

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

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsProxyConfig proxy_config = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name
Description
Returns
Type
Description
$this

getConfigEncryption

Required. Config encryption for user data.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

hasConfigEncryption

clearConfigEncryption

setConfigEncryption

Required. Config encryption for user data.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsConfigEncryption config_encryption = 13 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name
Description
Returns
Type
Description
$this

getInstancePlacement

Optional. Placement related info for this node.

When unspecified, the VPC's default tenancy will be used.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 14 [(.google.api.field_behavior) = OPTIONAL];

hasInstancePlacement

clearInstancePlacement

setInstancePlacement

Optional. Placement related info for this node.

When unspecified, the VPC's default tenancy will be used.

Generated from protobuf field .google.cloud.gkemulticloud.v1.AwsInstancePlacement instance_placement = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: