Package software.amazon.awscdk.services.customerprofiles

Interface CfnDomainProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.044Z")
@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()
         .domainName("domainName")
         // the properties below are optional
         .deadLetterQueueUrl("deadLetterQueueUrl")
         .defaultEncryptionKey("defaultEncryptionKey")
         .defaultExpirationDays(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomainProps.Builder	A builder for CfnDomainProps
static final class	CfnDomainProps.Jsii$Proxy	An implementation for CfnDomainProps

Method Summary

Modifier and Type	Method	Description
static CfnDomainProps.Builder	builder()
default String	getDeadLetterQueueUrl()	The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
default String	getDefaultEncryptionKey()	The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
default Number	getDefaultExpirationDays()	The default number of days until the data within the domain expires.
String	getDomainName()	The unique name of the domain.
default List<CfnTag>	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

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The unique name of the domain.

getDeadLetterQueueUrl

@Stability(Stable)
@Nullable
default 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.

getDefaultEncryptionKey

@Stability(Stable)
@Nullable
default 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.

getDefaultExpirationDays

@Stability(Stable)
@Nullable
default Number getDefaultExpirationDays()

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnDomainProps.Builder builder()

Returns:

a CfnDomainProps.Builder of CfnDomainProps