CfnIdMappingWorkflowProps

class aws_cdk.aws_entityresolution.CfnIdMappingWorkflowProps(*, id_mapping_techniques, input_source_config, role_arn, workflow_name, description=None, id_mapping_incremental_run_config=None, output_source_config=None, tags=None)

Bases: object

Properties for defining a CfnIdMappingWorkflow.

Parameters:

id_mapping_techniques (Union[IResolvable, IdMappingTechniquesProperty, Dict[str, Any]]) – An object which defines the ID mapping technique and any additional configurations.
input_source_config (Union[IResolvable, Sequence[Union[IResolvable, IdMappingWorkflowInputSourceProperty, Dict[str, Any]]]]) – A list of InputSource objects, which have the fields InputSourceARN and SchemaName .
role_arn (str) – The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to create resources on your behalf as part of workflow execution.
workflow_name (str) – The name of the workflow. There can’t be multiple IdMappingWorkflows with the same name.
description (Optional[str]) – A description of the workflow.
id_mapping_incremental_run_config (Union[IResolvable, IdMappingIncrementalRunConfigProperty, Dict[str, Any], None])
output_source_config (Union[IResolvable, Sequence[Union[IResolvable, IdMappingWorkflowOutputSourceProperty, Dict[str, Any]]], None]) – A list of IdMappingWorkflowOutputSource objects, each of which contains fields outputS3Path and KMSArn .
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-idmappingworkflow.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_mapping_workflow_props = entityresolution.CfnIdMappingWorkflowProps(
    id_mapping_techniques=entityresolution.CfnIdMappingWorkflow.IdMappingTechniquesProperty(
        id_mapping_type="idMappingType",
        normalization_version="normalizationVersion",
        provider_properties=entityresolution.CfnIdMappingWorkflow.ProviderPropertiesProperty(
            provider_service_arn="providerServiceArn",

            # the properties below are optional
            intermediate_source_configuration=entityresolution.CfnIdMappingWorkflow.IntermediateSourceConfigurationProperty(
                intermediate_s3_path="intermediateS3Path"
            ),
            provider_configuration={
                "provider_configuration_key": "providerConfiguration"
            }
        ),
        rule_based_properties=entityresolution.CfnIdMappingWorkflow.IdMappingRuleBasedPropertiesProperty(
            attribute_matching_model="attributeMatchingModel",
            record_matching_model="recordMatchingModel",

            # the properties below are optional
            rule_definition_type="ruleDefinitionType",
            rules=[entityresolution.CfnIdMappingWorkflow.RuleProperty(
                matching_keys=["matchingKeys"],
                rule_name="ruleName"
            )]
        )
    ),
    input_source_config=[entityresolution.CfnIdMappingWorkflow.IdMappingWorkflowInputSourceProperty(
        input_source_arn="inputSourceArn",

        # the properties below are optional
        schema_arn="schemaArn",
        type="type"
    )],
    role_arn="roleArn",
    workflow_name="workflowName",

    # the properties below are optional
    description="description",
    id_mapping_incremental_run_config=entityresolution.CfnIdMappingWorkflow.IdMappingIncrementalRunConfigProperty(
        incremental_run_type="incrementalRunType"
    ),
    output_source_config=[entityresolution.CfnIdMappingWorkflow.IdMappingWorkflowOutputSourceProperty(
        output_s3_path="outputS3Path",

        # the properties below are optional
        kms_arn="kmsArn"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)