Interface CfnDomainProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDomainProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
date="2025-12-18T18:20:07.873Z")
@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()
.defaultExpirationDays(123)
.domainName("domainName")
// the properties below are optional
.dataStore(DataStoreProperty.builder()
.enabled(false)
.readiness(ReadinessProperty.builder()
.message("message")
.progressPercentage(123)
.build())
.build())
.deadLetterQueueUrl("deadLetterQueueUrl")
.defaultEncryptionKey("defaultEncryptionKey")
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDomainPropsstatic final classAn implementation forCfnDomainProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDomainProps.Builderbuilder()default ObjectConfiguration and status of the data store for the domain.default StringThe URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.default StringThe default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.The default number of days until the data within the domain expires.The unique name of the domain.default ObjectThe process of matching duplicate profiles.default ObjectThe process of matching duplicate profiles using Rule-Based matching.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
-
getDefaultExpirationDays
The default number of days until the data within the domain expires.- See Also:
-
getDomainName
The unique name of the domain.- See Also:
-
getDataStore
Configuration and status of the data store for the domain.Returns union: either
IResolvableorCfnDomain.DataStoreProperty- See Also:
-
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
DeadLetterQueuefor theSendMessageoperation to enable Amazon Connect Customer Profiles to send messages to theDeadLetterQueue.- See Also:
-
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:
-
getMatching
The process of matching duplicate profiles.Returns union: either
IResolvableorCfnDomain.MatchingProperty- See Also:
-
getRuleBasedMatching
The process of matching duplicate profiles using Rule-Based matching.Returns union: either
IResolvableorCfnDomain.RuleBasedMatchingProperty- See Also:
-
getTags
The tags used to organize, track, or control access for this resource.- See Also:
-
builder
- Returns:
- a
CfnDomainProps.BuilderofCfnDomainProps
-