Package software.amazon.awscdk.services.customerprofiles

Class CfnDomain

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.customerprofiles.CfnDomain
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.043Z") @Stability(Stable) public class CfnDomain extends CfnResource implements IInspectable
A CloudFormation AWS::CustomerProfiles::Domain.

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")
         .domainName("domainName")
         // the properties below are optional
         .deadLetterQueueUrl("deadLetterQueueUrl")
         .defaultEncryptionKey("defaultEncryptionKey")
         .defaultExpirationDays(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnDomainProps props)
      Create a new AWS::CustomerProfiles::Domain.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags used to organize, track, or control access for this resource.

    • 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.

      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.

    • 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.

      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.

    • 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.

      It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

    • 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.

      It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

    • getDefaultExpirationDays

      @Stability(Stable) @Nullable public Number getDefaultExpirationDays()
      The default number of days until the data within the domain expires.

    • setDefaultExpirationDays

      @Stability(Stable) public void setDefaultExpirationDays(@Nullable Number value)
      The default number of days until the data within the domain expires.