AWS::CustomerProfiles::Domain - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::CustomerProfiles::Domain

Specifies an Amazon Connect Customer Profiles Domain.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CustomerProfiles::Domain",
  "Properties" : {
      "DeadLetterQueueUrl" : String,
      "DefaultEncryptionKey" : String,
      "DefaultExpirationDays" : Integer,
      "DomainName" : String,
      "Matching" : Matching,
      "RuleBasedMatching" : RuleBasedMatching,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::CustomerProfiles::Domain
Properties:
  DeadLetterQueueUrl: String
  DefaultEncryptionKey: String
  DefaultExpirationDays: Integer
  DomainName: String
  Matching: 
    Matching
  RuleBasedMatching: 
    RuleBasedMatching
  Tags: 
    - Tag

Properties

DeadLetterQueueUrl

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.

Required: No

Type: String

Minimum: 0

Maximum: 255

Update requires: No interruption

DefaultEncryptionKey

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.

Required: No

Type: String

Minimum: 0

Maximum: 255

Update requires: No interruption

DefaultExpirationDays

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

Required: Yes

Type: Integer

Minimum: 1

Maximum: 1098

Update requires: No interruption

DomainName

The unique name of the domain.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 64

Update requires: Replacement

Matching

The process of matching duplicate profiles.

Required: No

Type: Matching

Update requires: No interruption

RuleBasedMatching

The process of matching duplicate profiles using Rule-Based matching.

Required: No

Type: RuleBasedMatching

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the DomainName of the domain.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The timestamp of when the domain was created.

LastUpdatedAt

The timestamp of when the domain was most recently edited.

RuleBasedMatching.Status

Property description not available.

Examples

The following example creates a Domain.

YAML

Type: "AWS::CustomerProfiles::Domain" 
Properties:
    DomainName: "ExampleDomain" 
    DefaultEncryptionKey: "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE"
    DeadLetterQueueUrl: "arn:aws:sqs:us-east-1:123456789012:DLQName" 
    DefaultExpirationDays: 6

JSON

"Type": "AWS::CustomerProfiles::Domain",
"Properties": { 
    "DomainName": "ExampleDomain", 
    "DefaultEncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE",
    "DeadLetterQueueUrl": "arn:aws:sqs:us-east-1:123456789012:DLQName", 
    "DefaultExpirationDays": 6
}