CfnMatchingWorkflowProps

class aws_cdk.aws_entityresolution.CfnMatchingWorkflowProps(*, input_source_config, output_source_config, resolution_techniques, role_arn, workflow_name, description=None, incremental_run_config=None, tags=None)

Bases: object

Properties for defining a CfnMatchingWorkflow.

Parameters:

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

• output_source_config (Union[IResolvable, Sequence[Union[IResolvable, OutputSourceProperty, Dict[str, Any]]]]) – A list of OutputSource objects, each of which contains fields outputS3Path , applyNormalization , KMSArn , and output .

• resolution_techniques (Union[IResolvable, ResolutionTechniquesProperty, Dict[str, Any]]) – An object which defines the resolutionType and the ruleBasedProperties .

• 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 MatchingWorkflows with the same name.

• description (Optional[str]) – A description of the workflow.

• incremental_run_config (Union[IResolvable, IncrementalRunConfigProperty, Dict[str, Any], None]) – Optional. An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as “Automatic” in the console. .. epigraph:: For workflows where resolutionType is ML_MATCHING or PROVIDER , incremental processing is not supported.

• 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-matchingworkflow.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_entityresolution as entityresolution

cfn_matching_workflow_props = entityresolution.CfnMatchingWorkflowProps(
    input_source_config=[entityresolution.CfnMatchingWorkflow.InputSourceProperty(
        input_source_arn="inputSourceArn",
        schema_arn="schemaArn",

        # the properties below are optional
        apply_normalization=False
    )],
    output_source_config=[entityresolution.CfnMatchingWorkflow.OutputSourceProperty(
        output=[entityresolution.CfnMatchingWorkflow.OutputAttributeProperty(
            name="name",

            # the properties below are optional
            hashed=False
        )],

        # the properties below are optional
        apply_normalization=False,
        customer_profiles_integration_config=entityresolution.CfnMatchingWorkflow.CustomerProfilesIntegrationConfigProperty(
            domain_arn="domainArn",
            object_type_arn="objectTypeArn"
        ),
        kms_arn="kmsArn",
        output_s3_path="outputS3Path"
    )],
    resolution_techniques=entityresolution.CfnMatchingWorkflow.ResolutionTechniquesProperty(
        provider_properties=entityresolution.CfnMatchingWorkflow.ProviderPropertiesProperty(
            provider_service_arn="providerServiceArn",

            # the properties below are optional
            intermediate_source_configuration=entityresolution.CfnMatchingWorkflow.IntermediateSourceConfigurationProperty(
                intermediate_s3_path="intermediateS3Path"
            ),
            provider_configuration={
                "provider_configuration_key": "providerConfiguration"
            }
        ),
        resolution_type="resolutionType",
        rule_based_properties=entityresolution.CfnMatchingWorkflow.RuleBasedPropertiesProperty(
            attribute_matching_model="attributeMatchingModel",
            rules=[entityresolution.CfnMatchingWorkflow.RuleProperty(
                matching_keys=["matchingKeys"],
                rule_name="ruleName"
            )],

            # the properties below are optional
            match_purpose="matchPurpose"
        ),
        rule_condition_properties=entityresolution.CfnMatchingWorkflow.RuleConditionPropertiesProperty(
            rules=[entityresolution.CfnMatchingWorkflow.RuleConditionProperty(
                condition="condition",
                rule_name="ruleName"
            )]
        )
    ),
    role_arn="roleArn",
    workflow_name="workflowName",

    # the properties below are optional
    description="description",
    incremental_run_config=entityresolution.CfnMatchingWorkflow.IncrementalRunConfigProperty(
        incremental_run_type="incrementalRunType"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of the workflow.

See:

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

incremental_run_config

Optional.

An object that defines the incremental run type. This object contains only the incrementalRunType field, which appears as “Automatic” in the console. .. epigraph:

For workflows where ``resolutionType`` is ``ML_MATCHING`` or ``PROVIDER`` , incremental processing is not supported.

See:

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

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-matchingworkflow.html#cfn-entityresolution-matchingworkflow-inputsourceconfig

output_source_config

A list of OutputSource objects, each of which contains fields outputS3Path , applyNormalization , KMSArn , and output .

See:

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

resolution_techniques

An object which defines the resolutionType and the ruleBasedProperties .

See:

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

role_arn

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-matchingworkflow.html#cfn-entityresolution-matchingworkflow-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-matchingworkflow.html#cfn-entityresolution-matchingworkflow-tags

workflow_name

The name of the workflow.

There can’t be multiple MatchingWorkflows with the same name.

See:

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