java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:59.773Z") @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:
  • 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.