Cluster
An object representing an Amazon EKS cluster.
Contents
- arn
-
The Amazon Resource Name (ARN) of the cluster.
Type: String
Required: No
- certificateAuthority
-
The
certificate-authority-datafor your cluster.Type: Certificate object
Required: No
- clientRequestToken
-
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Required: No
- connectorConfig
-
The configuration used to connect to a cluster for registration.
Type: ConnectorConfigResponse object
Required: No
- createdAt
-
The Unix epoch timestamp in seconds for when the cluster was created.
Type: Timestamp
Required: No
- encryptionConfig
-
The encryption configuration for the cluster.
Type: Array of EncryptionConfig objects
Array Members: Maximum number of 1 item.
Required: No
- endpoint
-
The endpoint for your Kubernetes API server.
Type: String
Required: No
- identity
-
The identity provider information for the cluster.
Type: Identity object
Required: No
- kubernetesNetworkConfig
-
The Kubernetes network configuration for the cluster.
Type: KubernetesNetworkConfigResponse object
Required: No
- logging
-
The logging configuration for your cluster.
Type: Logging object
Required: No
- name
-
The name of the cluster.
Type: String
Required: No
- platformVersion
-
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .
Type: String
Required: No
- resourcesVpcConfig
-
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.
Type: VpcConfigResponse object
Required: No
- roleArn
-
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.
Type: String
Required: No
- status
-
The current status of the cluster.
Type: String
Valid Values:
CREATING | ACTIVE | DELETING | FAILED | UPDATING | PENDINGRequired: No
- tags
-
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.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
Required: No
- version
-
The Kubernetes server version for the cluster.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
