Skip to content
AWS for Query.Farm

aws.eks.describe_addon

Example SQL Queries

SELECT * FROM
aws.eks.describe_addon
WHERE
"cluster_name" = 'VALUE'
AND "addon_name" = 'VALUE';

Description

Describes an Amazon EKS add-on.

Table Definition

Column NameColumn Data Type
addon_name Required Input Column

The name of the add-on. The name must match one of the names returned by ListAddons .

VARCHAR
cluster_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
addon

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

STRUCT(
    "addon_name" VARCHAR,
    "cluster_name" VARCHAR,
    "status" VARCHAR,
    "addon_version" VARCHAR,
    "health" STRUCT(
        "issues" STRUCT(
            "code" VARCHAR,
            "message" VARCHAR,
            "resource_ids" VARCHAR[]
        )[]
    ),
    "addon_arn" VARCHAR,
    "created_at" TIMESTAMP_S,
    "modified_at" TIMESTAMP_S,
    "service_account_role_arn" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "publisher" VARCHAR,
    "owner" VARCHAR,
    "marketplace_information" STRUCT(
        "product_id" VARCHAR,
        "product_url" VARCHAR
    ),
    "configuration_values" VARCHAR,
    "pod_identity_associations" VARCHAR[]
)
Show child fields
addon.addon_arn

The Amazon Resource Name (ARN) of the add-on.

addon.addon_name

The name of the add-on.

addon.addon_version

The version of the add-on.

addon.cluster_name

The name of your cluster.

addon.configuration_values

The configuration values that you provided.

addon.created_at

The Unix epoch timestamp at object creation.

addon.health

An object that represents the health of the add-on.

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

A code that describes the type of issue.

addon.health.issues[].message

A message that provides details about the issue and what might cause it.

addon.health.issues[].resource_ids[]
addon.marketplace_information

Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.

Show child fields
addon.marketplace_information.product_id

The product ID from the Amazon Web Services Marketplace.

addon.marketplace_information.product_url

The product URL from the Amazon Web Services Marketplace.

addon.modified_at

The Unix epoch timestamp for the last modification to the object.

addon.owner

The owner of the add-on.

addon.pod_identity_associations[]
addon.publisher

The publisher of the add-on.

addon.service_account_role_arn

The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes ServiceAccount object that the add-on uses.

addon.status

The status of the add-on.

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