---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_eks_cluster Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::EKS::Cluster
---
# awscc_eks_cluster (Data Source)
Data Source schema for AWS::EKS::Cluster
## Schema
### Required
- `id` (String) Uniquely identifies the resource.
### Read-Only
- `arn` (String) The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
- `certificate_authority_data` (String) The certificate-authority-data for your cluster.
- `cluster_security_group_id` (String) The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
- `encryption_config` (Attributes List) (see [below for nested schema](#nestedatt--encryption_config))
- `encryption_config_key_arn` (String) Amazon Resource Name (ARN) or alias of the customer master key (CMK).
- `endpoint` (String) The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
- `kubernetes_network_config` (Attributes) The Kubernetes network configuration for the cluster. (see [below for nested schema](#nestedatt--kubernetes_network_config))
- `logging` (Attributes) Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs based on log types. By default, cluster control plane logs aren't exported to CloudWatch Logs. (see [below for nested schema](#nestedatt--logging))
- `name` (String) The unique name to give to your cluster.
- `open_id_connect_issuer_url` (String) The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
- `resources_vpc_config` (Attributes) An object representing the VPC configuration to use for an Amazon EKS cluster. (see [below for nested schema](#nestedatt--resources_vpc_config))
- `role_arn` (String) 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.
- `tags` (Attributes Set) An array of key-value pairs to apply to this resource. (see [below for nested schema](#nestedatt--tags))
- `version` (String) The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
### Nested Schema for `encryption_config`
Read-Only:
- `provider` (Attributes) The encryption provider for the cluster. (see [below for nested schema](#nestedatt--encryption_config--provider))
- `resources` (List of String) Specifies the resources to be encrypted. The only supported value is "secrets".
### Nested Schema for `encryption_config.provider`
Read-Only:
- `key_arn` (String) Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same region as the cluster, and if the KMS key was created in a different account, the user must have access to the KMS key.
### Nested Schema for `kubernetes_network_config`
Read-Only:
- `ip_family` (String) Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on
- `service_ipv_4_cidr` (String) The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.
- `service_ipv_6_cidr` (String) The CIDR block to assign Kubernetes service IP addresses from.
### Nested Schema for `logging`
Read-Only:
- `cluster_logging` (Attributes) The cluster control plane logging configuration for your cluster. (see [below for nested schema](#nestedatt--logging--cluster_logging))
### Nested Schema for `logging.cluster_logging`
Read-Only:
- `enabled_types` (Attributes List) Enable control plane logs for your cluster, all log types will be disabled if the array is empty (see [below for nested schema](#nestedatt--logging--cluster_logging--enabled_types))
### Nested Schema for `logging.cluster_logging.enabled_types`
Read-Only:
- `type` (String) name of the log type
### Nested Schema for `resources_vpc_config`
Read-Only:
- `endpoint_private_access` (Boolean) Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
- `endpoint_public_access` (Boolean) Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
- `public_access_cidrs` (List of String) The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
- `security_group_ids` (List of String) Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.
- `subnet_ids` (List of String) Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
### Nested Schema for `tags`
Read-Only:
- `key` (String) The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- `value` (String) The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.