interface CfnDomainProps

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	Amazon.CDK.AWS.CustomerProfiles.CfnDomainProps
Java	software.amazon.awscdk.services.customerprofiles.CfnDomainProps
Python	aws_cdk.aws_customerprofiles.CfnDomainProps
TypeScript	@aws-cdk/aws-customerprofiles » CfnDomainProps

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 * as customerprofiles from '@aws-cdk/aws-customerprofiles';
const cfnDomainProps: customerprofiles.CfnDomainProps = {
  domainName: 'domainName',

  // the properties below are optional
  deadLetterQueueUrl: 'deadLetterQueueUrl',
  defaultEncryptionKey: 'defaultEncryptionKey',
  defaultExpirationDays: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
domainName	string	The unique name of the domain.
deadLetterQueueUrl?	string	The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
defaultEncryptionKey?	string	The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
defaultExpirationDays?	number	The default number of days until the data within the domain expires.
tags?	CfnTag[]	The tags used to organize, track, or control access for this resource.

---

domainName

Type: string

The unique name of the domain.

---

deadLetterQueueUrl?

Type: string (optional)

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.

---

defaultEncryptionKey?

Type: string (optional)

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.

---

defaultExpirationDays?

Type: number (optional)

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

---

tags?

Type: CfnTag[] (optional)

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