software.amazon.awscdk.services.customerprofiles

Class CfnDomain

java.lang.Object

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:14.338Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDomain(Construct scope, java.lang.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
java.lang.String	getAttrCreatedAt() The timestamp of when the domain was created.
java.lang.String	getAttrLastUpdatedAt() The timestamp of when the domain was most recently edited.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDeadLetterQueueUrl() The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
java.lang.String	getDefaultEncryptionKey() The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
java.lang.Number	getDefaultExpirationDays() The default number of days until the data within the domain expires.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDeadLetterQueueUrl(java.lang.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(java.lang.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(java.lang.Number value) The default number of days until the data within the domain expires.
void	setDomainName(java.lang.String value) The unique name of the domain.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnDomain(Construct scope,
                 java.lang.String id,
                 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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

public java.lang.String getAttrCreatedAt()

The timestamp of when the domain was created.

getAttrLastUpdatedAt

public java.lang.String getAttrLastUpdatedAt()

The timestamp of when the domain was most recently edited.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getDomainName

public java.lang.String getDomainName()

The unique name of the domain.

setDomainName

public void setDomainName(java.lang.String value)

The unique name of the domain.

getDeadLetterQueueUrl

public java.lang.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

public void setDeadLetterQueueUrl(java.lang.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

public java.lang.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

public void setDefaultEncryptionKey(java.lang.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

public java.lang.Number getDefaultExpirationDays()

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

setDefaultExpirationDays

public void setDefaultExpirationDays(java.lang.Number value)

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