Skip to content

Addon

Source code in docs_src/capo_eks/types/addon.py
class Addon(TypedDict, closed=True):
    addon_name: NotRequired["capo_eks.types.string.String"]
    """<p>The name of the add-on.</p>"""
    cluster_name: NotRequired["capo_eks.types.cluster_name.ClusterName"]
    """<p>The name of your cluster.</p>"""
    status: NotRequired["capo_eks.types.addon_status.AddonStatus"]
    """<p>The status of the add-on.</p>"""
    addon_version: NotRequired["capo_eks.types.string.String"]
    """<p>The version of the add-on.</p>"""
    health: NotRequired["capo_eks.types.addon_health.AddonHealth"]
    """<p>An object that represents the health of the add-on.</p>"""
    addon_arn: NotRequired["capo_eks.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the add-on.</p>"""
    created_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp at object creation.</p>"""
    modified_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp for the last modification to the object.</p>"""
    service_account_role_arn: NotRequired["capo_eks.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes <code>ServiceAccount</code> object that the add-on uses.</p>"""
    tags: NotRequired["capo_eks.types.tag_map.TagMap"]
    """<p>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.</p>"""
    publisher: NotRequired["capo_eks.types.string.String"]
    """<p>The publisher of the add-on.</p>"""
    owner: NotRequired["capo_eks.types.string.String"]
    """<p>The owner of the add-on.</p>"""
    marketplace_information: NotRequired[
        "capo_eks.types.marketplace_information.MarketplaceInformation"
    ]
    """<p>Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.</p>"""
    configuration_values: NotRequired["capo_eks.types.string.String"]
    """<p>The configuration values that you provided.</p>"""
    pod_identity_associations: NotRequired["capo_eks.types.string_list.StringList"]
    """<p>An array of EKS Pod Identity associations owned by the add-on. Each association maps a role to a service account in a namespace in the cluster.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html">Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity</a> in the <i>Amazon EKS User Guide</i>.</p>"""
    namespace_config: NotRequired[
        "capo_eks.types.addon_namespace_config_response.AddonNamespaceConfigResponse"
    ]
    """<p>The namespace configuration for the addon. This specifies the Kubernetes namespace where the addon is installed.</p>"""

addon_arn instance-attribute

addon_arn: NotRequired[String]

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

addon_name instance-attribute

addon_name: NotRequired[String]

The name of the add-on.

addon_version instance-attribute

addon_version: NotRequired[String]

The version of the add-on.

cluster_name instance-attribute

cluster_name: NotRequired[ClusterName]

The name of your cluster.

configuration_values instance-attribute

configuration_values: NotRequired[String]

The configuration values that you provided.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The Unix epoch timestamp at object creation.

health instance-attribute

health: NotRequired[AddonHealth]

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

marketplace_information instance-attribute

marketplace_information: NotRequired[MarketplaceInformation]

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

modified_at instance-attribute

modified_at: NotRequired[Timestamp]

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

namespace_config instance-attribute

namespace_config: NotRequired[AddonNamespaceConfigResponse]

The namespace configuration for the addon. This specifies the Kubernetes namespace where the addon is installed.

owner instance-attribute

owner: NotRequired[String]

The owner of the add-on.

pod_identity_associations instance-attribute

pod_identity_associations: NotRequired[StringList]

An array of EKS Pod Identity associations owned by the add-on. Each association maps a role to a service account in a namespace in the cluster.

For more information, see Attach an IAM Role to an Amazon EKS add-on using EKS Pod Identity in the Amazon EKS User Guide.

publisher instance-attribute

publisher: NotRequired[String]

The publisher of the add-on.

service_account_role_arn instance-attribute

service_account_role_arn: NotRequired[String]

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

status instance-attribute

status: NotRequired[AddonStatus]

The status of the add-on.

tags instance-attribute

tags: NotRequired[TagMap]

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.