[ aws . eks ]

describe-addon

Description

Describes an Amazon EKS add-on.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-addon
--cluster-name <value>
--addon-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--cluster-name (string)

The name of the cluster.

--addon-name (string)

The name of the add-on. The name must match one of the names returned by ` ListAddons https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html`__ .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

addon -> (structure)

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

addonName -> (string)

The name of the add-on.

clusterName -> (string)

The name of the cluster.

status -> (string)

The status of the add-on.

addonVersion -> (string)

The version of the add-on.

health -> (structure)

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

issues -> (list)

An object that represents the add-on’s health issues.

(structure)

An issue related to an add-on.

code -> (string)

A code that describes the type of issue.

message -> (string)

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

resourceIds -> (list)

The resource IDs of the issue.

(string)

addonArn -> (string)

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

createdAt -> (timestamp)

The date and time that the add-on was created.

modifiedAt -> (timestamp)

The date and time that the add-on was last modified.

serviceAccountRoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used by the add-on.

tags -> (map)

The metadata that you apply to the add-on to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Add-on tags do not propagate to any other resources associated with the cluster.

key -> (string)

value -> (string)