Package software.amazon.awscdk.services.eks

Class CfnCapability

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.eks.CfnCapability
All Implemented Interfaces:
IInspectable, ICapabilityRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-19T12:03:54.121Z") @Stability(Stable) public class CfnCapability extends CfnResource implements IInspectable, ICapabilityRef, ITaggableV2
An object representing a managed capability in an Amazon EKS cluster.

This includes all configuration, status, and health information for the capability.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.*;
 CfnCapability cfnCapability = CfnCapability.Builder.create(this, "MyCfnCapability")
         .capabilityName("capabilityName")
         .clusterName("clusterName")
         .deletePropagationPolicy("deletePropagationPolicy")
         .roleArn("roleArn")
         .type("type")
         // the properties below are optional
         .configuration(CapabilityConfigurationProperty.builder()
                 .argoCd(ArgoCdProperty.builder()
                         .awsIdc(AwsIdcProperty.builder()
                                 .idcInstanceArn("idcInstanceArn")
                                 // the properties below are optional
                                 .idcManagedApplicationArn("idcManagedApplicationArn")
                                 .idcRegion("idcRegion")
                                 .build())
                         // the properties below are optional
                         .namespace("namespace")
                         .networkAccess(NetworkAccessProperty.builder()
                                 .vpceIds(List.of("vpceIds"))
                                 .build())
                         .rbacRoleMappings(List.of(ArgoCdRoleMappingProperty.builder()
                                 .identities(List.of(SsoIdentityProperty.builder()
                                         .id("id")
                                         .type("type")
                                         .build()))
                                 .role("role")
                                 .build()))
                         .serverUrl("serverUrl")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCapability

      protected CfnCapability(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCapability

      protected CfnCapability(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCapability

      @Stability(Stable) public CfnCapability(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCapabilityProps props)
      Create a new AWS::EKS::Capability.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForCapability

      @Stability(Stable) @NotNull public static String arnForCapability(@NotNull ICapabilityRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnCapability

      @Stability(Stable) @NotNull public static Boolean isCfnCapability(@NotNull Object x)
      Checks whether the given object is a CfnCapability.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the capability.

    • getAttrConfigurationArgoCdAwsIdcIdcManagedApplicationArn

      @Stability(Stable) @NotNull public String getAttrConfigurationArgoCdAwsIdcIdcManagedApplicationArn()
      The ARN of the managed application created in IAM Identity Center for this Argo CD capability.

      This application is automatically created and managed by EKS.

    • getAttrConfigurationArgoCdServerUrl

      @Stability(Stable) @NotNull public String getAttrConfigurationArgoCdServerUrl()
      The URL of the Argo CD server.

      Use this URL to access the Argo CD web interface and API.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The Unix epoch timestamp in seconds for when the capability was created.

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()
      The Unix epoch timestamp in seconds for when the capability was last modified.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      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.

    • getAttrVersion

      @Stability(Stable) @NotNull public String getAttrVersion()
      The version of the capability software that is currently running.

    • getCapabilityRef

      @Stability(Stable) @NotNull public CapabilityReference getCapabilityRef()
      A reference to a Capability resource.
      Specified by:
      getCapabilityRef in interface ICapabilityRef

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCapabilityName

      @Stability(Stable) @NotNull public String getCapabilityName()
      The unique name of the capability within the cluster.

    • setCapabilityName

      @Stability(Stable) public void setCapabilityName(@NotNull String value)
      The unique name of the capability within the cluster.

    • getClusterName

      @Stability(Stable) @NotNull public String getClusterName()
      The name of the Amazon EKS cluster that contains this capability.

    • setClusterName

      @Stability(Stable) public void setClusterName(@NotNull String value)
      The name of the Amazon EKS cluster that contains this capability.

    • getDeletePropagationPolicy

      @Stability(Stable) @NotNull public String getDeletePropagationPolicy()
      The delete propagation policy for the capability.

    • setDeletePropagationPolicy

      @Stability(Stable) public void setDeletePropagationPolicy(@NotNull String value)
      The delete propagation policy for the capability.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of capability.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of capability.

    • getConfiguration

      @Stability(Stable) @Nullable public Object getConfiguration()
      The configuration settings for the capability.

      Returns union: either IResolvable or CfnCapability.CapabilityConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable IResolvable value)
      The configuration settings for the capability.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable CfnCapability.CapabilityConfigurationProperty value)
      The configuration settings for the capability.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.