interface CfnCapabilityProps

Language	Type name
.NET	Amazon.CDK.AWS.EKS.CfnCapabilityProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awseks#CfnCapabilityProps
Java	software.amazon.awscdk.services.eks.CfnCapabilityProps
Python	aws_cdk.aws_eks.CfnCapabilityProps
TypeScript	aws-cdk-lib » aws_eks » CfnCapabilityProps

Properties for defining a CfnCapability.

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

Example

// 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: {
    argoCd: {
      awsIdc: {
        idcInstanceArn: 'idcInstanceArn',

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

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

Properties

Name	Type	Description
capabilityName	string	The unique name of the capability within the cluster.
clusterName	string	The name of the Amazon EKS cluster that contains this capability.
deletePropagationPolicy	string	The delete propagation policy for the capability.
roleArn	string	The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.
type	string	The type of capability.
configuration?	IResolvable | CapabilityConfigurationProperty	The configuration settings for the capability.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

capabilityName

Type: string

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

---

clusterName

Type: string

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

---

deletePropagationPolicy

Type: string

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

---

roleArn

Type: string

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

---

type

Type: string

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

---

configuration?

Type: IResolvable | CapabilityConfigurationProperty (optional)

The configuration settings for the capability.

The structure varies depending on the capability type.

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

---

tags?

Type: CfnTag[] (optional)

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