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

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ instance_type string

Optional. The EC2 instance type when creating on-Demand instances. If unspecified during node pool creation, a default will be chosen based on the node pool version, and assigned to this field.

↳ 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 instance profile to assign to nodes in the pool.

↳ image_type string

Optional. The OS image type to use on node pool instances. Can be unspecified, or have a value of ubuntu. 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.

↳ spot_config Google\Cloud\GkeMultiCloud\V1\SpotConfig

Optional. Configuration for provisioning EC2 Spot instances When specified, the node pool will provision Spot instances from the set of spot_config.instance_types. This field is mutually exclusive with instance_type.

getInstanceType

Optional. The EC2 instance type when creating on-Demand instances.

If unspecified during node pool creation, a default will be chosen based on the node pool version, and assigned to this field.

Returns
Type Description
string

setInstanceType

Optional. The EC2 instance type when creating on-Demand instances.

If unspecified during node pool creation, a default will be chosen based on the node pool version, and assigned to this field.

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
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
Name Description
var Google\Cloud\GkeMultiCloud\V1\AwsVolumeTemplate
Returns
Type Description
$this

getTaints

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTaints

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

Parameter
Name Description
var array<Google\Cloud\GkeMultiCloud\V1\NodeTaint>
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
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
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.

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.

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

getIamInstanceProfile

Required. The name or ARN of the AWS IAM instance profile to assign to nodes in the pool.

Returns
Type Description
string

setIamInstanceProfile

Required. The name or ARN of the AWS IAM instance profile to assign 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 be unspecified, or have a value of ubuntu. When unspecified, it defaults to ubuntu.

Returns
Type Description
string

setImageType

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

Can be unspecified, or have a value of ubuntu. When unspecified, it defaults to ubuntu.

Parameter
Name Description
var string
Returns
Type Description
$this

getSshConfig

Optional. The SSH configuration.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AwsSshConfig|null

hasSshConfig

clearSshConfig

setSshConfig

Optional. The SSH configuration.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AwsSshConfig
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
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
Name Description
var string[]
Returns
Type Description
$this

getProxyConfig

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

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AwsProxyConfig|null

hasProxyConfig

clearProxyConfig

setProxyConfig

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

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AwsProxyConfig
Returns
Type Description
$this

getConfigEncryption

Required. Config encryption for user data.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AwsConfigEncryption|null

hasConfigEncryption

clearConfigEncryption

setConfigEncryption

Required. Config encryption for user data.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AwsConfigEncryption
Returns
Type Description
$this

getInstancePlacement

Optional. Placement related info for this node.

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

Returns
Type Description
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
Name Description
var Google\Cloud\GkeMultiCloud\V1\AwsInstancePlacement
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.

Returns
Type Description
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
Name Description
var Google\Cloud\GkeMultiCloud\V1\AwsAutoscalingGroupMetricsCollection
Returns
Type Description
$this

getSpotConfig

Optional. Configuration for provisioning EC2 Spot instances When specified, the node pool will provision Spot instances from the set of spot_config.instance_types.

This field is mutually exclusive with instance_type.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\SpotConfig|null

hasSpotConfig

clearSpotConfig

setSpotConfig

Optional. Configuration for provisioning EC2 Spot instances When specified, the node pool will provision Spot instances from the set of spot_config.instance_types.

This field is mutually exclusive with instance_type.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\SpotConfig
Returns
Type Description
$this