Skip to content

Capability

Source code in docs_src/capo_eks/types/capability.py
class Capability(TypedDict, closed=True):
    capability_name: NotRequired["capo_eks.types.string.String"]
    """<p>The unique name of the capability within the cluster.</p>"""
    arn: NotRequired["capo_eks.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the capability.</p>"""
    cluster_name: NotRequired["capo_eks.types.string.String"]
    """<p>The name of the Amazon EKS cluster that contains this capability.</p>"""
    type: NotRequired["capo_eks.types.capability_type.CapabilityType"]
    """<p>The type of capability. Valid values are <code>ACK</code>, <code>ARGOCD</code>, or <code>KRO</code>.</p>"""
    role_arn: NotRequired["capo_eks.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services.</p>"""
    status: NotRequired["capo_eks.types.capability_status.CapabilityStatus"]
    """<p>The current status of the capability. Valid values include:</p> <ul> <li> <p> <code>CREATING</code> – The capability is being created.</p> </li> <li> <p> <code>ACTIVE</code> – The capability is running and available.</p> </li> <li> <p> <code>UPDATING</code> – The capability is being updated.</p> </li> <li> <p> <code>DELETING</code> – The capability is being deleted.</p> </li> <li> <p> <code>CREATE_FAILED</code> – The capability creation failed.</p> </li> <li> <p> <code>UPDATE_FAILED</code> – The capability update failed.</p> </li> <li> <p> <code>DELETE_FAILED</code> – The capability deletion failed.</p> </li> </ul>"""
    version: NotRequired["capo_eks.types.string.String"]
    """<p>The version of the capability software that is currently running.</p>"""
    configuration: NotRequired[
        "capo_eks.types.capability_configuration_response.CapabilityConfigurationResponse"
    ]
    """<p>The configuration settings for the capability. The structure varies depending on the capability type.</p>"""
    tags: NotRequired["capo_eks.types.tag_map.TagMap"]
    health: NotRequired["capo_eks.types.capability_health.CapabilityHealth"]
    """<p>Health information for the capability, including any issues that may be affecting its operation.</p>"""
    created_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp in seconds for when the capability was created.</p>"""
    modified_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp in seconds for when the capability was last modified.</p>"""
    delete_propagation_policy: NotRequired[
        "capo_eks.types.capability_delete_propagation_policy.CapabilityDeletePropagationPolicy"
    ]
    """<p>The delete propagation policy for the capability. Currently, the only supported value is <code>RETAIN</code>, which keeps all resources managed by the capability when the capability is deleted.</p>"""

arn instance-attribute

arn: NotRequired[String]

The Amazon Resource Name (ARN) of the capability.

capability_name instance-attribute

capability_name: NotRequired[String]

The unique name of the capability within the cluster.

cluster_name instance-attribute

cluster_name: NotRequired[String]

The name of the Amazon EKS cluster that contains this capability.

configuration instance-attribute

configuration: NotRequired[CapabilityConfigurationResponse]

The configuration settings for the capability. The structure varies depending on the capability type.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The Unix epoch timestamp in seconds for when the capability was created.

delete_propagation_policy instance-attribute

delete_propagation_policy: NotRequired[CapabilityDeletePropagationPolicy]

The delete propagation policy for the capability. Currently, the only supported value is RETAIN, which keeps all resources managed by the capability when the capability is deleted.

health instance-attribute

health: NotRequired[CapabilityHealth]

Health information for the capability, including any issues that may be affecting its operation.

modified_at instance-attribute

modified_at: NotRequired[Timestamp]

The Unix epoch timestamp in seconds for when the capability was last modified.

role_arn instance-attribute

role_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services.

status instance-attribute

status: NotRequired[CapabilityStatus]

The current status of the capability. Valid values include:

  • CREATING – The capability is being created.

  • ACTIVE – The capability is running and available.

  • UPDATING – The capability is being updated.

  • DELETING – The capability is being deleted.

  • CREATE_FAILED – The capability creation failed.

  • UPDATE_FAILED – The capability update failed.

  • DELETE_FAILED – The capability deletion failed.

tags instance-attribute

tags: NotRequired[TagMap]

type instance-attribute

type: NotRequired[CapabilityType]

The type of capability. Valid values are ACK, ARGOCD, or KRO.

version instance-attribute

version: NotRequired[String]

The version of the capability software that is currently running.