CfnCapabilityProps

class aws_cdk.aws_eks.CfnCapabilityProps(*, capability_name, cluster_name, delete_propagation_policy, role_arn, type, configuration=None, tags=None)

Bases: object

Properties for defining a CfnCapability.

Parameters:
  • capability_name (str) – The unique name of the capability within the cluster.

  • cluster_name (str) – The name of the Amazon EKS cluster that contains this capability.

  • delete_propagation_policy (str) – 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.

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

  • type (str) – The type of capability. Valid values are ACK , ARGOCD , or KRO .

  • configuration (Union[IResolvable, CapabilityConfigurationProperty, Dict[str, Any], None]) – The configuration settings for the capability. The structure varies depending on the capability type.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eks as eks

cfn_capability_props = eks.CfnCapabilityProps(
    capability_name="capabilityName",
    cluster_name="clusterName",
    delete_propagation_policy="deletePropagationPolicy",
    role_arn="roleArn",
    type="type",

    # the properties below are optional
    configuration=eks.CfnCapability.CapabilityConfigurationProperty(
        argo_cd=eks.CfnCapability.ArgoCdProperty(
            aws_idc=eks.CfnCapability.AwsIdcProperty(
                idc_instance_arn="idcInstanceArn",

                # the properties below are optional
                idc_managed_application_arn="idcManagedApplicationArn",
                idc_region="idcRegion"
            ),

            # the properties below are optional
            namespace="namespace",
            network_access=eks.CfnCapability.NetworkAccessProperty(
                vpce_ids=["vpceIds"]
            ),
            rbac_role_mappings=[eks.CfnCapability.ArgoCdRoleMappingProperty(
                identities=[eks.CfnCapability.SsoIdentityProperty(
                    id="id",
                    type="type"
                )],
                role="role"
            )],
            server_url="serverUrl"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

capability_name

The unique name of the capability within the cluster.

See:

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

cluster_name

The name of the Amazon EKS cluster that contains this capability.

See:

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

configuration

The configuration settings for the capability.

The structure varies depending on the capability type.

See:

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

delete_propagation_policy

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:

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

role_arn

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

See:

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

tags

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

See:

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

type

The type of capability.

Valid values are ACK , ARGOCD , or KRO .

See:

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