Skip to content
AWS for Query.Farm

aws.eks.describe_cluster

Example SQL Queries

SELECT * FROM
aws.eks.describe_cluster
WHERE
"name" = 'VALUE';

Description

Describes an Amazon EKS cluster.

The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Creating or updating a kubeconfig file for an Amazon EKS cluster.

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of your cluster.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
cluster

The full description of your specified cluster.

STRUCT(
    "name" VARCHAR,
    "arn" VARCHAR,
    "created_at" TIMESTAMP_S,
    "version" VARCHAR,
    "endpoint" VARCHAR,
    "role_arn" VARCHAR,
    "resources_vpc_config" STRUCT(
        "subnet_ids" VARCHAR[],
        "security_group_ids" VARCHAR[],
        "cluster_security_group_id" VARCHAR,
        "vpc_id" VARCHAR,
        "endpoint_public_access" BOOLEAN,
        "endpoint_private_access" BOOLEAN,
        "public_access_cidrs" VARCHAR[]
    ),
    "kubernetes_network_config" STRUCT(
        "service_ipv4_cidr" VARCHAR,
        "service_ipv6_cidr" VARCHAR,
        "ip_family" VARCHAR
    ),
    "logging" STRUCT(
        "cluster_logging" STRUCT(
            "types" VARCHAR[],
            "enabled" BOOLEAN
        )[]
    ),
    "identity" STRUCT(
        "oidc" STRUCT(
            "issuer" VARCHAR
        )
    ),
    "status" VARCHAR,
    "certificate_authority" STRUCT(
        "data" VARCHAR
    ),
    "client_request_token" VARCHAR,
    "platform_version" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "encryption_config" STRUCT(
        "resources" VARCHAR[],
        "provider" STRUCT(
            "key_arn" VARCHAR
        )
    )[],
    "connector_config" STRUCT(
        "activation_id" VARCHAR,
        "activation_code" VARCHAR,
        "activation_expiry" TIMESTAMP_S,
        "provider" VARCHAR,
        "role_arn" VARCHAR
    ),
    "id" VARCHAR,
    "health" STRUCT(
        "issues" STRUCT(
            "code" VARCHAR,
            "message" VARCHAR,
            "resource_ids" VARCHAR[]
        )[]
    ),
    "outpost_config" STRUCT(
        "outpost_arns" VARCHAR[],
        "control_plane_instance_type" VARCHAR,
        "control_plane_placement" STRUCT(
            "group_name" VARCHAR
        )
    ),
    "access_config" STRUCT(
        "bootstrap_cluster_creator_admin_permissions" BOOLEAN,
        "authentication_mode" VARCHAR
    ),
    "upgrade_policy" STRUCT(
        "support_type" VARCHAR
    )
)
Show child fields
cluster.access_config

The access configuration for the cluster.

Show child fields
cluster.access_config.authentication_mode

The current authentication mode of the cluster.

cluster.access_config.bootstrap_cluster_creator_admin_permissions

Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.

cluster.arn

The Amazon Resource Name (ARN) of the cluster.

cluster.certificate_authority

The certificate-authority-data for your cluster.

Show child fields
cluster.certificate_authority.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.

cluster.client_request_token

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

cluster.connector_config

The configuration used to connect to a cluster for registration.

Show child fields
cluster.connector_config.activation_code

A unique code associated with the cluster for registration purposes.

cluster.connector_config.activation_expiry

The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.

cluster.connector_config.activation_id

A unique ID associated with the cluster for registration purposes.

cluster.connector_config.provider

The cluster's cloud service provider.

cluster.connector_config.role_arn

The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.

cluster.created_at

The Unix epoch timestamp at object creation.

cluster.encryption_config[]
Show child fields
cluster.encryption_config[].provider

Key Management Service (KMS) key. Either the ARN or the alias can be used.

Show child fields
cluster.encryption_config[].provider.key_arn

Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.

cluster.encryption_config[].resources[]
cluster.endpoint

The endpoint for your Kubernetes API server.

cluster.health

An object representing the health of your Amazon EKS cluster.

Show child fields
cluster.health.issues[]
Show child fields
cluster.health.issues[].code

The error code of the issue.

cluster.health.issues[].message

A description of the issue.

cluster.health.issues[].resource_ids[]
cluster.id

The 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.

cluster.identity

The identity provider information for the cluster.

Show child fields
cluster.identity.oidc

An object representing the OpenID Connect identity provider information.

Show child fields
cluster.identity.oidc.issuer

The issuer URL for the OIDC identity provider.

cluster.kubernetes_network_config

The Kubernetes network configuration for the cluster.

Show child fields
cluster.kubernetes_network_config.ip_family

The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.

cluster.kubernetes_network_config.service_ipv4_cidr

The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it can't be changed.

cluster.kubernetes_network_config.service_ipv6_cidr

The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.

cluster.logging

The logging configuration for your cluster.

Show child fields
cluster.logging.cluster_logging[]
Show child fields
cluster.logging.cluster_logging[].enabled

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.

cluster.logging.cluster_logging[].types[]
cluster.name

The name of your cluster.

cluster.outpost_config

An 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.

Show child fields
cluster.outpost_config.control_plane_instance_type

The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.

cluster.outpost_config.control_plane_placement

An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.

Show child fields
cluster.outpost_config.control_plane_placement.group_name

The name of the placement group for the Kubernetes control plane instances.

cluster.outpost_config.outpost_arns[]
cluster.platform_version

The 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 .

cluster.resources_vpc_config

The 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.

Show child fields
cluster.resources_vpc_config.cluster_security_group_id

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.

cluster.resources_vpc_config.endpoint_private_access

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

cluster.resources_vpc_config.endpoint_public_access

Whether the public API server endpoint is enabled.

cluster.resources_vpc_config.public_access_cidrs[]
cluster.resources_vpc_config.security_group_ids[]
cluster.resources_vpc_config.subnet_ids[]
cluster.resources_vpc_config.vpc_id

The VPC associated with your cluster.

cluster.role_arn

The 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.

cluster.status

The current status of the cluster.

cluster.tags

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

cluster.upgrade_policy

This value indicates if extended support is enabled or disabled for the cluster.

Learn more about EKS Extended Support in the EKS User Guide.

Show child fields
cluster.upgrade_policy.support_type

If the cluster is set to EXTENDED, it will enter extended support at the end of standard support. If the cluster is set to STANDARD, it will be automatically upgraded at the end of standard support.

Learn more about EKS Extended Support in the EKS User Guide.

cluster.version

The Kubernetes server version for the cluster.