aws-cdk-lib.aws_customerprofiles.CfnDomainProps

interface CfnDomainProps

LanguageType name
.NETAmazon.CDK.AWS.CustomerProfiles.CfnDomainProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscustomerprofiles#CfnDomainProps
Javasoftware.amazon.awscdk.services.customerprofiles.CfnDomainProps
Pythonaws_cdk.aws_customerprofiles.CfnDomainProps
TypeScript aws-cdk-lib » 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 { aws_customerprofiles as customerprofiles } from 'aws-cdk-lib';
const cfnDomainProps: customerprofiles.CfnDomainProps = {
  domainName: 'domainName',

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

Properties

NameTypeDescription
domainNamestringThe unique name of the domain.
deadLetterQueueUrl?stringThe URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
defaultEncryptionKey?stringThe default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
defaultExpirationDays?numberThe 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.