cluster
Gets an individual cluster resource
Overview
| Name | cluster |
| Type | Resource |
| Description | cluster |
| Id | awscc.eks.cluster |
Fields
| Name | Datatype | Description |
|---|---|---|
encryption_config | array | |
kubernetes_network_config | object | |
logging | object | |
name | string | The unique name to give to your cluster. |
id | string | The unique ID given to your cluster. |
resources_vpc_config | object | |
outpost_config | object | |
access_config | object | |
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. |
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. |
tags | array | An array of key-value pairs to apply to this resource. |
arn | string | The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod. |
endpoint | string | The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com. |
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_key_arn | string | Amazon Resource Name (ARN) or alias of the customer master key (CMK). |
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. |
region | string | AWS region. |
Methods
Currently only SELECT is supported for this resource resource.
Example
SELECT
region,
encryption_config,
kubernetes_network_config,
logging,
name,
id,
resources_vpc_config,
outpost_config,
access_config,
role_arn,
version,
tags,
arn,
endpoint,
certificate_authority_data,
cluster_security_group_id,
encryption_config_key_arn,
open_id_connect_issuer_url
FROM awscc.eks.cluster
WHERE data__Identifier = '<Name>';
Permissions
To operate on the cluster resource, the following permissions are required:
Read
eks:DescribeCluster
Update
iam:PassRole,
eks:UpdateClusterConfig,
eks:UpdateClusterVersion,
eks:DescribeCluster,
eks:DescribeUpdate,
eks:TagResource,
eks:UntagResource
Delete
eks:DeleteCluster,
eks:DescribeCluster