interface CfnDomainProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CustomerProfiles.CfnDomainProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscustomerprofiles#CfnDomainProps |
![]() | software.amazon.awscdk.services.customerprofiles.CfnDomainProps |
![]() | aws_cdk.aws_customerprofiles.CfnDomainProps |
![]() | aws-cdk-lib » aws_customerprofiles » CfnDomainProps |
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 { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const cfnDomainProps: customerprofiles.CfnDomainProps = {
defaultExpirationDays: 123,
domainName: 'domainName',
// the properties below are optional
deadLetterQueueUrl: 'deadLetterQueueUrl',
defaultEncryptionKey: 'defaultEncryptionKey',
matching: {
enabled: false,
// the properties below are optional
autoMerging: {
enabled: false,
// the properties below are optional
conflictResolution: {
conflictResolvingModel: 'conflictResolvingModel',
// the properties below are optional
sourceName: 'sourceName',
},
consolidation: {
matchingAttributesList: [['matchingAttributesList']],
},
minAllowedConfidenceScoreForMerging: 123,
},
exportingConfig: {
s3Exporting: {
s3BucketName: 's3BucketName',
// the properties below are optional
s3KeyName: 's3KeyName',
},
},
jobSchedule: {
dayOfTheWeek: 'dayOfTheWeek',
time: 'time',
},
},
ruleBasedMatching: {
enabled: false,
// the properties below are optional
attributeTypesSelector: {
attributeMatchingModel: 'attributeMatchingModel',
// the properties below are optional
address: ['address'],
emailAddress: ['emailAddress'],
phoneNumber: ['phoneNumber'],
},
conflictResolution: {
conflictResolvingModel: 'conflictResolvingModel',
// the properties below are optional
sourceName: 'sourceName',
},
exportingConfig: {
s3Exporting: {
s3BucketName: 's3BucketName',
// the properties below are optional
s3KeyName: 's3KeyName',
},
},
matchingRules: [{
rule: ['rule'],
}],
maxAllowedRuleLevelForMatching: 123,
maxAllowedRuleLevelForMerging: 123,
status: 'status',
},
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
default | number | The default number of days until the data within the domain expires. |
domain | string | The unique name of the domain. |
dead | string | The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. |
default | string | The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. |
matching? | IResolvable | Matching | The process of matching duplicate profiles. |
rule | IResolvable | Rule | The process of matching duplicate profiles using Rule-Based matching. |
tags? | Cfn [] | The tags used to organize, track, or control access for this resource. |
defaultExpirationDays
Type:
number
The default number of days until the data within the domain expires.
domainName
Type:
string
The unique name of the domain.
deadLetterQueueUrl?
Type:
string
(optional)
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
.
defaultEncryptionKey?
Type:
string
(optional)
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?
Type:
IResolvable
|
Matching
(optional)
The process of matching duplicate profiles.
ruleBasedMatching?
Type:
IResolvable
|
Rule
(optional)
The process of matching duplicate profiles using Rule-Based matching.
tags?
Type:
Cfn
[]
(optional)
The tags used to organize, track, or control access for this resource.