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.103.1 (build bef2dea)",
date="2024-10-11T15:55:55.750Z")
@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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Configures information about theAttributeTypesSelector
which rule-based identity resolution uses to match profiles.static interface
Configuration information about the auto-merging process.static final class
A fluent builder forCfnDomain
.static interface
Determines how the auto-merging process should resolve conflicts between different profiles.static interface
A list of matching attributes that represent matching criteria.static interface
Usage-specific statistics about the domain.static interface
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.static interface
The day and time when do you want to start the Identity Resolution Job every week.static interface
The process of matching duplicate profiles.static interface
Specifies how the rule-based matching process should match profiles.static interface
The process of matching duplicate profiles using Rule-Based matching.static interface
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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe timestamp of when the domain was created.The timestamp of when the domain was most recently edited.The status of rule-based matching rule.Usage-specific statistics about the domain.The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.The 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.The process of matching duplicate profiles.The process of matching duplicate profiles using Rule-Based matching.getTags()
Tag Manager which manages the tags for this resource.The tags used to organize, track, or control access for this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
The process of matching duplicate profiles.void
setRuleBasedMatching
(IResolvable value) The process of matching duplicate profiles using Rule-Based matching.void
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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreatedAt
The timestamp of when the domain was created. -
getAttrLastUpdatedAt
The timestamp of when the domain was most recently edited. -
getAttrRuleBasedMatchingStatus
The status of rule-based matching rule. -
getAttrStats
Usage-specific statistics about the domain. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDefaultExpirationDays
The default number of days until the data within the domain expires. -
setDefaultExpirationDays
The default number of days until the data within the domain expires. -
getDomainName
The unique name of the domain. -
setDomainName
The unique name of the domain. -
getDeadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. -
setDeadLetterQueueUrl
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. -
getDefaultEncryptionKey
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. -
setDefaultEncryptionKey
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. -
getMatching
The process of matching duplicate profiles. -
setMatching
The process of matching duplicate profiles. -
setMatching
The process of matching duplicate profiles. -
getRuleBasedMatching
The process of matching duplicate profiles using Rule-Based matching. -
setRuleBasedMatching
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
The tags used to organize, track, or control access for this resource. -
setTagsRaw
The tags used to organize, track, or control access for this resource.
-