CfnIdNamespacePropsMixin

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

Bases: Mixin

Creates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it.

Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-entityresolution-idnamespace.html
CloudformationResource:: AWS::EntityResolution::IdNamespace
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_namespace_props_mixin = entityresolution_mixins.CfnIdNamespacePropsMixin(entityresolution_mixins.CfnIdNamespaceMixinProps(
    description="description",
    id_mapping_workflow_properties=[entityresolution_mixins.CfnIdNamespacePropsMixin.IdNamespaceIdMappingWorkflowPropertiesProperty(
        id_mapping_type="idMappingType",
        provider_properties=entityresolution_mixins.CfnIdNamespacePropsMixin.NamespaceProviderPropertiesProperty(
            provider_configuration={
                "provider_configuration_key": "providerConfiguration"
            },
            provider_service_arn="providerServiceArn"
        ),
        rule_based_properties=entityresolution_mixins.CfnIdNamespacePropsMixin.NamespaceRuleBasedPropertiesProperty(
            attribute_matching_model="attributeMatchingModel",
            record_matching_models=["recordMatchingModels"],
            rule_definition_types=["ruleDefinitionTypes"],
            rules=[entityresolution_mixins.CfnIdNamespacePropsMixin.RuleProperty(
                matching_keys=["matchingKeys"],
                rule_name="ruleName"
            )]
        )
    )],
    id_namespace_name="idNamespaceName",
    input_source_config=[entityresolution_mixins.CfnIdNamespacePropsMixin.IdNamespaceInputSourceProperty(
        input_source_arn="inputSourceArn",
        schema_name="schemaName"
    )],
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnIdNamespaceMixinProps, 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', 'idMappingWorkflowProperties', 'idNamespaceName', 'inputSourceConfig', 'roleArn', 'tags', 'type']

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

IdNamespaceIdMappingWorkflowPropertiesProperty

class CfnIdNamespacePropsMixin.IdNamespaceIdMappingWorkflowPropertiesProperty(*, id_mapping_type=None, provider_properties=None, rule_based_properties=None)

Bases: object

An object containing idMappingType , providerProperties , and ruleBasedProperties .

Parameters:

id_mapping_type (Optional[str]) – The type of ID mapping.
provider_properties (Union[IResolvable, NamespaceProviderPropertiesProperty, Dict[str, Any], None]) – An object which defines any additional configurations required by the provider service.
rule_based_properties (Union[IResolvable, NamespaceRuleBasedPropertiesProperty, 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-idnamespace-idnamespaceidmappingworkflowproperties.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_namespace_id_mapping_workflow_properties_property = entityresolution_mixins.CfnIdNamespacePropsMixin.IdNamespaceIdMappingWorkflowPropertiesProperty(
    id_mapping_type="idMappingType",
    provider_properties=entityresolution_mixins.CfnIdNamespacePropsMixin.NamespaceProviderPropertiesProperty(
        provider_configuration={
            "provider_configuration_key": "providerConfiguration"
        },
        provider_service_arn="providerServiceArn"
    ),
    rule_based_properties=entityresolution_mixins.CfnIdNamespacePropsMixin.NamespaceRuleBasedPropertiesProperty(
        attribute_matching_model="attributeMatchingModel",
        record_matching_models=["recordMatchingModels"],
        rule_definition_types=["ruleDefinitionTypes"],
        rules=[entityresolution_mixins.CfnIdNamespacePropsMixin.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-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-idmappingtype

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-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-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-idnamespace-idnamespaceidmappingworkflowproperties.html#cfn-entityresolution-idnamespace-idnamespaceidmappingworkflowproperties-rulebasedproperties

IdNamespaceInputSourceProperty

class CfnIdNamespacePropsMixin.IdNamespaceInputSourceProperty(*, input_source_arn=None, schema_name=None)

Bases: object

An object containing inputSourceARN and schemaName .

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_name (Optional[str]) – The name of the schema.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.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_namespace_input_source_property = entityresolution_mixins.CfnIdNamespacePropsMixin.IdNamespaceInputSourceProperty(
    input_source_arn="inputSourceArn",
    schema_name="schemaName"
)

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-idnamespace-idnamespaceinputsource.html#cfn-entityresolution-idnamespace-idnamespaceinputsource-inputsourcearn

schema_name

The name of the schema.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-idnamespaceinputsource.html#cfn-entityresolution-idnamespace-idnamespaceinputsource-schemaname

NamespaceProviderPropertiesProperty

class CfnIdNamespacePropsMixin.NamespaceProviderPropertiesProperty(*, provider_configuration=None, provider_service_arn=None)

Bases: object

An object containing providerConfiguration and providerServiceArn .

Parameters:

provider_configuration (Union[Mapping[str, str], IResolvable, None]) – An object which defines any additional configurations required by the provider service.
provider_service_arn (Optional[str]) – The Amazon Resource Name (ARN) of the provider service.

See:

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

namespace_provider_properties_property = entityresolution_mixins.CfnIdNamespacePropsMixin.NamespaceProviderPropertiesProperty(
    provider_configuration={
        "provider_configuration_key": "providerConfiguration"
    },
    provider_service_arn="providerServiceArn"
)

Attributes

provider_configuration

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespaceproviderproperties.html#cfn-entityresolution-idnamespace-namespaceproviderproperties-providerconfiguration

provider_service_arn

The Amazon Resource Name (ARN) of the provider service.

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

NamespaceRuleBasedPropertiesProperty

class CfnIdNamespacePropsMixin.NamespaceRuleBasedPropertiesProperty(*, attribute_matching_model=None, record_matching_models=None, rule_definition_types=None, rules=None)

Bases: object

The rule-based properties of an ID namespace.

These properties define how the ID namespace can be used 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 BusinessEmail field of Profile B, the two profiles are matched on the Email attribute type.
record_matching_models (Optional[Sequence[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 is matched to one record in the target. If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.
rule_definition_types (Optional[Sequence[str]]) – The sets of rules you can use in an ID mapping workflow. The limitations specified for the source and target must be compatible.
rules (Union[IResolvable, Sequence[Union[IResolvable, RuleProperty, Dict[str, Any]]], None]) – The rules for the ID namespace.

See:

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

namespace_rule_based_properties_property = entityresolution_mixins.CfnIdNamespacePropsMixin.NamespaceRuleBasedPropertiesProperty(
    attribute_matching_model="attributeMatchingModel",
    record_matching_models=["recordMatchingModels"],
    rule_definition_types=["ruleDefinitionTypes"],
    rules=[entityresolution_mixins.CfnIdNamespacePropsMixin.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 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-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-attributematchingmodel

record_matching_models

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 is matched to one record in the target.

If the value is set to MANY_SOURCE_TO_ONE_TARGET , all matching records in the source are matched to one record in the target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-recordmatchingmodels

rule_definition_types

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

The limitations specified for the source and target must be compatible.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-entityresolution-idnamespace-namespacerulebasedproperties.html#cfn-entityresolution-idnamespace-namespacerulebasedproperties-ruledefinitiontypes

rules

The rules for the ID namespace.

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

RuleProperty

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

rule_name

A name for the matching rule.

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