CfnMatchingWorkflowMixinProps

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

Bases: object

Properties for CfnMatchingWorkflowPropsMixin.

Parameters:

  • 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.

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

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

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

  • role_arn (Optional[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.

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

  • workflow_name (Optional[str]) – 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

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

cfn_matching_workflow_mixin_props = entityresolution_mixins.CfnMatchingWorkflowMixinProps(
    description="description",
    incremental_run_config=entityresolution_mixins.CfnMatchingWorkflowPropsMixin.IncrementalRunConfigProperty(
        incremental_run_type="incrementalRunType"
    ),
    input_source_config=[entityresolution_mixins.CfnMatchingWorkflowPropsMixin.InputSourceProperty(
        apply_normalization=False,
        input_source_arn="inputSourceArn",
        schema_arn="schemaArn"
    )],
    output_source_config=[entityresolution_mixins.CfnMatchingWorkflowPropsMixin.OutputSourceProperty(
        apply_normalization=False,
        kms_arn="kmsArn",
        output=[entityresolution_mixins.CfnMatchingWorkflowPropsMixin.OutputAttributeProperty(
            hashed=False,
            name="name"
        )],
        output_s3_path="outputS3Path"
    )],
    resolution_techniques=entityresolution_mixins.CfnMatchingWorkflowPropsMixin.ResolutionTechniquesProperty(
        provider_properties=entityresolution_mixins.CfnMatchingWorkflowPropsMixin.ProviderPropertiesProperty(
            intermediate_source_configuration=entityresolution_mixins.CfnMatchingWorkflowPropsMixin.IntermediateSourceConfigurationProperty(
                intermediate_s3_path="intermediateS3Path"
            ),
            provider_configuration={
                "provider_configuration_key": "providerConfiguration"
            },
            provider_service_arn="providerServiceArn"
        ),
        resolution_type="resolutionType",
        rule_based_properties=entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleBasedPropertiesProperty(
            attribute_matching_model="attributeMatchingModel",
            match_purpose="matchPurpose",
            rules=[entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleProperty(
                matching_keys=["matchingKeys"],
                rule_name="ruleName"
            )]
        ),
        rule_condition_properties=entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleConditionPropertiesProperty(
            rules=[entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleConditionProperty(
                condition="condition",
                rule_name="ruleName"
            )]
        )
    ),
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    workflow_name="workflowName"
)

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