Skip to content

/AWS1/CL_EKSCAPABILITY

An object representing a managed capability in an Amazon EKS cluster. This includes all configuration, status, and health information for the capability.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_capabilityname TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

The unique name of the capability within the cluster.

iv_arn TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

The Amazon Resource Name (ARN) of the capability.

iv_clustername TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

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

iv_type TYPE /AWS1/EKSCAPABILITYTYPE /AWS1/EKSCAPABILITYTYPE

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

iv_rolearn TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

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

iv_status TYPE /AWS1/EKSCAPABILITYSTATUS /AWS1/EKSCAPABILITYSTATUS

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.

iv_version TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

The version of the capability software that is currently running.

io_configuration TYPE REF TO /AWS1/CL_EKSCAPABILITYCONFRSP /AWS1/CL_EKSCAPABILITYCONFRSP

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

it_tags TYPE /AWS1/CL_EKSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource – 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length – 128 Unicode characters in UTF-8

  • Maximum value length – 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

io_health TYPE REF TO /AWS1/CL_EKSCAPABILITYHEALTH /AWS1/CL_EKSCAPABILITYHEALTH

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

iv_createdat TYPE /AWS1/EKSTIMESTAMP /AWS1/EKSTIMESTAMP

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

iv_modifiedat TYPE /AWS1/EKSTIMESTAMP /AWS1/EKSTIMESTAMP

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

iv_deletepropagationpolicy TYPE /AWS1/EKSCAPABILITYDELPROPPLY /AWS1/EKSCAPABILITYDELPROPPLY

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.

Queryable Attributes

capabilityName

The unique name of the capability within the cluster.

Accessible with the following methods

Method Description
GET_CAPABILITYNAME() Getter for CAPABILITYNAME, with configurable default
ASK_CAPABILITYNAME() Getter for CAPABILITYNAME w/ exceptions if field has no valu
HAS_CAPABILITYNAME() Determine if CAPABILITYNAME has a value

arn

The Amazon Resource Name (ARN) of the capability.

Accessible with the following methods

Method Description
GET_ARN() Getter for ARN, with configurable default
ASK_ARN() Getter for ARN w/ exceptions if field has no value
HAS_ARN() Determine if ARN has a value

clusterName

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

Accessible with the following methods

Method Description
GET_CLUSTERNAME() Getter for CLUSTERNAME, with configurable default
ASK_CLUSTERNAME() Getter for CLUSTERNAME w/ exceptions if field has no value
HAS_CLUSTERNAME() Determine if CLUSTERNAME has a value

type

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

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE, with configurable default
ASK_TYPE() Getter for TYPE w/ exceptions if field has no value
HAS_TYPE() Determine if TYPE has a value

roleArn

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

Accessible with the following methods

Method Description
GET_ROLEARN() Getter for ROLEARN, with configurable default
ASK_ROLEARN() Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN() Determine if ROLEARN has a value

status

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

version

The version of the capability software that is currently running.

Accessible with the following methods

Method Description
GET_VERSION() Getter for VERSION, with configurable default
ASK_VERSION() Getter for VERSION w/ exceptions if field has no value
HAS_VERSION() Determine if VERSION has a value

configuration

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

Accessible with the following methods

Method Description
GET_CONFIGURATION() Getter for CONFIGURATION

tags

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource – 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length – 128 Unicode characters in UTF-8

  • Maximum value length – 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Accessible with the following methods

Method Description
GET_TAGS() Getter for TAGS, with configurable default
ASK_TAGS() Getter for TAGS w/ exceptions if field has no value
HAS_TAGS() Determine if TAGS has a value

health

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

Accessible with the following methods

Method Description
GET_HEALTH() Getter for HEALTH

createdAt

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

Accessible with the following methods

Method Description
GET_CREATEDAT() Getter for CREATEDAT, with configurable default
ASK_CREATEDAT() Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT() Determine if CREATEDAT has a value

modifiedAt

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

Accessible with the following methods

Method Description
GET_MODIFIEDAT() Getter for MODIFIEDAT, with configurable default
ASK_MODIFIEDAT() Getter for MODIFIEDAT w/ exceptions if field has no value
HAS_MODIFIEDAT() Determine if MODIFIEDAT has a value

deletePropagationPolicy

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.

Accessible with the following methods

Method Description
GET_DELETEPROPAGATIONPOLICY() Getter for DELETEPROPAGATIONPOLICY, with configurable defaul
ASK_DELETEPROPAGATIONPOLICY() Getter for DELETEPROPAGATIONPOLICY w/ exceptions if field ha
HAS_DELETEPROPAGATIONPOLICY() Determine if DELETEPROPAGATIONPOLICY has a value