CfnIdMappingWorkflowPropsMixin

class aws_cdk.mixins_preview.aws_entityresolution.mixins.CfnIdMappingWorkflowPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an IdMappingWorkflow object which stores the configuration of the data processing job to be run.

Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API. .. epigraph:

Incremental processing is not supported for ID mapping workflows.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idmappingworkflow.html

CloudformationResource:

AWS::EntityResolution::IdMappingWorkflow

Mixin:

true

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

cfn_id_mapping_workflow_props_mixin = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin(entityresolution_mixins.CfnIdMappingWorkflowMixinProps(
    description="description",
    id_mapping_incremental_run_config=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingIncrementalRunConfigProperty(
        incremental_run_type="incrementalRunType"
    ),
    id_mapping_techniques=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingTechniquesProperty(
        id_mapping_type="idMappingType",
        normalization_version="normalizationVersion",
        provider_properties=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.ProviderPropertiesProperty(
            intermediate_source_configuration=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IntermediateSourceConfigurationProperty(
                intermediate_s3_path="intermediateS3Path"
            ),
            provider_configuration={
                "provider_configuration_key": "providerConfiguration"
            },
            provider_service_arn="providerServiceArn"
        ),
        rule_based_properties=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingRuleBasedPropertiesProperty(
            attribute_matching_model="attributeMatchingModel",
            record_matching_model="recordMatchingModel",
            rule_definition_type="ruleDefinitionType",
            rules=[entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.RuleProperty(
                matching_keys=["matchingKeys"],
                rule_name="ruleName"
            )]
        )
    ),
    input_source_config=[entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingWorkflowInputSourceProperty(
        input_source_arn="inputSourceArn",
        schema_arn="schemaArn",
        type="type"
    )],
    output_source_config=[entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingWorkflowOutputSourceProperty(
        kms_arn="kmsArn",
        output_s3_path="outputS3Path"
    )],
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    workflow_name="workflowName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EntityResolution::IdMappingWorkflow.

Parameters:

• props (Union[CfnIdMappingWorkflowMixinProps, Dict[str, Any]]) – L1 properties to apply.

• strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'idMappingIncrementalRunConfig', 'idMappingTechniques', 'inputSourceConfig', 'outputSourceConfig', 'roleArn', 'tags', 'workflowName']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

Stability:

experimental

IdMappingIncrementalRunConfigProperty

class CfnIdMappingWorkflowPropsMixin.IdMappingIncrementalRunConfigProperty(*, incremental_run_type=None)

Bases: object

Parameters:

incremental_run_type (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig.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.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

id_mapping_incremental_run_config_property = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingIncrementalRunConfigProperty(
    incremental_run_type="incrementalRunType"
)

Attributes

incremental_run_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingincrementalrunconfig.html#cfn-entityresolution-idmappingworkflow-idmappingincrementalrunconfig-incrementalruntype

Type:

see

IdMappingRuleBasedPropertiesProperty

class CfnIdMappingWorkflowPropsMixin.IdMappingRuleBasedPropertiesProperty(*, attribute_matching_model=None, record_matching_model=None, rule_definition_type=None, rules=None)

Bases: object

An object that defines the list of matching rules to run in an ID mapping workflow.

Parameters:

• attribute_matching_model (Optional[str]) – The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel . If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B. If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

• record_matching_model (Optional[str]) – The type of matching record that is allowed to be used in an ID mapping workflow. If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source can be matched to the same record in the target. If the value is set to MANY_SOURCE_TO_ONE_TARGET , multiple records in the source can be matched to one record in the target.

• rule_definition_type (Optional[str]) – The set of rules you can use in an ID mapping workflow. The limitations specified for the source or target to define the match rules must be compatible.

• rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]], None]) – The rules that can be used for ID mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.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.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

id_mapping_rule_based_properties_property = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingRuleBasedPropertiesProperty(
    attribute_matching_model="attributeMatchingModel",
    record_matching_model="recordMatchingModel",
    rule_definition_type="ruleDefinitionType",
    rules=[entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.RuleProperty(
        matching_keys=["matchingKeys"],
        rule_name="ruleName"
    )]
)

Attributes

attribute_matching_model

The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the attributeMatchingModel .

If you choose ONE_TO_ONE , the system can only match attributes if the sub-types are an exact match. For example, for the Email attribute type, the system will only consider it a match if the value of the Email field of Profile A matches the value of the Email field of Profile B.

If you choose MANY_TO_MANY , the system can match attributes across the sub-types of an attribute type. For example, if the value of the Email field of Profile A matches the value of the BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-attributematchingmodel

record_matching_model

The type of matching record that is allowed to be used in an ID mapping workflow.

If the value is set to ONE_SOURCE_TO_ONE_TARGET , only one record in the source can be matched to the same record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET , multiple records in the source can be matched to one record in the target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-recordmatchingmodel

rule_definition_type

The set of rules you can use in an ID mapping workflow.

The limitations specified for the source or target to define the match rules must be compatible.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-ruledefinitiontype

rules

The rules that can be used for ID mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingrulebasedproperties.html#cfn-entityresolution-idmappingworkflow-idmappingrulebasedproperties-rules

IdMappingTechniquesProperty

class CfnIdMappingWorkflowPropsMixin.IdMappingTechniquesProperty(*, id_mapping_type=None, normalization_version=None, provider_properties=None, rule_based_properties=None)

Bases: object

An object which defines the ID mapping technique and any additional configurations.

Parameters:

• id_mapping_type (Optional[str]) – The type of ID mapping.

• normalization_version (Optional[str])

• provider_properties (Union[IResolvable, ProviderPropertiesProperty, Dict[str, Any], None]) – An object which defines any additional configurations required by the provider service.

• rule_based_properties (Union[IResolvable, IdMappingRuleBasedPropertiesProperty, Dict[str, Any], None]) – An object which defines any additional configurations required by rule-based matching.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.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.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

id_mapping_techniques_property = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingTechniquesProperty(
    id_mapping_type="idMappingType",
    normalization_version="normalizationVersion",
    provider_properties=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.ProviderPropertiesProperty(
        intermediate_source_configuration=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IntermediateSourceConfigurationProperty(
            intermediate_s3_path="intermediateS3Path"
        ),
        provider_configuration={
            "provider_configuration_key": "providerConfiguration"
        },
        provider_service_arn="providerServiceArn"
    ),
    rule_based_properties=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingRuleBasedPropertiesProperty(
        attribute_matching_model="attributeMatchingModel",
        record_matching_model="recordMatchingModel",
        rule_definition_type="ruleDefinitionType",
        rules=[entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.RuleProperty(
            matching_keys=["matchingKeys"],
            rule_name="ruleName"
        )]
    )
)

Attributes

id_mapping_type

The type of ID mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-idmappingtype

normalization_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-normalizationversion

Type:

see

provider_properties

An object which defines any additional configurations required by the provider service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-providerproperties

rule_based_properties

An object which defines any additional configurations required by rule-based matching.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingtechniques.html#cfn-entityresolution-idmappingworkflow-idmappingtechniques-rulebasedproperties

IdMappingWorkflowInputSourceProperty

class CfnIdMappingWorkflowPropsMixin.IdMappingWorkflowInputSourceProperty(*, input_source_arn=None, schema_arn=None, type=None)

Bases: object

An object containing inputSourceARN , schemaName , and type .

Parameters:

• input_source_arn (Optional[str]) – An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

• schema_arn (Optional[str]) – The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .

• type (Optional[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 which all sourceIds will resolve to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.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.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

id_mapping_workflow_input_source_property = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingWorkflowInputSourceProperty(
    input_source_arn="inputSourceArn",
    schema_arn="schemaArn",
    type="type"
)

Attributes

input_source_arn

An AWS Glue table Amazon Resource Name (ARN) or a matching workflow ARN for the input source table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-inputsourcearn

schema_arn

The ARN (Amazon Resource Name) that AWS Entity Resolution generated for the SchemaMapping .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-schemaarn

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 which all sourceIds will resolve to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowinputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowinputsource-type

Type:

The type of ID namespace. There are two types

IdMappingWorkflowOutputSourceProperty

class CfnIdMappingWorkflowPropsMixin.IdMappingWorkflowOutputSourceProperty(*, kms_arn=None, output_s3_path=None)

Bases: object

A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn .

Parameters:

• kms_arn (Optional[str]) – Customer AWS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.

• output_s3_path (Optional[str]) – The S3 path to which AWS Entity Resolution will write the output table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.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.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

id_mapping_workflow_output_source_property = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IdMappingWorkflowOutputSourceProperty(
    kms_arn="kmsArn",
    output_s3_path="outputS3Path"
)

Attributes

kms_arn

Customer AWS ARN for encryption at rest.

If not provided, system will use an AWS Entity Resolution managed KMS key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-kmsarn

output_s3_path

The S3 path to which AWS Entity Resolution will write the output table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-idmappingworkflowoutputsource.html#cfn-entityresolution-idmappingworkflow-idmappingworkflowoutputsource-outputs3path

IntermediateSourceConfigurationProperty

class CfnIdMappingWorkflowPropsMixin.IntermediateSourceConfigurationProperty(*, intermediate_s3_path=None)

Bases: object

The Amazon S3 location that temporarily stores your data while it processes.

Your information won’t be saved permanently.

Parameters:

intermediate_s3_path (Optional[str]) – The Amazon S3 location (bucket and prefix). For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration.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.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

intermediate_source_configuration_property = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IntermediateSourceConfigurationProperty(
    intermediate_s3_path="intermediateS3Path"
)

Attributes

intermediate_s3_path

The Amazon S3 location (bucket and prefix).

For example: s3://provider_bucket/DOC-EXAMPLE-BUCKET

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-intermediatesourceconfiguration.html#cfn-entityresolution-idmappingworkflow-intermediatesourceconfiguration-intermediates3path

ProviderPropertiesProperty

class CfnIdMappingWorkflowPropsMixin.ProviderPropertiesProperty(*, intermediate_source_configuration=None, provider_configuration=None, provider_service_arn=None)

Bases: object

An object containing the providerServiceARN , intermediateSourceConfiguration , and providerConfiguration .

Parameters:

• intermediate_source_configuration (Union[IResolvable, IntermediateSourceConfigurationProperty, Dict[str, Any], None]) – The Amazon S3 location that temporarily stores your data while it processes. Your information won’t be saved permanently.

• provider_configuration (Union[Mapping[str, str], IResolvable, None]) – The required configuration fields to use with the provider service.

• provider_service_arn (Optional[str]) – The ARN of the provider service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.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.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

provider_properties_property = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.ProviderPropertiesProperty(
    intermediate_source_configuration=entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.IntermediateSourceConfigurationProperty(
        intermediate_s3_path="intermediateS3Path"
    ),
    provider_configuration={
        "provider_configuration_key": "providerConfiguration"
    },
    provider_service_arn="providerServiceArn"
)

Attributes

intermediate_source_configuration

The Amazon S3 location that temporarily stores your data while it processes.

Your information won’t be saved permanently.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-intermediatesourceconfiguration

provider_configuration

The required configuration fields to use with the provider service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-providerconfiguration

provider_service_arn

The ARN of the provider service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-providerproperties.html#cfn-entityresolution-idmappingworkflow-providerproperties-providerservicearn

RuleProperty

class CfnIdMappingWorkflowPropsMixin.RuleProperty(*, matching_keys=None, rule_name=None)

Bases: object

An object containing the ruleName and matchingKeys .

Parameters:

• matching_keys (Optional[Sequence[str]]) – A list of MatchingKeys . The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.

• rule_name (Optional[str]) – A name for the matching rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-rule.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.mixins_preview.aws_entityresolution import mixins as entityresolution_mixins

rule_property = entityresolution_mixins.CfnIdMappingWorkflowPropsMixin.RuleProperty(
    matching_keys=["matchingKeys"],
    rule_name="ruleName"
)

Attributes

matching_keys

A list of MatchingKeys .

The MatchingKeys must have been defined in the SchemaMapping . Two records are considered to match according to this rule if all of the MatchingKeys match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-rule.html#cfn-entityresolution-idmappingworkflow-rule-matchingkeys

rule_name

A name for the matching rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idmappingworkflow-rule.html#cfn-entityresolution-idmappingworkflow-rule-rulename