CfnMatchingWorkflowPropsMixin

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

Bases: Mixin

Creates a matching workflow that defines the configuration for a data processing job.

The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow . .. 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
CloudformationResource:: AWS::EntityResolution::MatchingWorkflow
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_matching_workflow_props_mixin = entityresolution_mixins.CfnMatchingWorkflowPropsMixin(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"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnMatchingWorkflowMixinProps, 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', 'incrementalRunConfig', 'inputSourceConfig', 'outputSourceConfig', 'resolutionTechniques', '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

IncrementalRunConfigProperty

class CfnMatchingWorkflowPropsMixin.IncrementalRunConfigProperty(*, incremental_run_type=None)

Bases: object

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.

Parameters:: incremental_run_type (Optional[str]) – The type of incremental run. The only valid value is IMMEDIATE . This 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-properties-entityresolution-matchingworkflow-incrementalrunconfig.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

incremental_run_config_property = entityresolution_mixins.CfnMatchingWorkflowPropsMixin.IncrementalRunConfigProperty(
    incremental_run_type="incrementalRunType"
)

Attributes

incremental_run_type

The type of incremental run. The only valid value is IMMEDIATE . This appears as “Automatic” in the console.

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

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

InputSourceProperty

class CfnMatchingWorkflowPropsMixin.InputSourceProperty(*, apply_normalization=None, input_source_arn=None, schema_arn=None)

Bases: object

An object containing inputSourceARN , schemaName , and applyNormalization .

Parameters:

apply_normalization (Union[bool, IResolvable, None]) – Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER , and the data in the input table is in a format of 1234567890, AWS Entity Resolution will normalize this field in the output to (123)-456-7890.
input_source_arn (Optional[str]) – An object containing inputSourceARN , schemaName , and applyNormalization .
schema_arn (Optional[str]) – The name of the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.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

input_source_property = entityresolution_mixins.CfnMatchingWorkflowPropsMixin.InputSourceProperty(
    apply_normalization=False,
    input_source_arn="inputSourceArn",
    schema_arn="schemaArn"
)

Attributes

apply_normalization

Normalizes the attributes defined in the schema in the input data.

For example, if an attribute has an AttributeType of PHONE_NUMBER , and the data in the input table is in a format of 1234567890, AWS Entity Resolution will normalize this field in the output to (123)-456-7890.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-applynormalization

input_source_arn

An object containing inputSourceARN , schemaName , and applyNormalization .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-inputsourcearn

schema_arn

The name of the schema.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-inputsource.html#cfn-entityresolution-matchingworkflow-inputsource-schemaarn

IntermediateSourceConfigurationProperty

class CfnMatchingWorkflowPropsMixin.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-matchingworkflow-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.CfnMatchingWorkflowPropsMixin.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-matchingworkflow-intermediatesourceconfiguration.html#cfn-entityresolution-matchingworkflow-intermediatesourceconfiguration-intermediates3path

OutputAttributeProperty

class CfnMatchingWorkflowPropsMixin.OutputAttributeProperty(*, hashed=None, name=None)

Bases: object

A list of OutputAttribute objects, each of which have the fields Name and Hashed .

Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

Parameters:

hashed (Union[bool, IResolvable, None]) – Enables the ability to hash the column values in the output.
name (Optional[str]) – A name of a column to be written to the output. This must be an InputField name in the schema mapping.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputattribute.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

output_attribute_property = entityresolution_mixins.CfnMatchingWorkflowPropsMixin.OutputAttributeProperty(
    hashed=False,
    name="name"
)

Attributes

hashed

Enables the ability to hash the column values in the output.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputattribute.html#cfn-entityresolution-matchingworkflow-outputattribute-hashed

name

A name of a column to be written to the output.

This must be an InputField name in the schema mapping.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputattribute.html#cfn-entityresolution-matchingworkflow-outputattribute-name

OutputSourceProperty

class CfnMatchingWorkflowPropsMixin.OutputSourceProperty(*, apply_normalization=None, kms_arn=None, output=None, output_s3_path=None)

Bases: object

A list of OutputAttribute objects, each of which have the fields Name and Hashed .

Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

Parameters:

apply_normalization (Union[bool, IResolvable, None]) – Normalizes the attributes defined in the schema in the input data. For example, if an attribute has an AttributeType of PHONE_NUMBER , and the data in the input table is in a format of 1234567890, AWS Entity Resolution will normalize this field in the output to (123)-456-7890.
kms_arn (Optional[str]) – Customer KMS ARN for encryption at rest. If not provided, system will use an AWS Entity Resolution managed KMS key.
output (Union[IResolvable, Sequence[Union[IResolvable, OutputAttributeProperty, Dict[str, Any]]], None]) – A list of OutputAttribute objects, each of which have the fields Name and Hashed . Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.
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-matchingworkflow-outputsource.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

output_source_property = entityresolution_mixins.CfnMatchingWorkflowPropsMixin.OutputSourceProperty(
    apply_normalization=False,
    kms_arn="kmsArn",
    output=[entityresolution_mixins.CfnMatchingWorkflowPropsMixin.OutputAttributeProperty(
        hashed=False,
        name="name"
    )],
    output_s3_path="outputS3Path"
)

Attributes

apply_normalization

Normalizes the attributes defined in the schema in the input data.

For example, if an attribute has an AttributeType of PHONE_NUMBER , and the data in the input table is in a format of 1234567890, AWS Entity Resolution will normalize this field in the output to (123)-456-7890.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-applynormalization

kms_arn

Customer KMS 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-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-kmsarn

output

A list of OutputAttribute objects, each of which have the fields Name and Hashed .

Each of these objects selects a column to be included in the output table, and whether the values of the column should be hashed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-outputsource.html#cfn-entityresolution-matchingworkflow-outputsource-output

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

ProviderPropertiesProperty

class CfnMatchingWorkflowPropsMixin.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-matchingworkflow-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.CfnMatchingWorkflowPropsMixin.ProviderPropertiesProperty(
    intermediate_source_configuration=entityresolution_mixins.CfnMatchingWorkflowPropsMixin.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-matchingworkflow-providerproperties.html#cfn-entityresolution-matchingworkflow-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-matchingworkflow-providerproperties.html#cfn-entityresolution-matchingworkflow-providerproperties-providerconfiguration

provider_service_arn

The ARN of the provider service.

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

ResolutionTechniquesProperty

class CfnMatchingWorkflowPropsMixin.ResolutionTechniquesProperty(*, provider_properties=None, resolution_type=None, rule_based_properties=None, rule_condition_properties=None)

Bases: object

An object which defines the resolutionType and the ruleBasedProperties .

Parameters:

provider_properties (Union[IResolvable, ProviderPropertiesProperty, Dict[str, Any], None]) – The properties of the provider service.
resolution_type (Optional[str]) – The type of matching workflow to create. Specify one of the following types:. - RULE_MATCHING : Match records using configurable rule-based criteria - ML_MATCHING : Match records using machine learning models - PROVIDER : Match records using a third-party matching provider
rule_based_properties (Union[IResolvable, RuleBasedPropertiesProperty, Dict[str, Any], None]) – An object which defines the list of matching rules to run and has a field rules , which is a list of rule objects.
rule_condition_properties (Union[IResolvable, RuleConditionPropertiesProperty, Dict[str, Any], None]) – An object containing the rules for a matching workflow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.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

resolution_techniques_property = 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"
        )]
    )
)

Attributes

provider_properties

The properties of the provider service.

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

resolution_type

.

RULE_MATCHING : Match records using configurable rule-based criteria
ML_MATCHING : Match records using machine learning models
PROVIDER : Match records using a third-party matching provider

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-resolutiontechniques.html#cfn-entityresolution-matchingworkflow-resolutiontechniques-resolutiontype
Type:: The type of matching workflow to create. Specify one of the following types

rule_based_properties

An object which defines the list of matching rules to run and has a field rules , which is a list of rule objects.

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

rule_condition_properties

An object containing the rules for a matching workflow.

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

RuleBasedPropertiesProperty

class CfnMatchingWorkflowPropsMixin.RuleBasedPropertiesProperty(*, attribute_matching_model=None, match_purpose=None, rules=None)

Bases: object

An object which defines the list of matching rules to run in a matching workflow.

Parameters:

attribute_matching_model (Optional[str]) – The comparison type. You can 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 and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email attribute type.
match_purpose (Optional[str]) – An indicator of whether to generate IDs and index the data or not. If you choose IDENTIFIER_GENERATION , the process generates IDs and indexes the data. If you choose INDEXING , the process indexes the data without generating IDs.
rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]], None]) – A list of Rule objects, each of which have fields RuleName and MatchingKeys .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.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_based_properties_property = entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleBasedPropertiesProperty(
    attribute_matching_model="attributeMatchingModel",
    match_purpose="matchPurpose",
    rules=[entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleProperty(
        matching_keys=["matchingKeys"],
        rule_name="ruleName"
    )]
)

Attributes

attribute_matching_model

The comparison type. You can 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 and the value of BusinessEmail field of Profile B matches, the two profiles are matched on the Email attribute type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-attributematchingmodel

match_purpose

An indicator of whether to generate IDs and index the data or not.

If you choose IDENTIFIER_GENERATION , the process generates IDs and indexes the data.

If you choose INDEXING , the process indexes the data without generating IDs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-matchpurpose

rules

A list of Rule objects, each of which have fields RuleName and MatchingKeys .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulebasedproperties.html#cfn-entityresolution-matchingworkflow-rulebasedproperties-rules

RuleConditionPropertiesProperty

class CfnMatchingWorkflowPropsMixin.RuleConditionPropertiesProperty(*, rules=None)

Bases: object

The properties of a rule condition that provides the ability to use more complex syntax.

Parameters:: rules (Union[IResolvable, Sequence[Union[IResolvable, RuleConditionProperty, Dict[str, Any]]], None]) – A list of rule objects, each of which have fields ruleName and condition .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-ruleconditionproperties.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_condition_properties_property = entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleConditionPropertiesProperty(
    rules=[entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleConditionProperty(
        condition="condition",
        rule_name="ruleName"
    )]
)

Attributes

rules

A list of rule objects, each of which have fields ruleName and condition .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-ruleconditionproperties.html#cfn-entityresolution-matchingworkflow-ruleconditionproperties-rules

RuleConditionProperty

class CfnMatchingWorkflowPropsMixin.RuleConditionProperty(*, condition=None, rule_name=None)

Bases: object

An object that defines the ruleCondition and the ruleName to use in a matching workflow.

Parameters:

condition (Optional[str]) – A statement that specifies the conditions for a matching rule. If your data is accurate, use an Exact matching function: Exact or ExactManyToMany . If your data has variations in spelling or pronunciation, use a Fuzzy matching function: Cosine , Levenshtein , or Soundex . Use operators if you want to combine ( AND ), separate ( OR ), or group matching functions (...) . For example: (Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)
rule_name (Optional[str]) – A name for the matching rule. For example: Rule1

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulecondition.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_condition_property = entityresolution_mixins.CfnMatchingWorkflowPropsMixin.RuleConditionProperty(
    condition="condition",
    rule_name="ruleName"
)

Attributes

condition

A statement that specifies the conditions for a matching rule.

If your data is accurate, use an Exact matching function: Exact or ExactManyToMany .

If your data has variations in spelling or pronunciation, use a Fuzzy matching function: Cosine , Levenshtein , or Soundex .

Use operators if you want to combine ( AND ), separate ( OR ), or group matching functions (...) .

For example: (Cosine(a, 10) AND Exact(b, true)) OR ExactManyToMany(c, d)

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulecondition.html#cfn-entityresolution-matchingworkflow-rulecondition-condition

rule_name

A name for the matching rule.

For example: Rule1

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-matchingworkflow-rulecondition.html#cfn-entityresolution-matchingworkflow-rulecondition-rulename

RuleProperty

class CfnMatchingWorkflowPropsMixin.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-matchingworkflow-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.CfnMatchingWorkflowPropsMixin.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-matchingworkflow-rule.html#cfn-entityresolution-matchingworkflow-rule-matchingkeys

rule_name

A name for the matching rule.

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