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	A unique name for the capability.
clusterName	string	The name of the EKS cluster where you want to create the capability.
deletePropagationPolicy	string	Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted.
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 to create.
configuration?	IResolvable | CapabilityConfigurationProperty	Configuration settings for a capability.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

capabilityName

Type: string

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

---

clusterName

Type: string

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

---

deletePropagationPolicy

Type: string

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

---

roleArn

Type: string

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

---

type

Type: string

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

---

configuration?

Type: IResolvable | CapabilityConfigurationProperty (optional)

Configuration settings for a capability.

The structure of this object 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