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

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.

↳ 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
Type
Description
string

setInstanceType

Optional. The AWS instance type.

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

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.

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.

Parameter
Name
Description
Returns
Type
Description
$this

getTaints

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

Returns
Type
Description

setTaints

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

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

Returns
Type
Description

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
Name
Description
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.

Returns
Type
Description

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
Name
Description
Returns
Type
Description
$this

getIamInstanceProfile

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

Returns
Type
Description
string

setIamInstanceProfile

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

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 .

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 .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSshConfig

Optional. The SSH configuration.

Returns
Type
Description

hasSshConfig

clearSshConfig

setSshConfig

Optional. The SSH configuration.

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.

Returns
Type
Description

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
Name
Description
var
string[]
Returns
Type
Description
$this

getProxyConfig

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

Returns
Type
Description

hasProxyConfig

clearProxyConfig

setProxyConfig

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

Parameter
Name
Description
Returns
Type
Description
$this

getConfigEncryption

Required. Config encryption for user data.

Returns
Type
Description

hasConfigEncryption

clearConfigEncryption

setConfigEncryption

Required. Config encryption for user data.

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.

hasInstancePlacement

clearInstancePlacement

setInstancePlacement

Optional. Placement related info for this node.

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

Returns
Type
Description
$this

getAutoscalingMetricsCollection

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

When unspecified, metrics collection is disabled.

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.

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