Skip to content

Data Source: aws_eks_cluster#

Provides information about an EKS cluster.

Example Usage#

data "aws_eks_cluster" "example" {
  name = "example"
}

Argument Reference#

  • name - (Required) The name of the cluster.

Attribute Reference#

Supported attributes#

  • arn - Cluster ID.
  • certificate_authority - Nested attribute containing certificate-authority-data for your cluster.
    • data - The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.
  • created_at - The Unix epoch time stamp in seconds for when the cluster was created.
  • id - The name of the cluster.
  • kubernetes_network_config - Nested list containing Kubernetes Network Configuration.
    • ip_family - The IP family used to assign Kubernetes pod and service addresses.
    • service_ipv4_cidr - The CIDR block to assign Kubernetes service IP addresses from.
  • legacy_cluster_params - The parameters for fine-tuning the Kubernetes cluster.
    • master_config - The configuration of the master node of the cluster.
      • high_availability - Indicates whether this is a high-availability cluster.
      • instance_type - The instance type of the master node.
      • public_ip - The public IP address at which the master node is accessed.
      • volume_iops - The number of read/write operations per second for the master node volume.
      • volume_size - The size of the master node volume in GiB.
      • volume_type - The type of the master node volume.
  • platform_version - The platform version for the cluster.
  • status - The status of the EKS cluster. One of CLAIMED, CREATING, DELETED, DELETING, ERROR, MODIFYING, PENDING, PROVISIONING, READY, REPAIRING.
  • version - The Kubernetes server version for the cluster.
  • vpc_config - Nested list containing VPC configuration for the cluster.
    • cluster_security_group_id - The cluster security group that was created by the cloud for the cluster.
    • security_group_ids – List of security group IDs.
    • subnet_ids – List of subnet IDs.
    • vpc_id – The VPC associated with your cluster.
  • tags - Key-value map of resource tags.

Unsupported attributes#

~> Note These attributes may be present in the terraform.tfstate file but they have preset values and cannot be specified in configuration files.

The following attributes are not currently supported:

enabled_cluster_log_types, encryption_config, endpoint, identity, role_arn, vpc_config.endpoint_private_access, vpc_config.endpoint_public_access, vpc_config.public_access_cidrs.