Anthos Multi-Cloud V1 API - Class Google::Cloud::GkeMultiCloud::V1::AwsCluster (v0.3.0)

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

An Anthos cluster 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 cluster.

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 cluster.

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 cluster.

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.

#authorization

def authorization() -> ::Google::Cloud::GkeMultiCloud::V1::AwsAuthorization

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsAuthorization) — Required. Configuration related to the cluster RBAC settings.

#authorization=

def authorization=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsAuthorization

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::AwsAuthorization) — Required. Configuration related to the cluster RBAC settings.

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsAuthorization) — Required. Configuration related to the cluster RBAC settings.

#aws_region

def aws_region() -> ::String

Returns

(::String) — Required. The AWS region where the cluster runs.

Each Google Cloud region supports a subset of nearby AWS regions. You can call GetAwsServerConfig to list all supported AWS regions within a given Google Cloud region.

#aws_region=

def aws_region=(value) -> ::String

Parameter

value (::String) — Required. The AWS region where the cluster runs.

Each Google Cloud region supports a subset of nearby AWS regions. You can call GetAwsServerConfig to list all supported AWS regions within a given Google Cloud region.

Returns

(::String) — Required. The AWS region where the cluster runs.

Each Google Cloud region supports a subset of nearby AWS regions. You can call GetAwsServerConfig to list all supported AWS regions within a given Google Cloud region.

#cluster_ca_certificate

def cluster_ca_certificate() -> ::String

Returns

(::String) — Output only. PEM encoded x509 certificate of the cluster root of trust.

#control_plane

def control_plane() -> ::Google::Cloud::GkeMultiCloud::V1::AwsControlPlane

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsControlPlane) — Required. Configuration related to the cluster control plane.

#control_plane=

def control_plane=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsControlPlane

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::AwsControlPlane) — Required. Configuration related to the cluster control plane.

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsControlPlane) — Required. Configuration related to the cluster control plane.

#create_time

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

Returns

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

#description

def description() -> ::String

Returns

(::String) — Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

Returns

(::String) — Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes.

#endpoint

def endpoint() -> ::String

Returns

(::String) — Output only. The endpoint of the cluster's API server.

#errors

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

Returns

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

#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.

#fleet

def fleet() -> ::Google::Cloud::GkeMultiCloud::V1::Fleet

Returns

(::Google::Cloud::GkeMultiCloud::V1::Fleet) — Required. Fleet configuration.

#fleet=

def fleet=(value) -> ::Google::Cloud::GkeMultiCloud::V1::Fleet

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::Fleet) — Required. Fleet configuration.

Returns

(::Google::Cloud::GkeMultiCloud::V1::Fleet) — Required. Fleet configuration.

#logging_config

def logging_config() -> ::Google::Cloud::GkeMultiCloud::V1::LoggingConfig

Returns

(::Google::Cloud::GkeMultiCloud::V1::LoggingConfig) — Optional. Logging configuration for this cluster.

#logging_config=

def logging_config=(value) -> ::Google::Cloud::GkeMultiCloud::V1::LoggingConfig

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::LoggingConfig) — Optional. Logging configuration for this cluster.

Returns

(::Google::Cloud::GkeMultiCloud::V1::LoggingConfig) — Optional. Logging configuration for this cluster.

#monitoring_config

def monitoring_config() -> ::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig

Returns

(::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig) — Optional. Monitoring configuration for this cluster.

#monitoring_config=

def monitoring_config=(value) -> ::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig) — Optional. Monitoring configuration for this cluster.

Returns

(::Google::Cloud::GkeMultiCloud::V1::MonitoringConfig) — Optional. Monitoring configuration for this cluster.

#name

def name() -> ::String

Returns

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

Cluster names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>.

See Resource Names for more details on GCP resource names.

#name=

def name=(value) -> ::String

Parameter

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

Cluster names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>.

See Resource Names for more details on GCP resource names.

Returns

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

Cluster names are formatted as projects/<project-number>/locations/<region>/awsClusters/<cluster-id>.

See Resource Names for more details on GCP resource names.

#networking

def networking() -> ::Google::Cloud::GkeMultiCloud::V1::AwsClusterNetworking

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsClusterNetworking) — Required. Cluster-wide networking configuration.

#networking=

def networking=(value) -> ::Google::Cloud::GkeMultiCloud::V1::AwsClusterNetworking

Parameter

value (::Google::Cloud::GkeMultiCloud::V1::AwsClusterNetworking) — Required. Cluster-wide networking configuration.

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsClusterNetworking) — Required. Cluster-wide networking configuration.

#reconciling

def reconciling() -> ::Boolean

Returns

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

#state

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

Returns

(::Google::Cloud::GkeMultiCloud::V1::AwsCluster::State) — Output only. The current state of the cluster.

#uid

def uid() -> ::String

Returns

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

#update_time

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

Returns

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

#workload_identity_config

def workload_identity_config() -> ::Google::Cloud::GkeMultiCloud::V1::WorkloadIdentityConfig

Returns

(::Google::Cloud::GkeMultiCloud::V1::WorkloadIdentityConfig) — Output only. Workload Identity settings.