AWS::EKS::Capability - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EKS::Capability

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EKS::Capability",
  "Properties" : {
      "CapabilityName" : String,
      "ClusterName" : String,
      "Configuration" : CapabilityConfiguration,
      "DeletePropagationPolicy" : String,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::EKS::Capability
Properties:
  CapabilityName: String
  ClusterName: String
  Configuration: 
    CapabilityConfiguration
  DeletePropagationPolicy: String
  RoleArn: String
  Tags: 
    - Tag
  Type: String

Properties

CapabilityName

The unique name of the capability within the cluster.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: Replacement

ClusterName

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

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: Replacement

Configuration

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

Required: No

Type: CapabilityConfiguration

Update requires: No interruption

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.

Required: Yes

Type: String

Allowed values: RETAIN

Update requires: No interruption

RoleArn

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

Required: Yes

Type: String

Pattern: ^arn:aws[a-z-]*:iam::[0-9]+:role/[a-zA-Z0-9+=,.@_-]+$

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Type

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

Required: Yes

Type: String

Allowed values: ARGOCD | ACK | KRO

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the capability.

Configuration.ArgoCd.AwsIdc.IdcManagedApplicationArn

Property description not available.

Configuration.ArgoCd.ServerUrl

Property description not available.

CreatedAt

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

ModifiedAt

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

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.

Version

The version of the capability software that is currently running.