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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.783Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDomain.Builder A fluent builder for CfnDomain.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDomain(software.constructs.Construct scope, String id, CfnDomainProps props) Create a new `AWS::CustomerProfiles::Domain`.
protected	CfnDomain(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomain(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCreatedAt() The timestamp of when the domain was created.
String	getAttrLastUpdatedAt() The timestamp of when the domain was most recently edited.
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.
TagManager	getTags() 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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDomain

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

CfnDomain

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

CfnDomain

@Stability(value=Stable)
public CfnDomain(@NotNull
                                          software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrCreatedAt()

The timestamp of when the domain was created.

getAttrLastUpdatedAt

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

The timestamp of when the domain was most recently edited.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

getDomainName

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

The unique name of the domain.

setDomainName

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

The unique name of the domain.

getDeadLetterQueueUrl

@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public Number getDefaultExpirationDays()

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

setDefaultExpirationDays

@Stability(value=Stable)
public void setDefaultExpirationDays(@Nullable
                                                              Number value)

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