Cluster
An object representing an Amazon EKS cluster.
Contents
- accessConfig
-
The access configuration for the cluster.
Type: AccessConfigResponse object
Required: No
- 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
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Required: No
- computeConfig
-
Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the EKS User Guide.
Type: ComputeConfigResponse object
Required: No
- connectorConfig
-
The configuration used to connect to a cluster for registration.
Type: ConnectorConfigResponse object
Required: No
- createdAt
-
The Unix epoch timestamp at object creation.
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
- health
-
An object representing the health of your Amazon EKS cluster.
Type: ClusterHealth object
Required: No
- id
-
The ID of your local Amazon EKS cluster on an AWS Outpost. This property isn't available for an Amazon EKS cluster on the AWS cloud.
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 your cluster.
Type: String
Required: No
- outpostConfig
-
An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This object isn't available for clusters on the AWS cloud.
Type: OutpostConfigResponse object
Required: No
- platformVersion
-
The platform version of your Amazon EKS cluster. For more information about clusters deployed on the AWS Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
Type: String
Required: No
- remoteNetworkConfig
-
The configuration in the cluster for EKS Hybrid Nodes. You can't change or update this configuration after the cluster is created.
Type: RemoteNetworkConfigResponse object
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
- storageConfig
-
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.
Type: StorageConfigResponse object
Required: No
-
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.
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
- upgradePolicy
-
This value indicates if extended support is enabled or disabled for the cluster.
Learn more about EKS Extended Support in the EKS User Guide.
Type: UpgradePolicyResponse object
Required: No
- version
-
The Kubernetes server version for the cluster.
Type: String
Required: No
- zonalShiftConfig
-
The configuration for zonal shift for the cluster.
Type: ZonalShiftConfigResponse object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
