CfnDomainProps

class aws_cdk.aws_customerprofiles.CfnDomainProps(*, domain_name, dead_letter_queue_url=None, default_encryption_key=None, default_expiration_days=None, tags=None)

Bases: object

Properties for defining a CfnDomain.

Parameters:

  • domain_name (str) – The unique name of the domain.

  • dead_letter_queue_url (Optional[str]) – 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.

  • default_encryption_key (Optional[str]) – 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.

  • default_expiration_days (Union[int, float, None]) – The default number of days until the data within the domain expires.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_customerprofiles as customerprofiles

cfn_domain_props = customerprofiles.CfnDomainProps(
    domain_name="domainName",

    # the properties below are optional
    dead_letter_queue_url="deadLetterQueueUrl",
    default_encryption_key="defaultEncryptionKey",
    default_expiration_days=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

dead_letter_queue_url

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-deadletterqueueurl

default_encryption_key

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.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultencryptionkey

default_expiration_days

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultexpirationdays

domain_name

The unique name of the domain.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-domainname

tags

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-tags