Skip to main content

cluster_tags

Expands all tag keys and values for clusters in a region

Overview

Namecluster_tags
TypeResource
DescriptionAn object representing an Amazon EKS cluster.
Idaws.eks.cluster_tags

Fields

NameDatatypeDescription
loggingobjectEnable 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.
encryption_config_key_arnstringAmazon Resource Name (ARN) or alias of the customer master key (CMK).
access_configobjectAn object representing the Access Config to use for the cluster.
certificate_authority_datastringThe certificate-authority-data for your cluster.
encryption_configarray
kubernetes_network_configobjectThe Kubernetes network configuration for the cluster.
role_arnstringThe 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.
namestringThe unique name to give to your cluster.
endpointstringThe endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
versionstringThe desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.
cluster_security_group_idstringThe 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.
idstringThe unique ID given to your cluster.
outpost_configobjectAn object representing the Outpost configuration to use for AWS EKS outpost cluster.
arnstringThe ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
resources_vpc_configobjectAn object representing the VPC configuration to use for an Amazon EKS cluster.
open_id_connect_issuer_urlstringThe 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.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all clusters in a region.

SELECT
region,
logging,
encryption_config_key_arn,
access_config,
certificate_authority_data,
encryption_config,
kubernetes_network_config,
role_arn,
name,
endpoint,
version,
cluster_security_group_id,
id,
outpost_config,
arn,
resources_vpc_config,
open_id_connect_issuer_url,
tag_key,
tag_value
FROM aws.eks.cluster_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the cluster_tags resource, see clusters