CfnDomainPropsMixin

class aws_cdk.mixins_preview.aws_customerprofiles.mixins.CfnDomainPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies an Amazon Connect Customer Profiles Domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html
CloudformationResource:: AWS::CustomerProfiles::Domain
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_customerprofiles import mixins as customerprofiles_mixins

cfn_domain_props_mixin = customerprofiles_mixins.CfnDomainPropsMixin(customerprofiles_mixins.CfnDomainMixinProps(
    data_store=customerprofiles_mixins.CfnDomainPropsMixin.DataStoreProperty(
        enabled=False,
        readiness=customerprofiles_mixins.CfnDomainPropsMixin.ReadinessProperty(
            message="message",
            progress_percentage=123
        )
    ),
    dead_letter_queue_url="deadLetterQueueUrl",
    default_encryption_key="defaultEncryptionKey",
    default_expiration_days=123,
    domain_name="domainName",
    matching=customerprofiles_mixins.CfnDomainPropsMixin.MatchingProperty(
        auto_merging=customerprofiles_mixins.CfnDomainPropsMixin.AutoMergingProperty(
            conflict_resolution=customerprofiles_mixins.CfnDomainPropsMixin.ConflictResolutionProperty(
                conflict_resolving_model="conflictResolvingModel",
                source_name="sourceName"
            ),
            consolidation=customerprofiles_mixins.CfnDomainPropsMixin.ConsolidationProperty(
                matching_attributes_list=[["matchingAttributesList"]]
            ),
            enabled=False,
            min_allowed_confidence_score_for_merging=123
        ),
        enabled=False,
        exporting_config=customerprofiles_mixins.CfnDomainPropsMixin.ExportingConfigProperty(
            s3_exporting=customerprofiles_mixins.CfnDomainPropsMixin.S3ExportingConfigProperty(
                s3_bucket_name="s3BucketName",
                s3_key_name="s3KeyName"
            )
        ),
        job_schedule=customerprofiles_mixins.CfnDomainPropsMixin.JobScheduleProperty(
            day_of_the_week="dayOfTheWeek",
            time="time"
        )
    ),
    rule_based_matching=customerprofiles_mixins.CfnDomainPropsMixin.RuleBasedMatchingProperty(
        attribute_types_selector=customerprofiles_mixins.CfnDomainPropsMixin.AttributeTypesSelectorProperty(
            address=["address"],
            attribute_matching_model="attributeMatchingModel",
            email_address=["emailAddress"],
            phone_number=["phoneNumber"]
        ),
        conflict_resolution=customerprofiles_mixins.CfnDomainPropsMixin.ConflictResolutionProperty(
            conflict_resolving_model="conflictResolvingModel",
            source_name="sourceName"
        ),
        enabled=False,
        exporting_config=customerprofiles_mixins.CfnDomainPropsMixin.ExportingConfigProperty(
            s3_exporting=customerprofiles_mixins.CfnDomainPropsMixin.S3ExportingConfigProperty(
                s3_bucket_name="s3BucketName",
                s3_key_name="s3KeyName"
            )
        ),
        matching_rules=[customerprofiles_mixins.CfnDomainPropsMixin.MatchingRuleProperty(
            rule=["rule"]
        )],
        max_allowed_rule_level_for_matching=123,
        max_allowed_rule_level_for_merging=123,
        status="status"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CustomerProfiles::Domain.

Parameters:

props (Union[CfnDomainMixinProps, 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 = ['dataStore', 'deadLetterQueueUrl', 'defaultEncryptionKey', 'defaultExpirationDays', 'domainName', 'matching', 'ruleBasedMatching', 'tags']

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

AttributeTypesSelectorProperty

class CfnDomainPropsMixin.AttributeTypesSelectorProperty(*, address=None, attribute_matching_model=None, email_address=None, phone_number=None)

Bases: object

Configures information about the AttributeTypesSelector which rule-based identity resolution uses to match profiles.

Parameters:

address (Optional[Sequence[str]]) – The Address type. You can choose from Address , BusinessAddress , MaillingAddress , and ShippingAddress . You only can use the Address type in the MatchingRule . For example, if you want to match a profile based on BusinessAddress.City or MaillingAddress.City , you can choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.
attribute_matching_model (Optional[str]) – Configures the AttributeMatchingModel , you can either choose ONE_TO_ONE or MANY_TO_MANY .
email_address (Optional[Sequence[str]]) – The Email type. You can choose from EmailAddress , BusinessEmailAddress and PersonalEmailAddress . You only can use the EmailAddress type in the MatchingRule . For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress , you can choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.
phone_number (Optional[Sequence[str]]) – The PhoneNumber type. You can choose from PhoneNumber , HomePhoneNumber , and MobilePhoneNumber . You only can use the PhoneNumber type in the MatchingRule . For example, if you want to match a profile based on Phone or HomePhone , you can choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.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_customerprofiles import mixins as customerprofiles_mixins

attribute_types_selector_property = customerprofiles_mixins.CfnDomainPropsMixin.AttributeTypesSelectorProperty(
    address=["address"],
    attribute_matching_model="attributeMatchingModel",
    email_address=["emailAddress"],
    phone_number=["phoneNumber"]
)

Attributes

address

The Address type.

You can choose from Address , BusinessAddress , MaillingAddress , and ShippingAddress . You only can use the Address type in the MatchingRule . For example, if you want to match a profile based on BusinessAddress.City or MaillingAddress.City , you can choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-address

attribute_matching_model

Configures the AttributeMatchingModel , you can either choose ONE_TO_ONE or MANY_TO_MANY .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-attributematchingmodel

email_address

The Email type.

You can choose from EmailAddress , BusinessEmailAddress and PersonalEmailAddress . You only can use the EmailAddress type in the MatchingRule . For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress , you can choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-emailaddress

phone_number

The PhoneNumber type.

You can choose from PhoneNumber , HomePhoneNumber , and MobilePhoneNumber . You only can use the PhoneNumber type in the MatchingRule . For example, if you want to match a profile based on Phone or HomePhone , you can choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-phonenumber

AutoMergingProperty

class CfnDomainPropsMixin.AutoMergingProperty(*, conflict_resolution=None, consolidation=None, enabled=None, min_allowed_confidence_score_for_merging=None)

Bases: object

Configuration information about the auto-merging process.

Parameters:

conflict_resolution (Union[IResolvable, ConflictResolutionProperty, Dict[str, Any], None]) – Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName , ConflictResolution specifies which EmailAddress should be used.
consolidation (Union[IResolvable, ConsolidationProperty, Dict[str, Any], None]) – A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
enabled (Union[bool, IResolvable, None]) – The flag that enables the auto-merging of duplicate profiles.
min_allowed_confidence_score_for_merging (Union[int, float, None]) – A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means that a higher similarity is required to merge profiles.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.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_customerprofiles import mixins as customerprofiles_mixins

auto_merging_property = customerprofiles_mixins.CfnDomainPropsMixin.AutoMergingProperty(
    conflict_resolution=customerprofiles_mixins.CfnDomainPropsMixin.ConflictResolutionProperty(
        conflict_resolving_model="conflictResolvingModel",
        source_name="sourceName"
    ),
    consolidation=customerprofiles_mixins.CfnDomainPropsMixin.ConsolidationProperty(
        matching_attributes_list=[["matchingAttributesList"]]
    ),
    enabled=False,
    min_allowed_confidence_score_for_merging=123
)

Attributes

conflict_resolution

Determines how the auto-merging process should resolve conflicts between different profiles.

For example, if Profile A and Profile B have the same FirstName and LastName , ConflictResolution specifies which EmailAddress should be used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-conflictresolution

consolidation

A list of matching attributes that represent matching criteria.

If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-consolidation

enabled

The flag that enables the auto-merging of duplicate profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-enabled

min_allowed_confidence_score_for_merging

A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.

A higher score means that a higher similarity is required to merge profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-minallowedconfidencescoreformerging

ConflictResolutionProperty

class CfnDomainPropsMixin.ConflictResolutionProperty(*, conflict_resolving_model=None, source_name=None)

Bases: object

Determines how the auto-merging process should resolve conflicts between different profiles.

For example, if Profile A and Profile B have the same FirstName and LastName , ConflictResolution specifies which EmailAddress should be used.

Parameters:

conflict_resolving_model (Optional[str]) – How the auto-merging process should resolve conflicts between different profiles.
source_name (Optional[str]) – The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-conflictresolution.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_customerprofiles import mixins as customerprofiles_mixins

conflict_resolution_property = customerprofiles_mixins.CfnDomainPropsMixin.ConflictResolutionProperty(
    conflict_resolving_model="conflictResolvingModel",
    source_name="sourceName"
)

Attributes

conflict_resolving_model

How the auto-merging process should resolve conflicts between different profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-conflictresolution.html#cfn-customerprofiles-domain-conflictresolution-conflictresolvingmodel

source_name

The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-conflictresolution.html#cfn-customerprofiles-domain-conflictresolution-sourcename

ConsolidationProperty

class CfnDomainPropsMixin.ConsolidationProperty(*, matching_attributes_list=None)

Bases: object

A list of matching attributes that represent matching criteria.

If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

Parameters:: matching_attributes_list (Union[IResolvable, Sequence[Sequence[str]], None]) – A list of matching criteria.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-consolidation.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_customerprofiles import mixins as customerprofiles_mixins

consolidation_property = customerprofiles_mixins.CfnDomainPropsMixin.ConsolidationProperty(
    matching_attributes_list=[["matchingAttributesList"]]
)

Attributes

matching_attributes_list

A list of matching criteria.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-consolidation.html#cfn-customerprofiles-domain-consolidation-matchingattributeslist

DataStoreProperty

class CfnDomainPropsMixin.DataStoreProperty(*, enabled=None, readiness=None)

Bases: object

Configuration and status of the data store for the domain.

Parameters:

enabled (Union[bool, IResolvable, None]) – Whether the data store is enabled.
readiness (Union[IResolvable, ReadinessProperty, Dict[str, Any], None]) – Progress information for data store setup.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-datastore.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_customerprofiles import mixins as customerprofiles_mixins

data_store_property = customerprofiles_mixins.CfnDomainPropsMixin.DataStoreProperty(
    enabled=False,
    readiness=customerprofiles_mixins.CfnDomainPropsMixin.ReadinessProperty(
        message="message",
        progress_percentage=123
    )
)

Attributes

enabled

Whether the data store is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-datastore.html#cfn-customerprofiles-domain-datastore-enabled

readiness

Progress information for data store setup.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-datastore.html#cfn-customerprofiles-domain-datastore-readiness

DomainStatsProperty

class CfnDomainPropsMixin.DomainStatsProperty(*, metering_profile_count=None, object_count=None, profile_count=None, total_size=None)

Bases: object

Usage-specific statistics about the domain.

Parameters:

metering_profile_count (Union[int, float, None]) – The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
object_count (Union[int, float, None]) – The total number of objects in domain.
profile_count (Union[int, float, None]) – The total number of profiles currently in the domain.
total_size (Union[int, float, None]) – The total size, in bytes, of all objects in the domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.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_customerprofiles import mixins as customerprofiles_mixins

domain_stats_property = customerprofiles_mixins.CfnDomainPropsMixin.DomainStatsProperty(
    metering_profile_count=123,
    object_count=123,
    profile_count=123,
    total_size=123
)

Attributes

metering_profile_count

The number of profiles that you are currently paying for in the domain.

If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-meteringprofilecount

object_count

The total number of objects in domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-objectcount

profile_count

The total number of profiles currently in the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-profilecount

total_size

The total size, in bytes, of all objects in the domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-totalsize

ExportingConfigProperty

class CfnDomainPropsMixin.ExportingConfigProperty(*, s3_exporting=None)

Bases: object

Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

Parameters:: s3_exporting (Union[IResolvable, S3ExportingConfigProperty, Dict[str, Any], None]) – The S3 location where Identity Resolution Jobs write result files.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-exportingconfig.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_customerprofiles import mixins as customerprofiles_mixins

exporting_config_property = customerprofiles_mixins.CfnDomainPropsMixin.ExportingConfigProperty(
    s3_exporting=customerprofiles_mixins.CfnDomainPropsMixin.S3ExportingConfigProperty(
        s3_bucket_name="s3BucketName",
        s3_key_name="s3KeyName"
    )
)

Attributes

s3_exporting

The S3 location where Identity Resolution Jobs write result files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-exportingconfig.html#cfn-customerprofiles-domain-exportingconfig-s3exporting

JobScheduleProperty

class CfnDomainPropsMixin.JobScheduleProperty(*, day_of_the_week=None, time=None)

Bases: object

The day and time when do you want to start the Identity Resolution Job every week.

Parameters:

day_of_the_week (Optional[str]) – The day when the Identity Resolution Job should run every week.
time (Optional[str]) – The time when the Identity Resolution Job should run every week.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-jobschedule.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_customerprofiles import mixins as customerprofiles_mixins

job_schedule_property = customerprofiles_mixins.CfnDomainPropsMixin.JobScheduleProperty(
    day_of_the_week="dayOfTheWeek",
    time="time"
)

Attributes

day_of_the_week

The day when the Identity Resolution Job should run every week.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-jobschedule.html#cfn-customerprofiles-domain-jobschedule-dayoftheweek

time

The time when the Identity Resolution Job should run every week.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-jobschedule.html#cfn-customerprofiles-domain-jobschedule-time

MatchingProperty

class CfnDomainPropsMixin.MatchingProperty(*, auto_merging=None, enabled=None, exporting_config=None, job_schedule=None)

Bases: object

The process of matching duplicate profiles.

If Matching = true , Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job . If you do not specify a date and time for the Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest , you can download the results from S3.

Parameters:

auto_merging (Union[IResolvable, AutoMergingProperty, Dict[str, Any], None]) – Configuration information about the auto-merging process.
enabled (Union[bool, IResolvable, None]) – The flag that enables the matching process of duplicate profiles.
exporting_config (Union[IResolvable, ExportingConfigProperty, Dict[str, Any], None]) – The S3 location where Identity Resolution Jobs write result files.
job_schedule (Union[IResolvable, JobScheduleProperty, Dict[str, Any], None]) – The day and time when do you want to start the Identity Resolution Job every week.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.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_customerprofiles import mixins as customerprofiles_mixins

matching_property = customerprofiles_mixins.CfnDomainPropsMixin.MatchingProperty(
    auto_merging=customerprofiles_mixins.CfnDomainPropsMixin.AutoMergingProperty(
        conflict_resolution=customerprofiles_mixins.CfnDomainPropsMixin.ConflictResolutionProperty(
            conflict_resolving_model="conflictResolvingModel",
            source_name="sourceName"
        ),
        consolidation=customerprofiles_mixins.CfnDomainPropsMixin.ConsolidationProperty(
            matching_attributes_list=[["matchingAttributesList"]]
        ),
        enabled=False,
        min_allowed_confidence_score_for_merging=123
    ),
    enabled=False,
    exporting_config=customerprofiles_mixins.CfnDomainPropsMixin.ExportingConfigProperty(
        s3_exporting=customerprofiles_mixins.CfnDomainPropsMixin.S3ExportingConfigProperty(
            s3_bucket_name="s3BucketName",
            s3_key_name="s3KeyName"
        )
    ),
    job_schedule=customerprofiles_mixins.CfnDomainPropsMixin.JobScheduleProperty(
        day_of_the_week="dayOfTheWeek",
        time="time"
    )
)

Attributes

auto_merging

Configuration information about the auto-merging process.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-automerging

enabled

The flag that enables the matching process of duplicate profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-enabled

exporting_config

The S3 location where Identity Resolution Jobs write result files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-exportingconfig

job_schedule

The day and time when do you want to start the Identity Resolution Job every week.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-jobschedule

MatchingRuleProperty

class CfnDomainPropsMixin.MatchingRuleProperty(*, rule=None)

Bases: object

Specifies how the rule-based matching process should match profiles.

Parameters:: rule (Optional[Sequence[str]]) – A single rule level of the MatchRules . Configures how the rule-based matching process should match profiles.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matchingrule.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_customerprofiles import mixins as customerprofiles_mixins

matching_rule_property = customerprofiles_mixins.CfnDomainPropsMixin.MatchingRuleProperty(
    rule=["rule"]
)

Attributes

rule

A single rule level of the MatchRules .

Configures how the rule-based matching process should match profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matchingrule.html#cfn-customerprofiles-domain-matchingrule-rule

ReadinessProperty

class CfnDomainPropsMixin.ReadinessProperty(*, message=None, progress_percentage=None)

Bases: object

Progress information for data store setup.

Parameters:

message (Optional[str]) – A message describing the current progress.
progress_percentage (Union[int, float, None]) – The percentage of progress completed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-readiness.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_customerprofiles import mixins as customerprofiles_mixins

readiness_property = customerprofiles_mixins.CfnDomainPropsMixin.ReadinessProperty(
    message="message",
    progress_percentage=123
)

Attributes

message

A message describing the current progress.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-readiness.html#cfn-customerprofiles-domain-readiness-message

progress_percentage

The percentage of progress completed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-readiness.html#cfn-customerprofiles-domain-readiness-progresspercentage

RuleBasedMatchingProperty

class CfnDomainPropsMixin.RuleBasedMatchingProperty(*, attribute_types_selector=None, conflict_resolution=None, enabled=None, exporting_config=None, matching_rules=None, max_allowed_rule_level_for_matching=None, max_allowed_rule_level_for_merging=None, status=None)

Bases: object

The process of matching duplicate profiles using Rule-Based matching.

If RuleBasedMatching = true , Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest . You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest , you can download the results from S3.

Parameters:

attribute_types_selector (Union[IResolvable, AttributeTypesSelectorProperty, Dict[str, Any], None]) – Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.
conflict_resolution (Union[IResolvable, ConflictResolutionProperty, Dict[str, Any], None]) – Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName , ConflictResolution specifies which EmailAddress should be used.
enabled (Union[bool, IResolvable, None]) – The flag that enables the matching process of duplicate profiles.
exporting_config (Union[IResolvable, ExportingConfigProperty, Dict[str, Any], None]) – The S3 location where Identity Resolution Jobs write result files.
matching_rules (Union[IResolvable, Sequence[Union[IResolvable, MatchingRuleProperty, Dict[str, Any]]], None]) – Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules .
max_allowed_rule_level_for_matching (Union[int, float, None]) – Indicates the maximum allowed rule level for matching.
max_allowed_rule_level_for_merging (Union[int, float, None]) – Indicates the maximum allowed rule level for merging.
status (Optional[str]) – The status of rule-based matching rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.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_customerprofiles import mixins as customerprofiles_mixins

rule_based_matching_property = customerprofiles_mixins.CfnDomainPropsMixin.RuleBasedMatchingProperty(
    attribute_types_selector=customerprofiles_mixins.CfnDomainPropsMixin.AttributeTypesSelectorProperty(
        address=["address"],
        attribute_matching_model="attributeMatchingModel",
        email_address=["emailAddress"],
        phone_number=["phoneNumber"]
    ),
    conflict_resolution=customerprofiles_mixins.CfnDomainPropsMixin.ConflictResolutionProperty(
        conflict_resolving_model="conflictResolvingModel",
        source_name="sourceName"
    ),
    enabled=False,
    exporting_config=customerprofiles_mixins.CfnDomainPropsMixin.ExportingConfigProperty(
        s3_exporting=customerprofiles_mixins.CfnDomainPropsMixin.S3ExportingConfigProperty(
            s3_bucket_name="s3BucketName",
            s3_key_name="s3KeyName"
        )
    ),
    matching_rules=[customerprofiles_mixins.CfnDomainPropsMixin.MatchingRuleProperty(
        rule=["rule"]
    )],
    max_allowed_rule_level_for_matching=123,
    max_allowed_rule_level_for_merging=123,
    status="status"
)

Attributes

attribute_types_selector

Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-attributetypesselector

conflict_resolution

Determines how the auto-merging process should resolve conflicts between different profiles.

For example, if Profile A and Profile B have the same FirstName and LastName , ConflictResolution specifies which EmailAddress should be used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-conflictresolution

enabled

The flag that enables the matching process of duplicate profiles.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-enabled

exporting_config

The S3 location where Identity Resolution Jobs write result files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-exportingconfig

matching_rules

Configures how the rule-based matching process should match profiles.

You can have up to 15 MatchingRule in the MatchingRules .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-matchingrules

max_allowed_rule_level_for_matching

Indicates the maximum allowed rule level for matching.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformatching

max_allowed_rule_level_for_merging

Indicates the maximum allowed rule level for merging.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformerging

status

The status of rule-based matching rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-status

S3ExportingConfigProperty

class CfnDomainPropsMixin.S3ExportingConfigProperty(*, s3_bucket_name=None, s3_key_name=None)

Bases: object

The S3 location where Identity Resolution Jobs write result files.

Parameters:

s3_bucket_name (Optional[str]) – The name of the S3 bucket where Identity Resolution Jobs write result files.
s3_key_name (Optional[str]) – The S3 key name of the location where Identity Resolution Jobs write result files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-s3exportingconfig.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_customerprofiles import mixins as customerprofiles_mixins

s3_exporting_config_property = customerprofiles_mixins.CfnDomainPropsMixin.S3ExportingConfigProperty(
    s3_bucket_name="s3BucketName",
    s3_key_name="s3KeyName"
)

Attributes

s3_bucket_name

The name of the S3 bucket where Identity Resolution Jobs write result files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-s3exportingconfig.html#cfn-customerprofiles-domain-s3exportingconfig-s3bucketname

s3_key_name

The S3 key name of the location where Identity Resolution Jobs write result files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-s3exportingconfig.html#cfn-customerprofiles-domain-s3exportingconfig-s3keyname