An EKS Cluster is a managed Kubernetes control plane provided by AWS. It handles the setup, scaling, and management of Kubernetes masters, including the API server and etcd, while you manage worker nodes separately. This service simplifies running containerized applications by integrating with AWS networking, security, and monitoring tools, allowing you to focus on deploying and operating workloads without managing the underlying Kubernetes infrastructure.

aws.eks_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
access_configcorejsonThe access configuration for the cluster.
account_idcorestring
arncorestringThe Amazon Resource Name (ARN) of the cluster.
certificate_authoritycorejsonThe certificate-authority-data for your cluster.
client_request_tokencorestringA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
compute_configcorejsonIndicates 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 Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide.
connector_configcorejsonThe configuration used to connect to a cluster for registration.
created_atcoretimestampThe Unix epoch timestamp at object creation.
encryption_configcorejsonThe encryption configuration for the cluster.
endpointcorestringThe endpoint for your Kubernetes API server.
healthcorejsonAn object representing the health of your Amazon EKS cluster.
idcorestringThe 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.
identitycorejsonThe identity provider information for the cluster.
kubernetes_network_configcorejsonThe Kubernetes network configuration for the cluster.
loggingcorejsonThe logging configuration for your cluster.
namecorestringThe name of your cluster.
outpost_configcorejsonAn 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.
platform_versioncorestringThe platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services 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 .
remote_network_configcorejsonThe configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
resources_vpc_configcorejsonThe 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.
role_arncorestringThe 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.
statuscorestringThe current status of the cluster.
storage_configcorejsonIndicates 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 Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide.
tagscorehstore
upgrade_policycorejsonThis value indicates if extended support is enabled or disabled for the cluster. Learn more about EKS Extended Support in the Amazon EKS User Guide.
versioncorestringThe Kubernetes server version for the cluster.
zonal_shift_configcorejsonThe configuration for zonal shift for the cluster.