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.125.0 (build fdbe357)",
           date="2026-01-19T12:03:54.124Z")
@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()	The unique name of the capability within the cluster.
String	getClusterName()	The name of the Amazon EKS cluster that contains this capability.
default Object	getConfiguration()	The configuration settings for the capability.
String	getDeletePropagationPolicy()	The delete propagation policy for the capability.
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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapabilityName

@Stability(Stable)
@NotNull
String getCapabilityName()

The unique name of the capability within the cluster.

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 Amazon EKS cluster that contains this 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()

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.

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.

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.

Valid values are ACK , ARGOCD , or KRO .

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()

The configuration settings for the capability.

The structure 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