Class: Aws::EKS::Types::Cluster

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::Cluster

Defined in:

(unknown)

Overview

An object representing an Amazon EKS cluster.

Returned by:

• Aws::EKS::Types::CreateClusterResponse#cluster
• DeleteClusterResponse#cluster
• DescribeClusterResponse#cluster

See Also:

• AWS API Documentation

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the cluster.

• #certificate_authority ⇒ Types::Certificate

  The certificate-authority-data for your cluster.

• #client_request_token ⇒ String

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #created_at ⇒ Time

  The Unix epoch timestamp in seconds for when the cluster was created.

• #encryption_config ⇒ Array<Types::EncryptionConfig>

  The encryption configuration for the cluster.

• #endpoint ⇒ String

  The endpoint for your Kubernetes API server.

• #identity ⇒ Types::Identity

  The identity provider information for the cluster.

• #kubernetes_network_config ⇒ Types::KubernetesNetworkConfigResponse

  Network configuration settings for your cluster.

• #logging ⇒ Types::Logging

  The logging configuration for your cluster.

• #name ⇒ String

  The name of the cluster.

• #platform_version ⇒ String

  The platform version of your Amazon EKS cluster.

• #resources_vpc_config ⇒ Types::VpcConfigResponse

  The VPC configuration used by the cluster control plane.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

• #status ⇒ String

  The current status of the cluster.

• #tags ⇒ Hash<String,String>

  The metadata that you apply to the cluster to assist with categorization and organization.

• #version ⇒ String

  The Kubernetes server version for the cluster.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the cluster.

Returns:

• (String) —

  The Amazon Resource Name (ARN) of the cluster.

#certificate_authority ⇒ Types::Certificate

The certificate-authority-data for your cluster.

Returns:

• (Types::Certificate) —

  The certificate-authority-data for your cluster.

#client_request_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

• (String) —

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#created_at ⇒ Time

The Unix epoch timestamp in seconds for when the cluster was created.

Returns:

• (Time) —

  The Unix epoch timestamp in seconds for when the cluster was created.

#encryption_config ⇒ Array<Types::EncryptionConfig>

The encryption configuration for the cluster.

Returns:

• (Array<Types::EncryptionConfig>) —

  The encryption configuration for the cluster.

#endpoint ⇒ String

The endpoint for your Kubernetes API server.

Returns:

• (String) —

  The endpoint for your Kubernetes API server.

#identity ⇒ Types::Identity

The identity provider information for the cluster.

Returns:

• (Types::Identity) —

  The identity provider information for the cluster.

#kubernetes_network_config ⇒ Types::KubernetesNetworkConfigResponse

Network configuration settings for your cluster.

Returns:

• (Types::KubernetesNetworkConfigResponse) —

  Network configuration settings for your cluster.

#logging ⇒ Types::Logging

The logging configuration for your cluster.

Returns:

• (Types::Logging) —

  The logging configuration for your cluster.

#name ⇒ String

The name of the cluster.

Returns:

• (String) —

  The name of the cluster.

#platform_version ⇒ String

The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .

Returns:

• (String) —

  The platform version of your Amazon EKS cluster.

#resources_vpc_config ⇒ Types::VpcConfigResponse

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide.

Returns:

• (Types::VpcConfigResponse) —

  The VPC configuration used by the cluster control plane.

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

Returns:

• (String) —

  The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

#status ⇒ String

The current status of the cluster.

Possible values:

• CREATING
• ACTIVE
• DELETING
• FAILED
• UPDATING

Returns:

• (String) —

  The current status of the cluster.

#tags ⇒ Hash<String,String>

The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.

Returns:

• (Hash<String,String>) —

  The metadata that you apply to the cluster to assist with categorization and organization.

#version ⇒ String

The Kubernetes server version for the cluster.

Returns:

• (String) —

  The Kubernetes server version for the cluster.