Package software.amazon.awscdk.services.eks

Interface CfnCapabilityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCapabilityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:20.418Z")
@Stability(Stable)
public interface CfnCapabilityProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCapability.

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.*;
 CfnCapabilityProps cfnCapabilityProps = CfnCapabilityProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCapabilityProps.Builder	A builder for CfnCapabilityProps
static final class	CfnCapabilityProps.Jsii$Proxy	An implementation for CfnCapabilityProps

Method Summary

Modifier and Type	Method	Description
static CfnCapabilityProps.Builder	builder()
String	getCapabilityName()	A unique name for the capability.
String	getClusterName()	The name of the EKS cluster where you want to create the capability.
default Object	getConfiguration()	Configuration settings for a capability.
String	getDeletePropagationPolicy()	Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
String	getType()	The type of capability to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapabilityName

@Stability(Stable)
@NotNull
String getCapabilityName()

A unique name for the capability.

The name must be unique within your cluster and can contain alphanumeric characters, hyphens, and underscores.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-capabilityname

getClusterName

@Stability(Stable)
@NotNull
String getClusterName()

The name of the EKS cluster where you want to create the capability.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-clustername

getDeletePropagationPolicy

@Stability(Stable)
@NotNull
String getDeletePropagationPolicy()

Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted.

Currently, the only supported value is RETAIN which retains all Kubernetes resources managed by the capability when the capability is deleted.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-deletepropagationpolicy

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

This role must have a trust policy that allows the EKS service principal to assume it, and it must have the necessary permissions for the capability type you're creating.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-rolearn

getType

@Stability(Stable)
@NotNull
String getType()

The type of capability to create.

Valid values are: ACK (AWS Controllers for Kubernetes, which lets you manage AWS resources directly from Kubernetes), ARGOCD (Argo CD for GitOps-based continuous delivery), or KRO (Kube Resource Orchestrator for composing and managing custom Kubernetes resources).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-type

getConfiguration

@Stability(Stable)
@Nullable
default Object getConfiguration()

Configuration settings for a capability.

The structure of this object varies depending on the capability type.

Returns union: either IResolvable or CfnCapability.CapabilityConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-configuration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-tags

builder

@Stability(Stable)
static CfnCapabilityProps.Builder builder()

Returns:

a CfnCapabilityProps.Builder of CfnCapabilityProps