Anthos Multi-Cloud V1 API - Class Google::Cloud::GkeMultiCloud::V1::AwsNodePool (v0.8.0)

Reference documentation and code samples for the Anthos Multi-Cloud V1 API class Google::Cloud::GkeMultiCloud::V1::AwsNodePool.

An Anthos node pool running on AWS.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Annotations on the node pool.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Optional. Annotations on the node pool.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Optional. Annotations on the node pool.

This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

#autoscaling

def autoscaling() -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodePoolAutoscaling

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsNodePoolAutoscaling) — Required. Autoscaler configuration for this node pool.

#autoscaling=

def autoscaling=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodePoolAutoscaling

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::AwsNodePoolAutoscaling) — Required. Autoscaler configuration for this node pool.

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsNodePoolAutoscaling) — Required. Autoscaler configuration for this node pool.

#config

def config() -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodeConfig

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsNodeConfig) — Required. The configuration of the node pool.

#config=

def config=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodeConfig

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::AwsNodeConfig) — Required. The configuration of the node pool.

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsNodeConfig) — Required. The configuration of the node pool.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time at which this node pool was created.

#errors

def errors() -> ::Array<::Google::Cloud::GkeMultiCloud::V1::AwsNodePoolError>

Returns

(::Array<::Google::Cloud::GkeMultiCloud::V1::AwsNodePoolError>) — Output only. A set of errors found in the node pool.

#etag

def etag() -> ::String

Returns

(::String) — Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

#etag=

def etag=(value) -> ::String

Parameter

value (::String) — Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns

(::String) — Allows clients to perform consistent read-modify-writes through optimistic concurrency control.

Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

#management

def management() -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodeManagement

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsNodeManagement) — Optional. The Management configuration for this node pool.

#management=

def management=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodeManagement

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::AwsNodeManagement) — Optional. The Management configuration for this node pool.

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsNodeManagement) — Optional. The Management configuration for this node pool.

#max_pods_constraint

def max_pods_constraint() -> ::Google::Cloud::GkeMultiCloud::V1::MaxPodsConstraint

Returns

(::Google::Cloud::GkeMultiCloud::V1::MaxPodsConstraint) — Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

#max_pods_constraint=

def max_pods_constraint=(value) -> ::Google::Cloud::GkeMultiCloud::V1::MaxPodsConstraint

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::MaxPodsConstraint) — Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

Returns

(::Google::Cloud::GkeMultiCloud::V1::MaxPodsConstraint) — Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

#name

def name() -> ::String

Returns

(::String) — The name of this resource.

Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

For more details on Google Cloud resource names, see Resource Names

#name=

def name=(value) -> ::String

Parameter

value (::String) — The name of this resource.

Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

For more details on Google Cloud resource names, see Resource Names

Returns

(::String) — The name of this resource.

Node pool names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

For more details on Google Cloud resource names, see Resource Names

#reconciling

def reconciling() -> ::Boolean

Returns

(::Boolean) — Output only. If set, there are currently changes in flight to the node pool.

#state

def state() -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodePool::State

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsNodePool::State) — Output only. The lifecycle state of the node pool.

#subnet_id

def subnet_id() -> ::String

Returns

(::String) — Required. The subnet where the node pool node run.

#subnet_id=

def subnet_id=(value) -> ::String

Parameter

value (::String) — Required. The subnet where the node pool node run.

Returns

(::String) — Required. The subnet where the node pool node run.

#uid

def uid() -> ::String

Returns

(::String) — Output only. A globally unique identifier for the node pool.

#update_settings

def update_settings() -> ::Google::Cloud::GkeMultiCloud::V1::UpdateSettings

Returns

(::Google::Cloud::GkeMultiCloud::V1::UpdateSettings) — Optional. Update settings control the speed and disruption of the update.

#update_settings=

def update_settings=(value) -> ::Google::Cloud::GkeMultiCloud::V1::UpdateSettings

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::UpdateSettings) — Optional. Update settings control the speed and disruption of the update.

Returns

(::Google::Cloud::GkeMultiCloud::V1::UpdateSettings) — Optional. Update settings control the speed and disruption of the update.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time at which this node pool was last updated.

#version

def version() -> ::String

Returns

(::String) — Required. The Kubernetes version to run on this node pool (e.g. 1.19.10-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.

#version=

def version=(value) -> ::String

Parameter

value (::String) — Required. The Kubernetes version to run on this node pool (e.g. 1.19.10-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.

Returns

(::String) — Required. The Kubernetes version to run on this node pool (e.g. 1.19.10-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAwsServerConfig.