Google Anthos Multi Cloud V1 Client - Class AwsNodeConfig (0.4.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

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ autoscaling_metrics_collection Google\Cloud\GkeMultiCloud\V1\AwsAutoscalingGroupMetricsCollection

Optional. Configuration related to CloudWatch metrics collection on the Auto Scaling group of the node pool. When unspecified, metrics collection is disabled.

getInstanceType

Optional. The AWS instance type.

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

Returns
TypeDescription
string

setInstanceType

Optional. The AWS instance type.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AwsVolumeTemplate|null

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.

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AwsVolumeTemplate
Returns
TypeDescription
$this

getTaints

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTaints

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

Parameter
NameDescription
var array<Google\Cloud\GkeMultiCloud\V1\NodeTaint>
Returns
TypeDescription
$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" }.

Returns
TypeDescription
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" }.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getIamInstanceProfile

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

Returns
TypeDescription
string

setIamInstanceProfile

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSshConfig

Optional. The SSH configuration.

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AwsSshConfig|null

hasSshConfig

clearSshConfig

setSshConfig

Optional. The SSH configuration.

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AwsSshConfig
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getProxyConfig

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

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AwsProxyConfig|null

hasProxyConfig

clearProxyConfig

setProxyConfig

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

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AwsProxyConfig
Returns
TypeDescription
$this

getConfigEncryption

Required. Config encryption for user data.

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AwsConfigEncryption|null

hasConfigEncryption

clearConfigEncryption

setConfigEncryption

Required. Config encryption for user data.

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AwsConfigEncryption
Returns
TypeDescription
$this

getInstancePlacement

Optional. Placement related info for this node.

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

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AwsInstancePlacement|null

hasInstancePlacement

clearInstancePlacement

setInstancePlacement

Optional. Placement related info for this node.

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

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AwsInstancePlacement
Returns
TypeDescription
$this

getAutoscalingMetricsCollection

Optional. Configuration related to CloudWatch metrics collection on the Auto Scaling group of the node pool.

When unspecified, metrics collection is disabled.

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\AwsAutoscalingGroupMetricsCollection|null

hasAutoscalingMetricsCollection

clearAutoscalingMetricsCollection

setAutoscalingMetricsCollection

Optional. Configuration related to CloudWatch metrics collection on the Auto Scaling group of the node pool.

When unspecified, metrics collection is disabled.

Parameter
NameDescription
var Google\Cloud\GkeMultiCloud\V1\AwsAutoscalingGroupMetricsCollection
Returns
TypeDescription
$this