CfnDomain

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

Bases: CfnResource

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
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 = customerprofiles.CfnDomain(self, "MyCfnDomain",
    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"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::CustomerProfiles::Domain'

attr_created_at

The timestamp of when the domain was created.

CloudformationAttribute:: CreatedAt

attr_last_updated_at

The timestamp of when the domain was most recently edited.

CloudformationAttribute:: LastUpdatedAt

attr_rule_based_matching_status

The status of rule-based matching rule.

CloudformationAttribute:: RuleBasedMatching.Status

attr_stats

Usage-specific statistics about the domain.

CloudformationAttribute:: Stats

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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.

default_encryption_key: The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.

default_expiration_days: The default number of days until the data within the domain expires.

domain_name: The unique name of the domain.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

matching: The process of matching duplicate profiles.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rule_based_matching: The process of matching duplicate profiles using Rule-Based matching.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: The tags used to organize, track, or control access for this resource.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AttributeTypesSelectorProperty

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

Bases: object

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

Parameters:

attribute_matching_model (str) – Configures the AttributeMatchingModel , you can either choose ONE_TO_ONE or MANY_TO_MANY .
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.
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 import aws_customerprofiles as customerprofiles

attribute_types_selector_property = customerprofiles.CfnDomain.AttributeTypesSelectorProperty(
    attribute_matching_model="attributeMatchingModel",

    # the properties below are optional
    address=["address"],
    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 CfnDomain.AutoMergingProperty(*, enabled, conflict_resolution=None, consolidation=None, min_allowed_confidence_score_for_merging=None)

Bases: object

Configuration information about the auto-merging process.

Parameters:

enabled (Union[bool, IResolvable]) – The flag that enables the auto-merging of duplicate 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.
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.
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 import aws_customerprofiles as customerprofiles

auto_merging_property = 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
)

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 CfnDomain.ConflictResolutionProperty(*, conflict_resolving_model, 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 (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 import aws_customerprofiles as customerprofiles

conflict_resolution_property = customerprofiles.CfnDomain.ConflictResolutionProperty(
    conflict_resolving_model="conflictResolvingModel",

    # the properties below are optional
    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 CfnDomain.ConsolidationProperty(*, matching_attributes_list)

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]]]) – 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 import aws_customerprofiles as customerprofiles

consolidation_property = customerprofiles.CfnDomain.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

DomainStatsProperty

class CfnDomain.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 import aws_customerprofiles as customerprofiles

domain_stats_property = customerprofiles.CfnDomain.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 CfnDomain.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 import aws_customerprofiles as customerprofiles

exporting_config_property = customerprofiles.CfnDomain.ExportingConfigProperty(
    s3_exporting=customerprofiles.CfnDomain.S3ExportingConfigProperty(
        s3_bucket_name="s3BucketName",

        # the properties below are optional
        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 CfnDomain.JobScheduleProperty(*, day_of_the_week, time)

Bases: object

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

Parameters:

day_of_the_week (str) – The day when the Identity Resolution Job should run every week.
time (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 import aws_customerprofiles as customerprofiles

job_schedule_property = customerprofiles.CfnDomain.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 CfnDomain.MatchingProperty(*, enabled, auto_merging=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:

enabled (Union[bool, IResolvable]) – The flag that enables the matching process of duplicate profiles.
auto_merging (Union[IResolvable, AutoMergingProperty, Dict[str, Any], None]) – Configuration information about the auto-merging process.
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 import aws_customerprofiles as customerprofiles

matching_property = 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"
    )
)

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 CfnDomain.MatchingRuleProperty(*, rule)

Bases: object

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

Parameters:: rule (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 import aws_customerprofiles as customerprofiles

matching_rule_property = customerprofiles.CfnDomain.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

RuleBasedMatchingProperty

class CfnDomain.RuleBasedMatchingProperty(*, enabled, attribute_types_selector=None, conflict_resolution=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:

enabled (Union[bool, IResolvable]) – The flag that enables the matching process of duplicate profiles.
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.
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 import aws_customerprofiles as customerprofiles

rule_based_matching_property = 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"
)

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 CfnDomain.S3ExportingConfigProperty(*, s3_bucket_name, s3_key_name=None)

Bases: object

The S3 location where Identity Resolution Jobs write result files.

Parameters:

s3_bucket_name (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 import aws_customerprofiles as customerprofiles

s3_exporting_config_property = customerprofiles.CfnDomain.S3ExportingConfigProperty(
    s3_bucket_name="s3BucketName",

    # the properties below are optional
    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