CfnIdNamespaceProps

class aws_cdk.aws_entityresolution.CfnIdNamespaceProps(*, id_namespace_name, type, description=None, id_mapping_workflow_properties=None, input_source_config=None, role_arn=None, tags=None)

Bases: object

Properties for defining a CfnIdNamespace.

Parameters:

  • id_namespace_name (str) – The name of the ID namespace.

  • type (str) – The type of ID namespace. There are two types: SOURCE and TARGET . The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow. The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

  • description (Optional[str]) – The description of the ID namespace.

  • id_mapping_workflow_properties (Union[IResolvable, Sequence[Union[IResolvable, IdNamespaceIdMappingWorkflowPropertiesProperty, Dict[str, Any]]], None]) – Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .

  • input_source_config (Union[IResolvable, Sequence[Union[IResolvable, IdNamespaceInputSourceProperty, Dict[str, Any]]], None]) – A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

  • role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.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_entityresolution as entityresolution

cfn_id_namespace_props = entityresolution.CfnIdNamespaceProps(
    id_namespace_name="idNamespaceName",
    type="type",

    # the properties below are optional
    description="description",
    id_mapping_workflow_properties=[entityresolution.CfnIdNamespace.IdNamespaceIdMappingWorkflowPropertiesProperty(
        id_mapping_type="idMappingType",

        # the properties below are optional
        provider_properties=entityresolution.CfnIdNamespace.NamespaceProviderPropertiesProperty(
            provider_service_arn="providerServiceArn",

            # the properties below are optional
            provider_configuration={
                "provider_configuration_key": "providerConfiguration"
            }
        )
    )],
    input_source_config=[entityresolution.CfnIdNamespace.IdNamespaceInputSourceProperty(
        input_source_arn="inputSourceArn",

        # the properties below are optional
        schema_name="schemaName"
    )],
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the ID namespace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-description

id_mapping_workflow_properties

Determines the properties of IdMappingWorflow where this IdNamespace can be used as a Source or a Target .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-idmappingworkflowproperties

id_namespace_name

The name of the ID namespace.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-idnamespacename

input_source_config

A list of InputSource objects, which have the fields InputSourceARN and SchemaName .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html#cfn-entityresolution-idnamespace-inputsourceconfig

role_arn

The Amazon Resource Name (ARN) of the IAM role.

AWS Entity Resolution assumes this role to access the resources defined in this IdNamespace on your behalf as part of the workflow run.

See:

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

tags

The tags used to organize, track, or control access for this resource.

See:

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

type

SOURCE and TARGET .

The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

The TARGET contains a configuration of targetId to which all sourceIds will resolve to.

See:

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

Type:

The type of ID namespace. There are two types