Skip to content

Describe Capability

eks_describe_capability R Documentation

Returns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation

Description

Returns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation.

Usage

eks_describe_capability(clusterName, capabilityName)

Arguments

clusterName

[required] The name of the Amazon EKS cluster that contains the capability you want to describe.

capabilityName

[required] The name of the capability to describe.

Value

A list with the following syntax:

list(
  capability = list(
    capabilityName = "string",
    arn = "string",
    clusterName = "string",
    type = "ACK"|"KRO"|"ARGOCD",
    roleArn = "string",
    status = "CREATING"|"CREATE_FAILED"|"UPDATING"|"DELETING"|"DELETE_FAILED"|"ACTIVE"|"DEGRADED",
    version = "string",
    configuration = list(
      argoCd = list(
        namespace = "string",
        awsIdc = list(
          idcInstanceArn = "string",
          idcRegion = "string",
          idcManagedApplicationArn = "string"
        ),
        rbacRoleMappings = list(
          list(
            role = "ADMIN"|"EDITOR"|"VIEWER",
            identities = list(
              list(
                id = "string",
                type = "SSO_USER"|"SSO_GROUP"
              )
            )
          )
        ),
        networkAccess = list(
          vpceIds = list(
            "string"
          )
        ),
        serverUrl = "string"
      )
    ),
    tags = list(
      "string"
    ),
    health = list(
      issues = list(
        list(
          code = "AccessDenied"|"ClusterUnreachable",
          message = "string"
        )
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    modifiedAt = as.POSIXct(
      "2015-01-01"
    ),
    deletePropagationPolicy = "RETAIN"
  )
)

Request syntax

svc$describe_capability(
  clusterName = "string",
  capabilityName = "string"
)