Package software.amazon.awscdk.services.customerprofiles

Interface CfnDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:06.176Z")
@Stability(Stable)
public interface CfnDomainProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDomain.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.customerprofiles.*;
 CfnDomainProps cfnDomainProps = CfnDomainProps.builder()
         .domainName("domainName")
         // the properties below are optional
         .deadLetterQueueUrl("deadLetterQueueUrl")
         .defaultEncryptionKey("defaultEncryptionKey")
         .defaultExpirationDays(123)
         .matching(MatchingProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .autoMerging(AutoMergingProperty.builder()
                         .enabled(false)
                         // the properties below are optional
                         .conflictResolution(ConflictResolutionProperty.builder()
                                 .conflictResolvingModel("conflictResolvingModel")
                                 // the properties below are optional
                                 .sourceName("sourceName")
                                 .build())
                         .consolidation(ConsolidationProperty.builder()
                                 .matchingAttributesList(List.of(List.of("matchingAttributesList")))
                                 .build())
                         .minAllowedConfidenceScoreForMerging(123)
                         .build())
                 .exportingConfig(ExportingConfigProperty.builder()
                         .s3Exporting(S3ExportingConfigProperty.builder()
                                 .s3BucketName("s3BucketName")
                                 // the properties below are optional
                                 .s3KeyName("s3KeyName")
                                 .build())
                         .build())
                 .jobSchedule(JobScheduleProperty.builder()
                         .dayOfTheWeek("dayOfTheWeek")
                         .time("time")
                         .build())
                 .build())
         .ruleBasedMatching(RuleBasedMatchingProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .attributeTypesSelector(AttributeTypesSelectorProperty.builder()
                         .attributeMatchingModel("attributeMatchingModel")
                         // the properties below are optional
                         .address(List.of("address"))
                         .emailAddress(List.of("emailAddress"))
                         .phoneNumber(List.of("phoneNumber"))
                         .build())
                 .conflictResolution(ConflictResolutionProperty.builder()
                         .conflictResolvingModel("conflictResolvingModel")
                         // the properties below are optional
                         .sourceName("sourceName")
                         .build())
                 .exportingConfig(ExportingConfigProperty.builder()
                         .s3Exporting(S3ExportingConfigProperty.builder()
                                 .s3BucketName("s3BucketName")
                                 // the properties below are optional
                                 .s3KeyName("s3KeyName")
                                 .build())
                         .build())
                 .matchingRules(List.of(MatchingRuleProperty.builder()
                         .rule(List.of("rule"))
                         .build()))
                 .maxAllowedRuleLevelForMatching(123)
                 .maxAllowedRuleLevelForMerging(123)
                 .status("status")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomainProps.Builder	A builder for CfnDomainProps
static final class	CfnDomainProps.Jsii$Proxy	An implementation for CfnDomainProps

Method Summary

Modifier and Type	Method	Description
static CfnDomainProps.Builder	builder()
default String	getDeadLetterQueueUrl()	The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
default String	getDefaultEncryptionKey()	The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
default Number	getDefaultExpirationDays()	The default number of days until the data within the domain expires.
String	getDomainName()	The unique name of the domain.
default Object	getMatching()	The process of matching duplicate profiles.
default Object	getRuleBasedMatching()	The process of matching duplicate profiles using the Rule-Based matching.
default List<CfnTag>	getTags()	The tags used to organize, track, or control access for this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The unique name of the domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-domainname

getDeadLetterQueueUrl

@Stability(Stable)
@Nullable
default String getDeadLetterQueueUrl()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-deadletterqueueurl

getDefaultEncryptionKey

@Stability(Stable)
@Nullable
default String getDefaultEncryptionKey()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultencryptionkey

getDefaultExpirationDays

@Stability(Stable)
@Nullable
default Number getDefaultExpirationDays()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultexpirationdays

getMatching

@Stability(Stable)
@Nullable
default Object getMatching()

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 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-matching

getRuleBasedMatching

@Stability(Stable)
@Nullable
default Object getRuleBasedMatching()

The process of matching duplicate profiles using the 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-rulebasedmatching

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-tags

builder

@Stability(Stable)
static CfnDomainProps.Builder builder()

Returns:

a CfnDomainProps.Builder of CfnDomainProps