Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Cluster

An object representing an Amazon EKS cluster.

Hierarchy

  • Cluster

Index

Properties

Optional arn

arn: undefined | string

The Amazon Resource Name (ARN) of the cluster.

Optional certificateAuthority

certificateAuthority: Certificate

The certificate-authority-data for your cluster.

Optional clientRequestToken

clientRequestToken: undefined | string

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

Optional connectorConfig

connectorConfig: ConnectorConfigResponse

The configuration used to connect to a cluster for registration.

Optional createdAt

createdAt: Date

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

Optional encryptionConfig

encryptionConfig: EncryptionConfig[]

The encryption configuration for the cluster.

Optional endpoint

endpoint: undefined | string

The endpoint for your Kubernetes API server.

Optional health

An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.

Optional id

id: undefined | string

The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.

Optional identity

identity: Identity

The identity provider information for the cluster.

Optional kubernetesNetworkConfig

kubernetesNetworkConfig: KubernetesNetworkConfigResponse

The Kubernetes network configuration for the cluster.

Optional logging

logging: Logging

The logging configuration for your cluster.

Optional name

name: undefined | string

The name of the cluster.

Optional outpostConfig

outpostConfig: OutpostConfigResponse

An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.

Optional platformVersion

platformVersion: undefined | string

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

Optional resourcesVpcConfig

resourcesVpcConfig: 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.

Optional roleArn

roleArn: undefined | string

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

Optional status

status: ClusterStatus | string

The current status of the cluster.

Optional tags

tags: Record<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. You define both. Cluster tags do not propagate to any other resources associated with the cluster.

Optional version

version: undefined | string

The Kubernetes server version for the cluster.