CfnDomainProps

class aws_cdk.aws_customerprofiles.CfnDomainProps(*, default_expiration_days, domain_name, dead_letter_queue_url=None, default_encryption_key=None, matching=None, rule_based_matching=None, tags=None)

Bases: object

Properties for defining a CfnDomain.

Parameters:

default_expiration_days (Union[int, float]) – The default number of days until the data within the domain expires.
domain_name (str) – The unique name of the domain.
dead_letter_queue_url (Optional[str]) – The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue .
default_encryption_key (Optional[str]) – The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
matching (Union[IResolvable, MatchingProperty, Dict[str, Any], None]) – The process of matching duplicate profiles.
rule_based_matching (Union[IResolvable, RuleBasedMatchingProperty, Dict[str, Any], None]) – The process of matching duplicate profiles using Rule-Based matching.
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-customerprofiles-domain.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 import aws_customerprofiles as customerprofiles

cfn_domain_props = customerprofiles.CfnDomainProps(
    default_expiration_days=123,
    domain_name="domainName",

    # the properties below are optional
    dead_letter_queue_url="deadLetterQueueUrl",
    default_encryption_key="defaultEncryptionKey",
    matching=customerprofiles.CfnDomain.MatchingProperty(
        enabled=False,

        # the properties below are optional
        auto_merging=customerprofiles.CfnDomain.AutoMergingProperty(
            enabled=False,

            # the properties below are optional
            conflict_resolution=customerprofiles.CfnDomain.ConflictResolutionProperty(
                conflict_resolving_model="conflictResolvingModel",

                # the properties below are optional
                source_name="sourceName"
            ),
            consolidation=customerprofiles.CfnDomain.ConsolidationProperty(
                matching_attributes_list=[["matchingAttributesList"]]
            ),
            min_allowed_confidence_score_for_merging=123
        ),
        exporting_config=customerprofiles.CfnDomain.ExportingConfigProperty(
            s3_exporting=customerprofiles.CfnDomain.S3ExportingConfigProperty(
                s3_bucket_name="s3BucketName",

                # the properties below are optional
                s3_key_name="s3KeyName"
            )
        ),
        job_schedule=customerprofiles.CfnDomain.JobScheduleProperty(
            day_of_the_week="dayOfTheWeek",
            time="time"
        )
    ),
    rule_based_matching=customerprofiles.CfnDomain.RuleBasedMatchingProperty(
        enabled=False,

        # the properties below are optional
        attribute_types_selector=customerprofiles.CfnDomain.AttributeTypesSelectorProperty(
            attribute_matching_model="attributeMatchingModel",

            # the properties below are optional
            address=["address"],
            email_address=["emailAddress"],
            phone_number=["phoneNumber"]
        ),
        conflict_resolution=customerprofiles.CfnDomain.ConflictResolutionProperty(
            conflict_resolving_model="conflictResolvingModel",

            # the properties below are optional
            source_name="sourceName"
        ),
        exporting_config=customerprofiles.CfnDomain.ExportingConfigProperty(
            s3_exporting=customerprofiles.CfnDomain.S3ExportingConfigProperty(
                s3_bucket_name="s3BucketName",

                # the properties below are optional
                s3_key_name="s3KeyName"
            )
        ),
        matching_rules=[customerprofiles.CfnDomain.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"
    )]
)

Attributes

dead_letter_queue_url

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue .