Skip to content
v2.274.0

CfnCapabilityProps Struct ​

Properties for defining a CfnCapability.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks as eks } from 'aws-cdk-lib';
const cfnCapabilityProps: eks.CfnCapabilityProps = {
  capabilityName: 'capabilityName',
  clusterName: 'clusterName',
  deletePropagationPolicy: 'deletePropagationPolicy',
  roleArn: 'roleArn',
  type: 'type',

  // the properties below are optional
  configuration: {
    ack: {
      disabledServices: ['disabledServices'],
      enableCrossNamespace: false,
    },
    argoCd: {
      awsIdc: {
        idcInstanceArn: 'idcInstanceArn',

        // the properties below are optional
        idcManagedApplicationArn: 'idcManagedApplicationArn',
        idcRegion: 'idcRegion',
      },

      // the properties below are optional
      endpointPrefix: 'endpointPrefix',
      namespace: 'namespace',
      networkAccess: {
        vpceIds: ['vpceIds'],
      },
      rbacRoleMappings: [{
        identities: [{
          id: 'id',
          type: 'type',
        }],
        role: 'role',
      }],
      serverUrl: 'serverUrl',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

capabilityNamestringcapability_namestrcapabilityNameStringCapabilityNamestringCapabilityName*stringrequired#
The unique name of the capability within the cluster.
clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*stringrequired#
The name of the Amazon EKS cluster that contains this capability.
configurationoptionalIResolvable | CfnCapability.CapabilityConfigurationPropertyconfigurationoptionaltyping.Union[IResolvable, CapabilityConfigurationProperty]configurationoptionalIResolvableConfigurationoptionalIResolvableConfigurationoptionalinterface{}#
The configuration settings for the capability.

The structure varies depending on the capability type.

deletePropagationPolicystringdelete_propagation_policystrdeletePropagationPolicyStringDeletePropagationPolicystringDeletePropagationPolicy*stringrequired#
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.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#
The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.
typestringtypestrtypeStringTypestringType*stringrequired#
The type of capability.

Valid values are ACK , ARGOCD , or KRO .