Package software.amazon.awscdk.services.customerprofiles

Class CfnDomain

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.customerprofiles.CfnDomain

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.929Z")
@Stability(Stable)
public class CfnDomain
extends CfnResource
implements IInspectable, ITaggable

Specifies an Amazon Connect Customer Profiles Domain.

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.*;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .defaultExpirationDays(123)
         .domainName("domainName")
         // the properties below are optional
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDomain.AttributeTypesSelectorProperty	Configures information about the AttributeTypesSelector which rule-based identity resolution uses to match profiles.
static interface	CfnDomain.AutoMergingProperty	Configuration information about the auto-merging process.
static final class	CfnDomain.Builder	A fluent builder for CfnDomain.
static interface	CfnDomain.ConflictResolutionProperty	Determines how the auto-merging process should resolve conflicts between different profiles.
static interface	CfnDomain.ConsolidationProperty	A list of matching attributes that represent matching criteria.
static interface	CfnDomain.DomainStatsProperty	Usage-specific statistics about the domain.
static interface	CfnDomain.ExportingConfigProperty	Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
static interface	CfnDomain.JobScheduleProperty	The day and time when do you want to start the Identity Resolution Job every week.
static interface	CfnDomain.MatchingProperty	The process of matching duplicate profiles.
static interface	CfnDomain.MatchingRuleProperty	Specifies how the rule-based matching process should match profiles.
static interface	CfnDomain.RuleBasedMatchingProperty	The process of matching duplicate profiles using Rule-Based matching.
static interface	CfnDomain.S3ExportingConfigProperty	The S3 location where Identity Resolution Jobs write result files.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDomain(software.constructs.Construct scope, String id, CfnDomainProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedAt()	The timestamp of when the domain was created.
String	getAttrLastUpdatedAt()	The timestamp of when the domain was most recently edited.
String	getAttrRuleBasedMatchingStatus()	The status of rule-based matching rule.
IResolvable	getAttrStats()	Usage-specific statistics about the domain.
protected Map<String,Object>	getCfnProperties()
String	getDeadLetterQueueUrl()	The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
String	getDefaultEncryptionKey()	The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
Number	getDefaultExpirationDays()	The default number of days until the data within the domain expires.
String	getDomainName()	The unique name of the domain.
Object	getMatching()	The process of matching duplicate profiles.
Object	getRuleBasedMatching()	The process of matching duplicate profiles using Rule-Based matching.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags used to organize, track, or control access for this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeadLetterQueueUrl(String value)	The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
void	setDefaultEncryptionKey(String value)	The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
void	setDefaultExpirationDays(Number value)	The default number of days until the data within the domain expires.
void	setDomainName(String value)	The unique name of the domain.
void	setMatching(IResolvable value)	The process of matching duplicate profiles.
void	setMatching(CfnDomain.MatchingProperty value)	The process of matching duplicate profiles.
void	setRuleBasedMatching(IResolvable value)	The process of matching duplicate profiles using Rule-Based matching.
void	setRuleBasedMatching(CfnDomain.RuleBasedMatchingProperty value)	The process of matching duplicate profiles using Rule-Based matching.
void	setTagsRaw(List<CfnTag> value)	The tags used to organize, track, or control access for this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDomain

protected CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)

CfnDomain

protected CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDomain

@Stability(Stable)
public CfnDomain(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDomainProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The timestamp of when the domain was created.

getAttrLastUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrLastUpdatedAt()

The timestamp of when the domain was most recently edited.

getAttrRuleBasedMatchingStatus

@Stability(Stable)
@NotNull
public String getAttrRuleBasedMatchingStatus()

The status of rule-based matching rule.

getAttrStats

@Stability(Stable)
@NotNull
public IResolvable getAttrStats()

Usage-specific statistics about the domain.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getDefaultExpirationDays

@Stability(Stable)
@NotNull
public Number getDefaultExpirationDays()

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

setDefaultExpirationDays

@Stability(Stable)
public void setDefaultExpirationDays(@NotNull
 Number value)

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

getDomainName

@Stability(Stable)
@NotNull
public String getDomainName()

The unique name of the domain.

setDomainName

@Stability(Stable)
public void setDomainName(@NotNull
 String value)

The unique name of the domain.

getDeadLetterQueueUrl

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

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

setDeadLetterQueueUrl

@Stability(Stable)
public void setDeadLetterQueueUrl(@Nullable
 String value)

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

getDefaultEncryptionKey

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

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

setDefaultEncryptionKey

@Stability(Stable)
public void setDefaultEncryptionKey(@Nullable
 String value)

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

getMatching

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

The process of matching duplicate profiles.

setMatching

@Stability(Stable)
public void setMatching(@Nullable
 IResolvable value)

The process of matching duplicate profiles.

setMatching

@Stability(Stable)
public void setMatching(@Nullable
 CfnDomain.MatchingProperty value)

The process of matching duplicate profiles.

getRuleBasedMatching

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

The process of matching duplicate profiles using Rule-Based matching.

setRuleBasedMatching

@Stability(Stable)
public void setRuleBasedMatching(@Nullable
 IResolvable value)

The process of matching duplicate profiles using Rule-Based matching.

setRuleBasedMatching

@Stability(Stable)
public void setRuleBasedMatching(@Nullable
 CfnDomain.RuleBasedMatchingProperty value)

The process of matching duplicate profiles using Rule-Based matching.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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