CfnCapability

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

Bases: CfnResource

Resource Type definition for EKS Capability.

See:

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

CloudformationResource:

AWS::EKS::Capability

ExampleMetadata:

fixture=_generated

Example:

# 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 = eks.CfnCapability(self, "MyCfnCapability",
    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"
    )]
)

Create a new AWS::EKS::Capability.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • capability_name (str) – A unique name for the capability. The name must be unique within your cluster and can contain alphanumeric characters, hyphens, and underscores.

  • cluster_name (str) – The name of the EKS cluster where you want to create the capability.

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

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

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

  • configuration (Union[IResolvable, CapabilityConfigurationProperty, Dict[str, Any], None]) – Configuration settings for a capability. The structure of this object 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::EKS::Capability'
attr_arn

The Amazon Resource Name (ARN) of the capability.

CloudformationAttribute:

Arn

attr_configuration_argo_cd_aws_idc_idc_managed_application_arn

The ARN of the managed application created in IAM Identity Center for this Argo CD capability.

This application is automatically created and managed by EKS.

CloudformationAttribute:

Configuration.ArgoCd.AwsIdc.IdcManagedApplicationArn

attr_configuration_argo_cd_server_url

The URL of the Argo CD server.

Use this URL to access the Argo CD web interface and API.

CloudformationAttribute:

Configuration.ArgoCd.ServerUrl

attr_created_at

The Unix epoch timestamp in seconds for when the capability was created.

CloudformationAttribute:

CreatedAt

attr_modified_at

The Unix epoch timestamp in seconds for when the capability was last modified.

CloudformationAttribute:

ModifiedAt

attr_status

The current status of the capability.

Valid values include: CREATING (the capability is being created), ACTIVE (the capability is running and available), UPDATING (the capability is being updated), DELETING (the capability is being deleted), CREATE_FAILED (the capability creation failed), UPDATE_FAILED (the capability update failed), or DELETE_FAILED (the capability deletion failed).

CloudformationAttribute:

Status

attr_version

The version of the capability software that is currently running.

CloudformationAttribute:

Version

capability_name

A unique name for the capability.

capability_ref

A reference to a Capability resource.

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

cluster_name

The name of the EKS cluster where you want to create the capability.

configuration

Configuration settings for a capability.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

delete_propagation_policy

Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted.

env
logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

role_arn

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

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

type

The type of capability to create.

Static Methods

classmethod arn_for_capability(resource)
Parameters:

resource (ICapabilityRef)

Return type:

str

classmethod is_cfn_capability(x)

Checks whether the given object is a CfnCapability.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ArgoCdProperty

class CfnCapability.ArgoCdProperty(*, aws_idc, namespace=None, network_access=None, rbac_role_mappings=None, server_url=None)

Bases: object

Configuration settings for an Argo CD capability.

This includes the Kubernetes namespace, IAM Identity Center integration, RBAC role mappings, and network access configuration.

Parameters:

  • aws_idc (Union[IResolvable, AwsIdcProperty, Dict[str, Any]]) – Configuration for integrating Argo CD with IAM Identity Center. This allows you to use your organization’s identity provider for authentication to Argo CD.

  • namespace (Optional[str]) – The Kubernetes namespace where Argo CD resources will be created. If not specified, the default namespace is used.

  • network_access (Union[IResolvable, NetworkAccessProperty, Dict[str, Any], None]) – Configuration for network access to the Argo CD capability’s managed API server endpoint. By default, the Argo CD server is accessible via a public endpoint. You can optionally specify one or more VPC endpoint IDs to enable private connectivity from your VPCs.

  • rbac_role_mappings (Union[IResolvable, Sequence[Union[IResolvable, ArgoCdRoleMappingProperty, Dict[str, Any]]], None]) – A list of role mappings that define which IAM Identity Center users or groups have which Argo CD roles. Each mapping associates an Argo CD role (ADMIN, EDITOR, or VIEWER) with one or more IAM Identity Center identities.

  • server_url (Optional[str]) – The URL of the Argo CD server. Use this URL to access the Argo CD web interface and API.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

argo_cd_property = 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"
)

Attributes

aws_idc

Configuration for integrating Argo CD with IAM Identity Center.

This allows you to use your organization’s identity provider for authentication to Argo CD.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-awsidc

namespace

The Kubernetes namespace where Argo CD resources will be created.

If not specified, the default namespace is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-namespace

network_access

Configuration for network access to the Argo CD capability’s managed API server endpoint.

By default, the Argo CD server is accessible via a public endpoint. You can optionally specify one or more VPC endpoint IDs to enable private connectivity from your VPCs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-networkaccess

rbac_role_mappings

A list of role mappings that define which IAM Identity Center users or groups have which Argo CD roles.

Each mapping associates an Argo CD role (ADMIN, EDITOR, or VIEWER) with one or more IAM Identity Center identities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-rbacrolemappings

server_url

The URL of the Argo CD server.

Use this URL to access the Argo CD web interface and API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocd.html#cfn-eks-capability-argocd-serverurl

ArgoCdRoleMappingProperty

class CfnCapability.ArgoCdRoleMappingProperty(*, identities, role)

Bases: object

A mapping between an Argo CD role and IAM Identity Center identities.

This defines which users or groups have specific permissions in Argo CD.

Parameters:

  • identities (Union[IResolvable, Sequence[Union[IResolvable, SsoIdentityProperty, Dict[str, Any]]]]) – A list of IAM Identity Center identities (users or groups) that should be assigned this Argo CD role.

  • role (str) – The Argo CD role to assign. Valid values are: ADMIN (full administrative access to Argo CD), EDITOR (edit access to Argo CD resources), or VIEWER (read-only access to Argo CD resources).

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

argo_cd_role_mapping_property = eks.CfnCapability.ArgoCdRoleMappingProperty(
    identities=[eks.CfnCapability.SsoIdentityProperty(
        id="id",
        type="type"
    )],
    role="role"
)

Attributes

identities

A list of IAM Identity Center identities (users or groups) that should be assigned this Argo CD role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocdrolemapping.html#cfn-eks-capability-argocdrolemapping-identities

role

The Argo CD role to assign.

Valid values are: ADMIN (full administrative access to Argo CD), EDITOR (edit access to Argo CD resources), or VIEWER (read-only access to Argo CD resources).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-argocdrolemapping.html#cfn-eks-capability-argocdrolemapping-role

AwsIdcProperty

class CfnCapability.AwsIdcProperty(*, idc_instance_arn, idc_managed_application_arn=None, idc_region=None)

Bases: object

Configuration for integrating Argo CD with IAM Identity Center.

This allows you to use your organization’s identity provider for authentication to Argo CD.

Parameters:

  • idc_instance_arn (str) – The ARN of the IAM Identity Center instance to use for authentication.

  • idc_managed_application_arn (Optional[str]) – The ARN of the managed application created in IAM Identity Center for this Argo CD capability. This application is automatically created and managed by EKS.

  • idc_region (Optional[str]) – The Region where your IAM Identity Center instance is located.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

aws_idc_property = eks.CfnCapability.AwsIdcProperty(
    idc_instance_arn="idcInstanceArn",

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

Attributes

idc_instance_arn

The ARN of the IAM Identity Center instance to use for authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-awsidc.html#cfn-eks-capability-awsidc-idcinstancearn

idc_managed_application_arn

The ARN of the managed application created in IAM Identity Center for this Argo CD capability.

This application is automatically created and managed by EKS.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-awsidc.html#cfn-eks-capability-awsidc-idcmanagedapplicationarn

idc_region

The Region where your IAM Identity Center instance is located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-awsidc.html#cfn-eks-capability-awsidc-idcregion

CapabilityConfigurationProperty

class CfnCapability.CapabilityConfigurationProperty(*, argo_cd=None)

Bases: object

Configuration settings for a capability.

The structure of this object varies depending on the capability type.

Parameters:

argo_cd (Union[IResolvable, ArgoCdProperty, Dict[str, Any], None]) – Configuration settings for an Argo CD capability. This includes the Kubernetes namespace, IAM Identity Center integration, RBAC role mappings, and network access configuration.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

capability_configuration_property = 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"
    )
)

Attributes

argo_cd

Configuration settings for an Argo CD capability.

This includes the Kubernetes namespace, IAM Identity Center integration, RBAC role mappings, and network access configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-capabilityconfiguration.html#cfn-eks-capability-capabilityconfiguration-argocd

NetworkAccessProperty

class CfnCapability.NetworkAccessProperty(*, vpce_ids=None)

Bases: object

Configuration for network access to the Argo CD capability’s managed API server endpoint.

By default, the Argo CD server is accessible via a public endpoint. You can optionally specify one or more VPC endpoint IDs to enable private connectivity from your VPCs.

Parameters:

vpce_ids (Optional[Sequence[str]]) – A list of VPC endpoint IDs to associate with the managed Argo CD API server endpoint. Each VPC endpoint provides private connectivity from a specific VPC to the Argo CD server. You can specify multiple VPC endpoint IDs to enable access from multiple VPCs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

network_access_property = eks.CfnCapability.NetworkAccessProperty(
    vpce_ids=["vpceIds"]
)

Attributes

vpce_ids

A list of VPC endpoint IDs to associate with the managed Argo CD API server endpoint.

Each VPC endpoint provides private connectivity from a specific VPC to the Argo CD server. You can specify multiple VPC endpoint IDs to enable access from multiple VPCs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-networkaccess.html#cfn-eks-capability-networkaccess-vpceids

SsoIdentityProperty

class CfnCapability.SsoIdentityProperty(*, id, type)

Bases: object

An IAM Identity Center identity (user or group) that can be assigned permissions in a capability.

Parameters:

  • id (str) – The unique identifier of the IAM Identity Center user or group.

  • type (str) – The type of identity. Valid values are SSO_USER or SSO_GROUP.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# 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

sso_identity_property = eks.CfnCapability.SsoIdentityProperty(
    id="id",
    type="type"
)

Attributes

id

The unique identifier of the IAM Identity Center user or group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-capability-ssoidentity.html#cfn-eks-capability-ssoidentity-id

type

The type of identity.

Valid values are SSO_USER or SSO_GROUP.

See:

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