This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # Amazon Connect Customer Profiles **Resource types** + [AWS::CustomerProfiles::CalculatedAttributeDefinition](aws-resource-customerprofiles-calculatedattributedefinition.md) + [AWS::CustomerProfiles::Domain](aws-resource-customerprofiles-domain.md) + [AWS::CustomerProfiles::EventStream](aws-resource-customerprofiles-eventstream.md) + [AWS::CustomerProfiles::EventTrigger](aws-resource-customerprofiles-eventtrigger.md) + [AWS::CustomerProfiles::Integration](aws-resource-customerprofiles-integration.md) + [AWS::CustomerProfiles::ObjectType](aws-resource-customerprofiles-objecttype.md) + [AWS::CustomerProfiles::Recommender](aws-resource-customerprofiles-recommender.md) + [AWS::CustomerProfiles::SegmentDefinition](aws-resource-customerprofiles-segmentdefinition.md) # AWS::CustomerProfiles::CalculatedAttributeDefinition A calculated attribute definition for Customer Profiles. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CustomerProfiles::CalculatedAttributeDefinition", "Properties" : { "[AttributeDetails](#cfn-customerprofiles-calculatedattributedefinition-attributedetails)" : AttributeDetails, "[CalculatedAttributeName](#cfn-customerprofiles-calculatedattributedefinition-calculatedattributename)" : String, "[Conditions](#cfn-customerprofiles-calculatedattributedefinition-conditions)" : Conditions, "[Description](#cfn-customerprofiles-calculatedattributedefinition-description)" : String, "[DisplayName](#cfn-customerprofiles-calculatedattributedefinition-displayname)" : String, "[DomainName](#cfn-customerprofiles-calculatedattributedefinition-domainname)" : String, "[Statistic](#cfn-customerprofiles-calculatedattributedefinition-statistic)" : String, "[Tags](#cfn-customerprofiles-calculatedattributedefinition-tags)" : [ Tag, ... ], "[UseHistoricalData](#cfn-customerprofiles-calculatedattributedefinition-usehistoricaldata)" : Boolean } } ``` ### YAML ``` Type: AWS::CustomerProfiles::CalculatedAttributeDefinition Properties: [AttributeDetails](#cfn-customerprofiles-calculatedattributedefinition-attributedetails): AttributeDetails [CalculatedAttributeName](#cfn-customerprofiles-calculatedattributedefinition-calculatedattributename): String [Conditions](#cfn-customerprofiles-calculatedattributedefinition-conditions): Conditions [Description](#cfn-customerprofiles-calculatedattributedefinition-description): String [DisplayName](#cfn-customerprofiles-calculatedattributedefinition-displayname): String [DomainName](#cfn-customerprofiles-calculatedattributedefinition-domainname): String [Statistic](#cfn-customerprofiles-calculatedattributedefinition-statistic): String [Tags](#cfn-customerprofiles-calculatedattributedefinition-tags): - Tag [UseHistoricalData](#cfn-customerprofiles-calculatedattributedefinition-usehistoricaldata): Boolean ``` ## Properties `AttributeDetails` Mathematical expression and a list of attribute items specified in that expression. *Required*: Yes *Type*: [AttributeDetails](aws-properties-customerprofiles-calculatedattributedefinition-attributedetails.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CalculatedAttributeName` The name of an attribute defined in a profile object type. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z_][a-zA-Z_0-9-]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Conditions` The conditions including range, object count, and threshold for the calculated attribute. *Required*: No *Type*: [Conditions](aws-properties-customerprofiles-calculatedattributedefinition-conditions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the calculated attribute. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` The display name of the calculated attribute. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainName` The unique name of the domain. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Statistic` The aggregation operation to perform for the calculated attribute. *Required*: Yes *Type*: String *Allowed values*: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` An array of key-value pairs to apply to this resource. *Required*: No *Type*: Array of [Tag](aws-properties-customerprofiles-calculatedattributedefinition-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UseHistoricalData` Whether historical data ingested before the Calculated Attribute was created should be included in calculations. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref ### Fn::GetAtt #### `CreatedAt` The timestamp of when the calculated attribute definition was created. `LastUpdatedAt` The timestamp of when the calculated attribute definition was most recently edited. `Status` Status of the Calculated Attribute creation (whether all historical data has been indexed.) # AWS::CustomerProfiles::CalculatedAttributeDefinition AttributeDetails Mathematical expression and a list of attribute items specified in that expression. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Attributes](#cfn-customerprofiles-calculatedattributedefinition-attributedetails-attributes)" : [ AttributeItem, ... ], "[Expression](#cfn-customerprofiles-calculatedattributedefinition-attributedetails-expression)" : String } ``` ### YAML ``` [Attributes](#cfn-customerprofiles-calculatedattributedefinition-attributedetails-attributes): - AttributeItem [Expression](#cfn-customerprofiles-calculatedattributedefinition-attributedetails-expression): String ``` ## Properties `Attributes` Mathematical expression and a list of attribute items specified in that expression. *Required*: Yes *Type*: Array of [AttributeItem](aws-properties-customerprofiles-calculatedattributedefinition-attributeitem.md) *Minimum*: `1` *Maximum*: `2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Expression` Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \$1"\$1ObjectTypeName.AttributeName\$1\$1". *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::CalculatedAttributeDefinition AttributeItem The details of a single attribute item specified in the mathematical expression. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-customerprofiles-calculatedattributedefinition-attributeitem-name)" : String } ``` ### YAML ``` [Name](#cfn-customerprofiles-calculatedattributedefinition-attributeitem-name): String ``` ## Properties `Name` The unique name of the calculated attribute. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_.-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::CalculatedAttributeDefinition Conditions The conditions including range, object count, and threshold for the calculated attribute. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ObjectCount](#cfn-customerprofiles-calculatedattributedefinition-conditions-objectcount)" : Integer, "[Range](#cfn-customerprofiles-calculatedattributedefinition-conditions-range)" : Range, "[Threshold](#cfn-customerprofiles-calculatedattributedefinition-conditions-threshold)" : Threshold } ``` ### YAML ``` [ObjectCount](#cfn-customerprofiles-calculatedattributedefinition-conditions-objectcount): Integer [Range](#cfn-customerprofiles-calculatedattributedefinition-conditions-range): Range [Threshold](#cfn-customerprofiles-calculatedattributedefinition-conditions-threshold): Threshold ``` ## Properties `ObjectCount` The number of profile objects used for the calculated attribute. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Range` The relative time period over which data is included in the aggregation. *Required*: No *Type*: [Range](aws-properties-customerprofiles-calculatedattributedefinition-range.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Threshold` The threshold for the calculated attribute. *Required*: No *Type*: [Threshold](aws-properties-customerprofiles-calculatedattributedefinition-threshold.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::CalculatedAttributeDefinition Range The relative time period over which data is included in the aggregation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TimestampFormat](#cfn-customerprofiles-calculatedattributedefinition-range-timestampformat)" : String, "[TimestampSource](#cfn-customerprofiles-calculatedattributedefinition-range-timestampsource)" : String, "[Unit](#cfn-customerprofiles-calculatedattributedefinition-range-unit)" : String, "[Value](#cfn-customerprofiles-calculatedattributedefinition-range-value)" : Integer, "[ValueRange](#cfn-customerprofiles-calculatedattributedefinition-range-valuerange)" : ValueRange } ``` ### YAML ``` [TimestampFormat](#cfn-customerprofiles-calculatedattributedefinition-range-timestampformat): String [TimestampSource](#cfn-customerprofiles-calculatedattributedefinition-range-timestampsource): String [Unit](#cfn-customerprofiles-calculatedattributedefinition-range-unit): String [Value](#cfn-customerprofiles-calculatedattributedefinition-range-value): Integer [ValueRange](#cfn-customerprofiles-calculatedattributedefinition-range-valuerange): ValueRange ``` ## Properties `TimestampFormat` The format the timestamp field in your JSON object is specified. This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO\$18601 (following ISO\$18601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is \$1"generatedAt": \$1"timestamp": "2001-07-04T12:08:56.235-0700"\$1\$1, then TimestampFormat should be "ISO\$18601" *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TimestampSource` An expression specifying the field in your JSON object from which the date should be parsed. The expression should follow the structure of \$1"\$1ObjectTypeName.\$1\$1". E.g. if your object type is MyType and source JSON is \$1"generatedAt": \$1"timestamp": "1737587945945"\$1\$1, then TimestampSource should be "\$1MyType.generatedAt.timestamp\$1" *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Unit` The unit of time. *Required*: Yes *Type*: String *Allowed values*: `DAYS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The amount of time of the specified unit. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `2147483647` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ValueRange` A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value. *Required*: No *Type*: [ValueRange](aws-properties-customerprofiles-calculatedattributedefinition-valuerange.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::CalculatedAttributeDefinition Readiness Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Message](#cfn-customerprofiles-calculatedattributedefinition-readiness-message)" : String, "[ProgressPercentage](#cfn-customerprofiles-calculatedattributedefinition-readiness-progresspercentage)" : Integer } ``` ### YAML ``` [Message](#cfn-customerprofiles-calculatedattributedefinition-readiness-message): String [ProgressPercentage](#cfn-customerprofiles-calculatedattributedefinition-readiness-progresspercentage): Integer ``` ## Properties `Message` Any customer messaging. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProgressPercentage` Approximately how far the Calculated Attribute creation is from completion. *Required*: No *Type*: Integer *Minimum*: `0` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::CalculatedAttributeDefinition Tag The `Tag` property type specifies Property description not available. for an [AWS::CustomerProfiles::CalculatedAttributeDefinition](aws-resource-customerprofiles-calculatedattributedefinition.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-calculatedattributedefinition-tag-key)" : String, "[Value](#cfn-customerprofiles-calculatedattributedefinition-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-calculatedattributedefinition-tag-key): String [Value](#cfn-customerprofiles-calculatedattributedefinition-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::CalculatedAttributeDefinition Threshold The threshold for the calculated attribute. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Operator](#cfn-customerprofiles-calculatedattributedefinition-threshold-operator)" : String, "[Value](#cfn-customerprofiles-calculatedattributedefinition-threshold-value)" : String } ``` ### YAML ``` [Operator](#cfn-customerprofiles-calculatedattributedefinition-threshold-operator): String [Value](#cfn-customerprofiles-calculatedattributedefinition-threshold-value): String ``` ## Properties `Operator` The operator of the threshold. *Required*: Yes *Type*: String *Allowed values*: `EQUAL_TO | GREATER_THAN | LESS_THAN | NOT_EQUAL_TO` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the threshold. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::CalculatedAttributeDefinition ValueRange A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[End](#cfn-customerprofiles-calculatedattributedefinition-valuerange-end)" : Integer, "[Start](#cfn-customerprofiles-calculatedattributedefinition-valuerange-start)" : Integer } ``` ### YAML ``` [End](#cfn-customerprofiles-calculatedattributedefinition-valuerange-end): Integer [Start](#cfn-customerprofiles-calculatedattributedefinition-valuerange-start): Integer ``` ## Properties `End` The ending point for this overridden range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future. *Required*: Yes *Type*: Integer *Minimum*: `-2147483648` *Maximum*: `2147483647` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Start` The starting point for this overridden range. Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future. *Required*: Yes *Type*: Integer *Minimum*: `-2147483648` *Maximum*: `2147483647` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain Specifies an Amazon Connect Customer Profiles Domain. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CustomerProfiles::Domain", "Properties" : { "[DataStore](#cfn-customerprofiles-domain-datastore)" : DataStore, "[DeadLetterQueueUrl](#cfn-customerprofiles-domain-deadletterqueueurl)" : String, "[DefaultEncryptionKey](#cfn-customerprofiles-domain-defaultencryptionkey)" : String, "[DefaultExpirationDays](#cfn-customerprofiles-domain-defaultexpirationdays)" : Integer, "[DomainName](#cfn-customerprofiles-domain-domainname)" : String, "[Matching](#cfn-customerprofiles-domain-matching)" : Matching, "[RuleBasedMatching](#cfn-customerprofiles-domain-rulebasedmatching)" : RuleBasedMatching, "[Tags](#cfn-customerprofiles-domain-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CustomerProfiles::Domain Properties: [DataStore](#cfn-customerprofiles-domain-datastore): DataStore [DeadLetterQueueUrl](#cfn-customerprofiles-domain-deadletterqueueurl): String [DefaultEncryptionKey](#cfn-customerprofiles-domain-defaultencryptionkey): String [DefaultExpirationDays](#cfn-customerprofiles-domain-defaultexpirationdays): Integer [DomainName](#cfn-customerprofiles-domain-domainname): String [Matching](#cfn-customerprofiles-domain-matching): Matching [RuleBasedMatching](#cfn-customerprofiles-domain-rulebasedmatching): RuleBasedMatching [Tags](#cfn-customerprofiles-domain-tags): - Tag ``` ## Properties `DataStore` Property description not available. *Required*: No *Type*: [DataStore](aws-properties-customerprofiles-domain-datastore.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainName` The unique name of the domain. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Matching` The process of matching duplicate profiles. *Required*: No *Type*: [Matching](aws-properties-customerprofiles-domain-matching.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RuleBasedMatching` The process of matching duplicate profiles using Rule-Based matching. *Required*: No *Type*: [RuleBasedMatching](aws-properties-customerprofiles-domain-rulebasedmatching.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The tags used to organize, track, or control access for this resource. *Required*: No *Type*: Array of [Tag](aws-properties-customerprofiles-domain-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `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 } ``` # AWS::CustomerProfiles::Domain AttributeTypesSelector Configures information about the `AttributeTypesSelector` which rule-based identity resolution uses to match profiles. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Address](#cfn-customerprofiles-domain-attributetypesselector-address)" : [ String, ... ], "[AttributeMatchingModel](#cfn-customerprofiles-domain-attributetypesselector-attributematchingmodel)" : String, "[EmailAddress](#cfn-customerprofiles-domain-attributetypesselector-emailaddress)" : [ String, ... ], "[PhoneNumber](#cfn-customerprofiles-domain-attributetypesselector-phonenumber)" : [ String, ... ] } ``` ### YAML ``` [Address](#cfn-customerprofiles-domain-attributetypesselector-address): - String [AttributeMatchingModel](#cfn-customerprofiles-domain-attributetypesselector-attributematchingmodel): String [EmailAddress](#cfn-customerprofiles-domain-attributetypesselector-emailaddress): - String [PhoneNumber](#cfn-customerprofiles-domain-attributetypesselector-phonenumber): - String ``` ## Properties `Address` The `Address` type. You can choose from `Address`, `BusinessAddress`, `MaillingAddress`, and `ShippingAddress`. You only can use the `Address` type in the `MatchingRule`. For example, if you want to match a profile based on `BusinessAddress.City` or `MaillingAddress.City`, you can choose the `BusinessAddress` and the `MaillingAddress` to represent the `Address` type and specify the `Address.City` on the matching rule. *Required*: No *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `255 | 4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AttributeMatchingModel` Configures the `AttributeMatchingModel`, you can either choose `ONE_TO_ONE` or `MANY_TO_MANY`. *Required*: Yes *Type*: String *Allowed values*: `ONE_TO_ONE | MANY_TO_MANY` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EmailAddress` The Email type. You can choose from `EmailAddress`, `BusinessEmailAddress` and `PersonalEmailAddress`. You only can use the `EmailAddress` type in the `MatchingRule`. For example, if you want to match profile based on `PersonalEmailAddress` or `BusinessEmailAddress`, you can choose the `PersonalEmailAddress` and the `BusinessEmailAddress` to represent the `EmailAddress` type and only specify the `EmailAddress` on the matching rule. *Required*: No *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `255 | 3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PhoneNumber` The `PhoneNumber` type. You can choose from `PhoneNumber`, `HomePhoneNumber`, and `MobilePhoneNumber`. You only can use the `PhoneNumber` type in the `MatchingRule`. For example, if you want to match a profile based on `Phone` or `HomePhone`, you can choose the `Phone` and the `HomePhone` to represent the `PhoneNumber` type and only specify the `PhoneNumber` on the matching rule. *Required*: No *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `255 | 4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain AutoMerging Configuration information about the auto-merging process. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConflictResolution](#cfn-customerprofiles-domain-automerging-conflictresolution)" : ConflictResolution, "[Consolidation](#cfn-customerprofiles-domain-automerging-consolidation)" : Consolidation, "[Enabled](#cfn-customerprofiles-domain-automerging-enabled)" : Boolean, "[MinAllowedConfidenceScoreForMerging](#cfn-customerprofiles-domain-automerging-minallowedconfidencescoreformerging)" : Number } ``` ### YAML ``` [ConflictResolution](#cfn-customerprofiles-domain-automerging-conflictresolution): ConflictResolution [Consolidation](#cfn-customerprofiles-domain-automerging-consolidation): Consolidation [Enabled](#cfn-customerprofiles-domain-automerging-enabled): Boolean [MinAllowedConfidenceScoreForMerging](#cfn-customerprofiles-domain-automerging-minallowedconfidencescoreformerging): Number ``` ## Properties `ConflictResolution` Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same `FirstName` and `LastName`, `ConflictResolution` specifies which `EmailAddress` should be used. *Required*: No *Type*: [ConflictResolution](aws-properties-customerprofiles-domain-conflictresolution.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Consolidation` A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged. *Required*: No *Type*: [Consolidation](aws-properties-customerprofiles-domain-consolidation.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` The flag that enables the auto-merging of duplicate profiles. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MinAllowedConfidenceScoreForMerging` A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means that a higher similarity is required to merge profiles. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain ConflictResolution Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same `FirstName` and `LastName`, `ConflictResolution` specifies which `EmailAddress` should be used. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConflictResolvingModel](#cfn-customerprofiles-domain-conflictresolution-conflictresolvingmodel)" : String, "[SourceName](#cfn-customerprofiles-domain-conflictresolution-sourcename)" : String } ``` ### YAML ``` [ConflictResolvingModel](#cfn-customerprofiles-domain-conflictresolution-conflictresolvingmodel): String [SourceName](#cfn-customerprofiles-domain-conflictresolution-sourcename): String ``` ## Properties `ConflictResolvingModel` How the auto-merging process should resolve conflicts between different profiles. *Required*: Yes *Type*: String *Allowed values*: `RECENCY | SOURCE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceName` The `ObjectType` name that is used to resolve profile merging conflicts when choosing `SOURCE` as the `ConflictResolvingModel`. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain Consolidation A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MatchingAttributesList](#cfn-customerprofiles-domain-consolidation-matchingattributeslist)" : [ [ , ... ], ... ] } ``` ### YAML ``` [MatchingAttributesList](#cfn-customerprofiles-domain-consolidation-matchingattributeslist): - - ``` ## Properties `MatchingAttributesList` A list of matching criteria. *Required*: Yes *Type*: Array of Array *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain DataStore The `DataStore` property type specifies Property description not available. for an [AWS::CustomerProfiles::Domain](aws-resource-customerprofiles-domain.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Enabled](#cfn-customerprofiles-domain-datastore-enabled)" : Boolean, "[Readiness](#cfn-customerprofiles-domain-datastore-readiness)" : Readiness } ``` ### YAML ``` [Enabled](#cfn-customerprofiles-domain-datastore-enabled): Boolean [Readiness](#cfn-customerprofiles-domain-datastore-readiness): Readiness ``` ## Properties `Enabled` Property description not available. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Readiness` Property description not available. *Required*: No *Type*: [Readiness](aws-properties-customerprofiles-domain-readiness.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain DomainStats Usage-specific statistics about the domain. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MeteringProfileCount](#cfn-customerprofiles-domain-domainstats-meteringprofilecount)" : Number, "[ObjectCount](#cfn-customerprofiles-domain-domainstats-objectcount)" : Number, "[ProfileCount](#cfn-customerprofiles-domain-domainstats-profilecount)" : Number, "[TotalSize](#cfn-customerprofiles-domain-domainstats-totalsize)" : Number } ``` ### YAML ``` [MeteringProfileCount](#cfn-customerprofiles-domain-domainstats-meteringprofilecount): Number [ObjectCount](#cfn-customerprofiles-domain-domainstats-objectcount): Number [ProfileCount](#cfn-customerprofiles-domain-domainstats-profilecount): Number [TotalSize](#cfn-customerprofiles-domain-domainstats-totalsize): Number ``` ## Properties `MeteringProfileCount` The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectCount` The total number of objects in domain. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProfileCount` The total number of profiles currently in the domain. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TotalSize` The total size, in bytes, of all objects in the domain. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain ExportingConfig Configuration information for exporting Identity Resolution results, for example, to an S3 bucket. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3Exporting](#cfn-customerprofiles-domain-exportingconfig-s3exporting)" : S3ExportingConfig } ``` ### YAML ``` [S3Exporting](#cfn-customerprofiles-domain-exportingconfig-s3exporting): S3ExportingConfig ``` ## Properties `S3Exporting` Property description not available. *Required*: No *Type*: [S3ExportingConfig](aws-properties-customerprofiles-domain-s3exportingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain JobSchedule The day and time when do you want to start the Identity Resolution Job every week. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DayOfTheWeek](#cfn-customerprofiles-domain-jobschedule-dayoftheweek)" : String, "[Time](#cfn-customerprofiles-domain-jobschedule-time)" : String } ``` ### YAML ``` [DayOfTheWeek](#cfn-customerprofiles-domain-jobschedule-dayoftheweek): String [Time](#cfn-customerprofiles-domain-jobschedule-time): String ``` ## Properties `DayOfTheWeek` The day when the Identity Resolution Job should run every week. *Required*: Yes *Type*: String *Allowed values*: `SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Time` The time when the Identity Resolution Job should run every week. *Required*: Yes *Type*: String *Pattern*: `^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$` *Minimum*: `3` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain Matching The process of matching duplicate profiles. If `Matching = true`, Amazon Connect Customer Profiles starts a weekly batch process called *Identity Resolution Job*. If you do not specify a date and time for the *Identity Resolution Job* to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the *Identity Resolution Job* completes, use the `GetMatches` API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AutoMerging](#cfn-customerprofiles-domain-matching-automerging)" : AutoMerging, "[Enabled](#cfn-customerprofiles-domain-matching-enabled)" : Boolean, "[ExportingConfig](#cfn-customerprofiles-domain-matching-exportingconfig)" : ExportingConfig, "[JobSchedule](#cfn-customerprofiles-domain-matching-jobschedule)" : JobSchedule } ``` ### YAML ``` [AutoMerging](#cfn-customerprofiles-domain-matching-automerging): AutoMerging [Enabled](#cfn-customerprofiles-domain-matching-enabled): Boolean [ExportingConfig](#cfn-customerprofiles-domain-matching-exportingconfig): ExportingConfig [JobSchedule](#cfn-customerprofiles-domain-matching-jobschedule): JobSchedule ``` ## Properties `AutoMerging` Configuration information about the auto-merging process. *Required*: No *Type*: [AutoMerging](aws-properties-customerprofiles-domain-automerging.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` The flag that enables the matching process of duplicate profiles. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExportingConfig` The S3 location where Identity Resolution Jobs write result files. *Required*: No *Type*: [ExportingConfig](aws-properties-customerprofiles-domain-exportingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `JobSchedule` The day and time when do you want to start the Identity Resolution Job every week. *Required*: No *Type*: [JobSchedule](aws-properties-customerprofiles-domain-jobschedule.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain MatchingRule Specifies how the rule-based matching process should match profiles. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Rule](#cfn-customerprofiles-domain-matchingrule-rule)" : [ String, ... ] } ``` ### YAML ``` [Rule](#cfn-customerprofiles-domain-matchingrule-rule): - String ``` ## Properties `Rule` A single rule level of the `MatchRules`. Configures how the rule-based matching process should match profiles. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `255 | 15` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain Readiness The `Readiness` property type specifies Property description not available. for an [AWS::CustomerProfiles::Domain](aws-resource-customerprofiles-domain.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Message](#cfn-customerprofiles-domain-readiness-message)" : String, "[ProgressPercentage](#cfn-customerprofiles-domain-readiness-progresspercentage)" : Integer } ``` ### YAML ``` [Message](#cfn-customerprofiles-domain-readiness-message): String [ProgressPercentage](#cfn-customerprofiles-domain-readiness-progresspercentage): Integer ``` ## Properties `Message` Property description not available. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProgressPercentage` Property description not available. *Required*: No *Type*: Integer *Minimum*: `0` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain RuleBasedMatching The process of matching duplicate profiles using Rule-Based matching. If `RuleBasedMatching = true`, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AttributeTypesSelector](#cfn-customerprofiles-domain-rulebasedmatching-attributetypesselector)" : AttributeTypesSelector, "[ConflictResolution](#cfn-customerprofiles-domain-rulebasedmatching-conflictresolution)" : ConflictResolution, "[Enabled](#cfn-customerprofiles-domain-rulebasedmatching-enabled)" : Boolean, "[ExportingConfig](#cfn-customerprofiles-domain-rulebasedmatching-exportingconfig)" : ExportingConfig, "[MatchingRules](#cfn-customerprofiles-domain-rulebasedmatching-matchingrules)" : [ MatchingRule, ... ], "[MaxAllowedRuleLevelForMatching](#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformatching)" : Integer, "[MaxAllowedRuleLevelForMerging](#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformerging)" : Integer, "[Status](#cfn-customerprofiles-domain-rulebasedmatching-status)" : String } ``` ### YAML ``` [AttributeTypesSelector](#cfn-customerprofiles-domain-rulebasedmatching-attributetypesselector): AttributeTypesSelector [ConflictResolution](#cfn-customerprofiles-domain-rulebasedmatching-conflictresolution): ConflictResolution [Enabled](#cfn-customerprofiles-domain-rulebasedmatching-enabled): Boolean [ExportingConfig](#cfn-customerprofiles-domain-rulebasedmatching-exportingconfig): ExportingConfig [MatchingRules](#cfn-customerprofiles-domain-rulebasedmatching-matchingrules): - MatchingRule [MaxAllowedRuleLevelForMatching](#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformatching): Integer [MaxAllowedRuleLevelForMerging](#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformerging): Integer [Status](#cfn-customerprofiles-domain-rulebasedmatching-status): String ``` ## Properties `AttributeTypesSelector` Configures information about the `AttributeTypesSelector` where the rule-based identity resolution uses to match profiles. *Required*: No *Type*: [AttributeTypesSelector](aws-properties-customerprofiles-domain-attributetypesselector.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConflictResolution` Determines how the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same `FirstName` and `LastName`, `ConflictResolution` specifies which `EmailAddress` should be used. *Required*: No *Type*: [ConflictResolution](aws-properties-customerprofiles-domain-conflictresolution.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` The flag that enables the matching process of duplicate profiles. *Required*: Yes *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExportingConfig` The S3 location where Identity Resolution Jobs write result files. *Required*: No *Type*: [ExportingConfig](aws-properties-customerprofiles-domain-exportingconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MatchingRules` Configures how the rule-based matching process should match profiles. You can have up to 15 `MatchingRule` in the `MatchingRules`. *Required*: No *Type*: Array of [MatchingRule](aws-properties-customerprofiles-domain-matchingrule.md) *Minimum*: `1` *Maximum*: `15` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxAllowedRuleLevelForMatching` Indicates the maximum allowed rule level for matching. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `15` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxAllowedRuleLevelForMerging` Indicates the maximum allowed rule level for merging. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `15` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Status` The status of rule-based matching rule. *Required*: No *Type*: String *Allowed values*: `PENDING | IN_PROGRESS | ACTIVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain S3ExportingConfig The S3 location where Identity Resolution Jobs write result files. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3BucketName](#cfn-customerprofiles-domain-s3exportingconfig-s3bucketname)" : String, "[S3KeyName](#cfn-customerprofiles-domain-s3exportingconfig-s3keyname)" : String } ``` ### YAML ``` [S3BucketName](#cfn-customerprofiles-domain-s3exportingconfig-s3bucketname): String [S3KeyName](#cfn-customerprofiles-domain-s3exportingconfig-s3keyname): String ``` ## Properties `S3BucketName` The name of the S3 bucket where Identity Resolution Jobs write result files. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9.-]+$` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3KeyName` The S3 key name of the location where Identity Resolution Jobs write result files. *Required*: No *Type*: String *Pattern*: `.*` *Minimum*: `1` *Maximum*: `800` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Domain Tag The tags (keys and values) associated with the domain ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-domain-tag-key)" : String, "[Value](#cfn-customerprofiles-domain-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-domain-tag-key): String [Value](#cfn-customerprofiles-domain-tag-value): String ``` ## Properties `Key` A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. *Required*: Yes *Type*: String *Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value for the specified tag key. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::EventStream An Event Stream resource of Amazon Connect Customer Profiles. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CustomerProfiles::EventStream", "Properties" : { "[DomainName](#cfn-customerprofiles-eventstream-domainname)" : String, "[EventStreamName](#cfn-customerprofiles-eventstream-eventstreamname)" : String, "[Tags](#cfn-customerprofiles-eventstream-tags)" : [ Tag, ... ], "[Uri](#cfn-customerprofiles-eventstream-uri)" : String } } ``` ### YAML ``` Type: AWS::CustomerProfiles::EventStream Properties: [DomainName](#cfn-customerprofiles-eventstream-domainname): String [EventStreamName](#cfn-customerprofiles-eventstream-eventstreamname): String [Tags](#cfn-customerprofiles-eventstream-tags): - Tag [Uri](#cfn-customerprofiles-eventstream-uri): String ``` ## Properties `DomainName` The unique name of the domain. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EventStreamName` The name of the event stream. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` The tags used to organize, track, or control access for this resource. *Required*: No *Type*: Array of [Tag](aws-properties-customerprofiles-eventstream-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Uri` The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref ### Fn::GetAtt #### `CreatedAt` The timestamp of when the export was created. `EventStreamArn` A unique identifier for the event stream. `State` The operational state of destination stream for export. # AWS::CustomerProfiles::EventStream DestinationDetails Details regarding the Kinesis stream. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Status](#cfn-customerprofiles-eventstream-destinationdetails-status)" : String, "[Uri](#cfn-customerprofiles-eventstream-destinationdetails-uri)" : String } ``` ### YAML ``` [Status](#cfn-customerprofiles-eventstream-destinationdetails-status): String [Uri](#cfn-customerprofiles-eventstream-destinationdetails-uri): String ``` ## Properties `Status` The status of enabling the Kinesis stream as a destination for export. *Required*: Yes *Type*: String *Allowed values*: `HEALTHY | UNHEALTHY` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Uri` The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::EventStream Tag The `Tag` property type specifies Property description not available. for an [AWS::CustomerProfiles::EventStream](aws-resource-customerprofiles-eventstream.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-eventstream-tag-key)" : String, "[Value](#cfn-customerprofiles-eventstream-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-eventstream-tag-key): String [Value](#cfn-customerprofiles-eventstream-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::EventTrigger Specifies the rules to perform an action based on customer ingested data. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CustomerProfiles::EventTrigger", "Properties" : { "[Description](#cfn-customerprofiles-eventtrigger-description)" : String, "[DomainName](#cfn-customerprofiles-eventtrigger-domainname)" : String, "[EventTriggerConditions](#cfn-customerprofiles-eventtrigger-eventtriggerconditions)" : [ EventTriggerCondition, ... ], "[EventTriggerLimits](#cfn-customerprofiles-eventtrigger-eventtriggerlimits)" : EventTriggerLimits, "[EventTriggerName](#cfn-customerprofiles-eventtrigger-eventtriggername)" : String, "[ObjectTypeName](#cfn-customerprofiles-eventtrigger-objecttypename)" : String, "[SegmentFilter](#cfn-customerprofiles-eventtrigger-segmentfilter)" : String, "[Tags](#cfn-customerprofiles-eventtrigger-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CustomerProfiles::EventTrigger Properties: [Description](#cfn-customerprofiles-eventtrigger-description): String [DomainName](#cfn-customerprofiles-eventtrigger-domainname): String [EventTriggerConditions](#cfn-customerprofiles-eventtrigger-eventtriggerconditions): - EventTriggerCondition [EventTriggerLimits](#cfn-customerprofiles-eventtrigger-eventtriggerlimits): EventTriggerLimits [EventTriggerName](#cfn-customerprofiles-eventtrigger-eventtriggername): String [ObjectTypeName](#cfn-customerprofiles-eventtrigger-objecttypename): String [SegmentFilter](#cfn-customerprofiles-eventtrigger-segmentfilter): String [Tags](#cfn-customerprofiles-eventtrigger-tags): - Tag ``` ## Properties `Description` The description of the event trigger. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainName` The unique name of the domain. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EventTriggerConditions` A list of conditions that determine when an event should trigger the destination. *Required*: Yes *Type*: Array of [EventTriggerCondition](aws-properties-customerprofiles-eventtrigger-eventtriggercondition.md) *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EventTriggerLimits` Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. *Required*: No *Type*: [EventTriggerLimits](aws-properties-customerprofiles-eventtrigger-eventtriggerlimits.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EventTriggerName` The unique name of the event trigger. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ObjectTypeName` The unique name of the object type. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z_][a-zA-Z_0-9-]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SegmentFilter` The destination is triggered only for profiles that meet the criteria of a segment definition. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` An array of key-value pairs to apply to this resource. *Required*: No *Type*: Array of [Tag](aws-properties-customerprofiles-eventtrigger-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref ### Fn::GetAtt #### `CreatedAt` The timestamp of when the event trigger was created. `LastUpdatedAt` The timestamp of when the event trigger was most recently updated. # AWS::CustomerProfiles::EventTrigger EventTriggerCondition Specifies the circumstances under which the event should trigger the destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EventTriggerDimensions](#cfn-customerprofiles-eventtrigger-eventtriggercondition-eventtriggerdimensions)" : [ EventTriggerDimension, ... ], "[LogicalOperator](#cfn-customerprofiles-eventtrigger-eventtriggercondition-logicaloperator)" : String } ``` ### YAML ``` [EventTriggerDimensions](#cfn-customerprofiles-eventtrigger-eventtriggercondition-eventtriggerdimensions): - EventTriggerDimension [LogicalOperator](#cfn-customerprofiles-eventtrigger-eventtriggercondition-logicaloperator): String ``` ## Properties `EventTriggerDimensions` A list of dimensions to be evaluated for the event. *Required*: Yes *Type*: Array of [EventTriggerDimension](aws-properties-customerprofiles-eventtrigger-eventtriggerdimension.md) *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogicalOperator` The operator used to combine multiple dimensions. *Required*: Yes *Type*: String *Allowed values*: `ANY | ALL | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::EventTrigger EventTriggerDimension A specific event dimension to be assessed. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ObjectAttributes](#cfn-customerprofiles-eventtrigger-eventtriggerdimension-objectattributes)" : [ ObjectAttribute, ... ] } ``` ### YAML ``` [ObjectAttributes](#cfn-customerprofiles-eventtrigger-eventtriggerdimension-objectattributes): - ObjectAttribute ``` ## Properties `ObjectAttributes` A list of object attributes to be evaluated. *Required*: Yes *Type*: Array of [ObjectAttribute](aws-properties-customerprofiles-eventtrigger-objectattribute.md) *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::EventTrigger EventTriggerLimits Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EventExpiration](#cfn-customerprofiles-eventtrigger-eventtriggerlimits-eventexpiration)" : Integer, "[Periods](#cfn-customerprofiles-eventtrigger-eventtriggerlimits-periods)" : [ Period, ... ] } ``` ### YAML ``` [EventExpiration](#cfn-customerprofiles-eventtrigger-eventtriggerlimits-eventexpiration): Integer [Periods](#cfn-customerprofiles-eventtrigger-eventtriggerlimits-periods): - Period ``` ## Properties `EventExpiration` Specifies that an event will only trigger the destination if it is processed within a certain latency period. *Required*: No *Type*: Integer *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Periods` A list of time periods during which the limits apply. *Required*: No *Type*: Array of [Period](aws-properties-customerprofiles-eventtrigger-period.md) *Minimum*: `1` *Maximum*: `4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::EventTrigger ObjectAttribute The criteria that a specific object attribute must meet to trigger the destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ComparisonOperator](#cfn-customerprofiles-eventtrigger-objectattribute-comparisonoperator)" : String, "[FieldName](#cfn-customerprofiles-eventtrigger-objectattribute-fieldname)" : String, "[Source](#cfn-customerprofiles-eventtrigger-objectattribute-source)" : String, "[Values](#cfn-customerprofiles-eventtrigger-objectattribute-values)" : [ String, ... ] } ``` ### YAML ``` [ComparisonOperator](#cfn-customerprofiles-eventtrigger-objectattribute-comparisonoperator): String [FieldName](#cfn-customerprofiles-eventtrigger-objectattribute-fieldname): String [Source](#cfn-customerprofiles-eventtrigger-objectattribute-source): String [Values](#cfn-customerprofiles-eventtrigger-objectattribute-values): - String ``` ## Properties `ComparisonOperator` The operator used to compare an attribute against a list of values. *Required*: Yes *Type*: String *Allowed values*: `INCLUSIVE | EXCLUSIVE | CONTAINS | BEGINS_WITH | ENDS_WITH | GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL | BEFORE | AFTER | ON | BETWEEN | NOT_BETWEEN` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FieldName` A field defined within an object type. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_.-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` An attribute contained within a source object. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Values` The amount of time of the specified unit. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `255 | 10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::EventTrigger Period Defines a limit and the time period during which it is enforced. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxInvocationsPerProfile](#cfn-customerprofiles-eventtrigger-period-maxinvocationsperprofile)" : Integer, "[Unit](#cfn-customerprofiles-eventtrigger-period-unit)" : String, "[Unlimited](#cfn-customerprofiles-eventtrigger-period-unlimited)" : Boolean, "[Value](#cfn-customerprofiles-eventtrigger-period-value)" : Integer } ``` ### YAML ``` [MaxInvocationsPerProfile](#cfn-customerprofiles-eventtrigger-period-maxinvocationsperprofile): Integer [Unit](#cfn-customerprofiles-eventtrigger-period-unit): String [Unlimited](#cfn-customerprofiles-eventtrigger-period-unlimited): Boolean [Value](#cfn-customerprofiles-eventtrigger-period-value): Integer ``` ## Properties `MaxInvocationsPerProfile` The maximum allowed number of destination invocations per profile. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Unit` The unit of time. *Required*: Yes *Type*: String *Allowed values*: `HOURS | DAYS | WEEKS | MONTHS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Unlimited` If set to true, there is no limit on the number of destination invocations per profile. The default is false. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The amount of time of the specified unit. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `24` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::EventTrigger Tag A key-value pair to associate with a resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-eventtrigger-tag-key)" : String, "[Value](#cfn-customerprofiles-eventtrigger-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-eventtrigger-tag-key): String [Value](#cfn-customerprofiles-eventtrigger-tag-value): String ``` ## Properties `Key` The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, \$1, ., /, =, \$1, and -. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, \$1, ., /, =, \$1, and -. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration Specifies an Amazon Connect Customer Profiles Integration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CustomerProfiles::Integration", "Properties" : { "[DomainName](#cfn-customerprofiles-integration-domainname)" : String, "[EventTriggerNames](#cfn-customerprofiles-integration-eventtriggernames)" : [ String, ... ], "[FlowDefinition](#cfn-customerprofiles-integration-flowdefinition)" : FlowDefinition, "[ObjectTypeName](#cfn-customerprofiles-integration-objecttypename)" : String, "[ObjectTypeNames](#cfn-customerprofiles-integration-objecttypenames)" : [ ObjectTypeMapping, ... ], "[Scope](#cfn-customerprofiles-integration-scope)" : String, "[Tags](#cfn-customerprofiles-integration-tags)" : [ Tag, ... ], "[Uri](#cfn-customerprofiles-integration-uri)" : String } } ``` ### YAML ``` Type: AWS::CustomerProfiles::Integration Properties: [DomainName](#cfn-customerprofiles-integration-domainname): String [EventTriggerNames](#cfn-customerprofiles-integration-eventtriggernames): - String [FlowDefinition](#cfn-customerprofiles-integration-flowdefinition): FlowDefinition [ObjectTypeName](#cfn-customerprofiles-integration-objecttypename): String [ObjectTypeNames](#cfn-customerprofiles-integration-objecttypenames): - ObjectTypeMapping [Scope](#cfn-customerprofiles-integration-scope): String [Tags](#cfn-customerprofiles-integration-tags): - Tag [Uri](#cfn-customerprofiles-integration-uri): String ``` ## Properties `DomainName` The unique name of the domain. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EventTriggerNames` A list of unique names for active event triggers associated with the integration. *Required*: No *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `64 | 1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FlowDefinition` The configuration that controls how Customer Profiles retrieves data from the source. *Required*: No *Type*: [FlowDefinition](aws-properties-customerprofiles-integration-flowdefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectTypeName` The name of the profile object type mapping to use. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z_][a-zA-Z_0-9-]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectTypeNames` The object type mapping. *Required*: No *Type*: Array of [ObjectTypeMapping](aws-properties-customerprofiles-integration-objecttypemapping.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Scope` The scope or boundary of the integration item's applicability. *Required*: No *Type*: String *Allowed values*: `PROFILE | DOMAIN` *Pattern*: `^[a-zA-Z_][a-zA-Z_0-9-]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The tags used to organize, track, or control access for this resource. *Required*: No *Type*: Array of [Tag](aws-properties-customerprofiles-integration-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Uri` The URI of the S3 bucket or any other type of data source. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DomainName and the Uri of the integration. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp of when the integration was created. `LastUpdatedAt` The timestamp of when the integration was most recently edited. ## Examples The following example creates an integration if Domain existed. ### #### YAML ``` Type: "AWS::CustomerProfiles::Integration" Properties: DomainName: "ExampleDomain" ObjectTypeName: "CTR" Uri: "arn:aws:connect:us-east-1:123456789012:instance/11111111-1111-1111-1111-111111111111" ``` #### JSON ``` "Type": "AWS::CustomerProfiles::Integration", "Properties": { "DomainName": "ExampleDomain", "ObjectTypeName": "CTR", "Uri": "arn:aws:connect:us-east-1:123456789012:instance/11111111-1111-1111-1111-111111111111" } } } } ``` # AWS::CustomerProfiles::Integration ConnectorOperator The operation to be performed on the provided source fields. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Marketo](#cfn-customerprofiles-integration-connectoroperator-marketo)" : String, "[S3](#cfn-customerprofiles-integration-connectoroperator-s3)" : String, "[Salesforce](#cfn-customerprofiles-integration-connectoroperator-salesforce)" : String, "[ServiceNow](#cfn-customerprofiles-integration-connectoroperator-servicenow)" : String, "[Zendesk](#cfn-customerprofiles-integration-connectoroperator-zendesk)" : String } ``` ### YAML ``` [Marketo](#cfn-customerprofiles-integration-connectoroperator-marketo): String [S3](#cfn-customerprofiles-integration-connectoroperator-s3): String [Salesforce](#cfn-customerprofiles-integration-connectoroperator-salesforce): String [ServiceNow](#cfn-customerprofiles-integration-connectoroperator-servicenow): String [Zendesk](#cfn-customerprofiles-integration-connectoroperator-zendesk): String ``` ## Properties `Marketo` The operation to be performed on the provided Marketo source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3` The operation to be performed on the provided Amazon S3 source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Salesforce` The operation to be performed on the provided Salesforce source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServiceNow` The operation to be performed on the provided ServiceNow source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Zendesk` The operation to be performed on the provided Zendesk source fields. *Required*: No *Type*: String *Allowed values*: `PROJECTION | GREATER_THAN | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration FlowDefinition The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-customerprofiles-integration-flowdefinition-description)" : String, "[FlowName](#cfn-customerprofiles-integration-flowdefinition-flowname)" : String, "[KmsArn](#cfn-customerprofiles-integration-flowdefinition-kmsarn)" : String, "[SourceFlowConfig](#cfn-customerprofiles-integration-flowdefinition-sourceflowconfig)" : SourceFlowConfig, "[Tasks](#cfn-customerprofiles-integration-flowdefinition-tasks)" : [ Task, ... ], "[TriggerConfig](#cfn-customerprofiles-integration-flowdefinition-triggerconfig)" : TriggerConfig } ``` ### YAML ``` [Description](#cfn-customerprofiles-integration-flowdefinition-description): String [FlowName](#cfn-customerprofiles-integration-flowdefinition-flowname): String [KmsArn](#cfn-customerprofiles-integration-flowdefinition-kmsarn): String [SourceFlowConfig](#cfn-customerprofiles-integration-flowdefinition-sourceflowconfig): SourceFlowConfig [Tasks](#cfn-customerprofiles-integration-flowdefinition-tasks): - Task [TriggerConfig](#cfn-customerprofiles-integration-flowdefinition-triggerconfig): TriggerConfig ``` ## Properties `Description` A description of the flow you want to create. *Required*: No *Type*: String *Pattern*: `[\w!@#\-.?,\s]*` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FlowName` The specified name of the flow. Use underscores (\$1) or hyphens (-) only. Spaces are not allowed. *Required*: Yes *Type*: String *Pattern*: `[a-zA-Z0-9][\w!@#.-]+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KmsArn` The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption. *Required*: Yes *Type*: String *Pattern*: `arn:aws:kms:.*:[0-9]+:.*` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceFlowConfig` The configuration that controls how Customer Profiles retrieves data from the source. *Required*: Yes *Type*: [SourceFlowConfig](aws-properties-customerprofiles-integration-sourceflowconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tasks` A list of tasks that Customer Profiles performs while transferring the data in the flow run. *Required*: Yes *Type*: Array of [Task](aws-properties-customerprofiles-integration-task.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TriggerConfig` The trigger settings that determine how and when the flow runs. *Required*: Yes *Type*: [TriggerConfig](aws-properties-customerprofiles-integration-triggerconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration IncrementalPullConfig Specifies the configuration used when importing incremental records from the source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatetimeTypeFieldName](#cfn-customerprofiles-integration-incrementalpullconfig-datetimetypefieldname)" : String } ``` ### YAML ``` [DatetimeTypeFieldName](#cfn-customerprofiles-integration-incrementalpullconfig-datetimetypefieldname): String ``` ## Properties `DatetimeTypeFieldName` A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source. *Required*: No *Type*: String *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration MarketoSourceProperties The properties that are applied when Marketo is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-customerprofiles-integration-marketosourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-customerprofiles-integration-marketosourceproperties-object): String ``` ## Properties `Object` The object specified in the Marketo flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration ObjectTypeMapping A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-integration-objecttypemapping-key)" : String, "[Value](#cfn-customerprofiles-integration-objecttypemapping-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-integration-objecttypemapping-key): String [Value](#cfn-customerprofiles-integration-objecttypemapping-value): String ``` ## Properties `Key` The key. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z_][a-zA-Z_0-9-]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration S3SourceProperties The properties that are applied when Amazon S3 is being used as the flow source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-customerprofiles-integration-s3sourceproperties-bucketname)" : String, "[BucketPrefix](#cfn-customerprofiles-integration-s3sourceproperties-bucketprefix)" : String } ``` ### YAML ``` [BucketName](#cfn-customerprofiles-integration-s3sourceproperties-bucketname): String [BucketPrefix](#cfn-customerprofiles-integration-s3sourceproperties-bucketprefix): String ``` ## Properties `BucketName` The Amazon S3 bucket name where the source files are stored. *Required*: Yes *Type*: String *Pattern*: `\S+` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketPrefix` The object key for the Amazon S3 bucket in which the source files are stored. *Required*: No *Type*: String *Pattern*: `.*` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration SalesforceSourceProperties The properties that are applied when Salesforce is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnableDynamicFieldUpdate](#cfn-customerprofiles-integration-salesforcesourceproperties-enabledynamicfieldupdate)" : Boolean, "[IncludeDeletedRecords](#cfn-customerprofiles-integration-salesforcesourceproperties-includedeletedrecords)" : Boolean, "[Object](#cfn-customerprofiles-integration-salesforcesourceproperties-object)" : String } ``` ### YAML ``` [EnableDynamicFieldUpdate](#cfn-customerprofiles-integration-salesforcesourceproperties-enabledynamicfieldupdate): Boolean [IncludeDeletedRecords](#cfn-customerprofiles-integration-salesforcesourceproperties-includedeletedrecords): Boolean [Object](#cfn-customerprofiles-integration-salesforcesourceproperties-object): String ``` ## Properties `EnableDynamicFieldUpdate` The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludeDeletedRecords` Indicates whether Amazon AppFlow includes deleted files in the flow run. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Object` The object specified in the Salesforce flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration ScheduledTriggerProperties Specifies the configuration details of a scheduled-trigger flow that you define. Currently, these settings only apply to the scheduled-trigger type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataPullMode](#cfn-customerprofiles-integration-scheduledtriggerproperties-datapullmode)" : String, "[FirstExecutionFrom](#cfn-customerprofiles-integration-scheduledtriggerproperties-firstexecutionfrom)" : Number, "[ScheduleEndTime](#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleendtime)" : Number, "[ScheduleExpression](#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleexpression)" : String, "[ScheduleOffset](#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleoffset)" : Integer, "[ScheduleStartTime](#cfn-customerprofiles-integration-scheduledtriggerproperties-schedulestarttime)" : Number, "[Timezone](#cfn-customerprofiles-integration-scheduledtriggerproperties-timezone)" : String } ``` ### YAML ``` [DataPullMode](#cfn-customerprofiles-integration-scheduledtriggerproperties-datapullmode): String [FirstExecutionFrom](#cfn-customerprofiles-integration-scheduledtriggerproperties-firstexecutionfrom): Number [ScheduleEndTime](#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleendtime): Number [ScheduleExpression](#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleexpression): String [ScheduleOffset](#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleoffset): Integer [ScheduleStartTime](#cfn-customerprofiles-integration-scheduledtriggerproperties-schedulestarttime): Number [Timezone](#cfn-customerprofiles-integration-scheduledtriggerproperties-timezone): String ``` ## Properties `DataPullMode` Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run. *Required*: No *Type*: String *Allowed values*: `Incremental | Complete` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FirstExecutionFrom` Specifies the date range for the records to import from the connector in the first flow run. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScheduleEndTime` Specifies the scheduled end time for a scheduled-trigger flow. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScheduleExpression` The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes). *Required*: Yes *Type*: String *Pattern*: `.*` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScheduleOffset` Specifies the optional offset that is added to the time interval for a schedule-triggered flow. *Required*: No *Type*: Integer *Minimum*: `0` *Maximum*: `36000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ScheduleStartTime` Specifies the scheduled start time for a scheduled-trigger flow. The value must be a date/time value in EPOCH format. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Timezone` Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New\$1York. *Required*: No *Type*: String *Pattern*: `.*` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration ServiceNowSourceProperties The properties that are applied when ServiceNow is being used as a source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-customerprofiles-integration-servicenowsourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-customerprofiles-integration-servicenowsourceproperties-object): String ``` ## Properties `Object` The object specified in the ServiceNow flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration SourceConnectorProperties Specifies the information that is required to query a particular Amazon AppFlow connector. Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Marketo](#cfn-customerprofiles-integration-sourceconnectorproperties-marketo)" : MarketoSourceProperties, "[S3](#cfn-customerprofiles-integration-sourceconnectorproperties-s3)" : S3SourceProperties, "[Salesforce](#cfn-customerprofiles-integration-sourceconnectorproperties-salesforce)" : SalesforceSourceProperties, "[ServiceNow](#cfn-customerprofiles-integration-sourceconnectorproperties-servicenow)" : ServiceNowSourceProperties, "[Zendesk](#cfn-customerprofiles-integration-sourceconnectorproperties-zendesk)" : ZendeskSourceProperties } ``` ### YAML ``` [Marketo](#cfn-customerprofiles-integration-sourceconnectorproperties-marketo): MarketoSourceProperties [S3](#cfn-customerprofiles-integration-sourceconnectorproperties-s3): S3SourceProperties [Salesforce](#cfn-customerprofiles-integration-sourceconnectorproperties-salesforce): SalesforceSourceProperties [ServiceNow](#cfn-customerprofiles-integration-sourceconnectorproperties-servicenow): ServiceNowSourceProperties [Zendesk](#cfn-customerprofiles-integration-sourceconnectorproperties-zendesk): ZendeskSourceProperties ``` ## Properties `Marketo` The properties that are applied when Marketo is being used as a source. *Required*: No *Type*: [MarketoSourceProperties](aws-properties-customerprofiles-integration-marketosourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3` The properties that are applied when Amazon S3 is being used as the flow source. *Required*: No *Type*: [S3SourceProperties](aws-properties-customerprofiles-integration-s3sourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Salesforce` The properties that are applied when Salesforce is being used as a source. *Required*: No *Type*: [SalesforceSourceProperties](aws-properties-customerprofiles-integration-salesforcesourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServiceNow` The properties that are applied when ServiceNow is being used as a source. *Required*: No *Type*: [ServiceNowSourceProperties](aws-properties-customerprofiles-integration-servicenowsourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Zendesk` The properties that are applied when using Zendesk as a flow source. *Required*: No *Type*: [ZendeskSourceProperties](aws-properties-customerprofiles-integration-zendesksourceproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration SourceFlowConfig The configuration that controls how Customer Profiles retrieves data from the source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConnectorProfileName](#cfn-customerprofiles-integration-sourceflowconfig-connectorprofilename)" : String, "[ConnectorType](#cfn-customerprofiles-integration-sourceflowconfig-connectortype)" : String, "[IncrementalPullConfig](#cfn-customerprofiles-integration-sourceflowconfig-incrementalpullconfig)" : IncrementalPullConfig, "[SourceConnectorProperties](#cfn-customerprofiles-integration-sourceflowconfig-sourceconnectorproperties)" : SourceConnectorProperties } ``` ### YAML ``` [ConnectorProfileName](#cfn-customerprofiles-integration-sourceflowconfig-connectorprofilename): String [ConnectorType](#cfn-customerprofiles-integration-sourceflowconfig-connectortype): String [IncrementalPullConfig](#cfn-customerprofiles-integration-sourceflowconfig-incrementalpullconfig): IncrementalPullConfig [SourceConnectorProperties](#cfn-customerprofiles-integration-sourceflowconfig-sourceconnectorproperties): SourceConnectorProperties ``` ## Properties `ConnectorProfileName` The name of the Amazon AppFlow connector profile. This name must be unique for each connector profile in the AWS account. *Required*: No *Type*: String *Pattern*: `[\w/!@#+=.-]+` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ConnectorType` The type of connector, such as Salesforce, Marketo, and so on. *Required*: Yes *Type*: String *Allowed values*: `Salesforce | Marketo | ServiceNow | Zendesk | S3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncrementalPullConfig` Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull. *Required*: No *Type*: [IncrementalPullConfig](aws-properties-customerprofiles-integration-incrementalpullconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceConnectorProperties` Specifies the information that is required to query a particular source connector. *Required*: Yes *Type*: [SourceConnectorProperties](aws-properties-customerprofiles-integration-sourceconnectorproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration Tag The `Tag` property type specifies Property description not available. for an [AWS::CustomerProfiles::Integration](aws-resource-customerprofiles-integration.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-integration-tag-key)" : String, "[Value](#cfn-customerprofiles-integration-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-integration-tag-key): String [Value](#cfn-customerprofiles-integration-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration Task The `Task` property type specifies the class for modeling different type of tasks. Task implementation varies based on the TaskType. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConnectorOperator](#cfn-customerprofiles-integration-task-connectoroperator)" : ConnectorOperator, "[DestinationField](#cfn-customerprofiles-integration-task-destinationfield)" : String, "[SourceFields](#cfn-customerprofiles-integration-task-sourcefields)" : [ String, ... ], "[TaskProperties](#cfn-customerprofiles-integration-task-taskproperties)" : [ TaskPropertiesMap, ... ], "[TaskType](#cfn-customerprofiles-integration-task-tasktype)" : String } ``` ### YAML ``` [ConnectorOperator](#cfn-customerprofiles-integration-task-connectoroperator): ConnectorOperator [DestinationField](#cfn-customerprofiles-integration-task-destinationfield): String [SourceFields](#cfn-customerprofiles-integration-task-sourcefields): - String [TaskProperties](#cfn-customerprofiles-integration-task-taskproperties): - TaskPropertiesMap [TaskType](#cfn-customerprofiles-integration-task-tasktype): String ``` ## Properties `ConnectorOperator` The operation to be performed on the provided source fields. *Required*: No *Type*: [ConnectorOperator](aws-properties-customerprofiles-integration-connectoroperator.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DestinationField` A field in a destination connector, or a field value against which Amazon AppFlow validates a source field. *Required*: No *Type*: String *Pattern*: `.*` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceFields` The source fields to which a particular task is applied. *Required*: Yes *Type*: Array of String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TaskProperties` A map used to store task-related information. The service looks for particular information based on the TaskType. *Required*: No *Type*: Array of [TaskPropertiesMap](aws-properties-customerprofiles-integration-taskpropertiesmap.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TaskType` Specifies the particular task implementation that Amazon AppFlow performs. *Required*: Yes *Type*: String *Allowed values*: `Arithmetic | Filter | Map | Mask | Merge | Truncate | Validate` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration TaskPropertiesMap A map used to store task-related information. The execution service looks for particular information based on the `TaskType`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OperatorPropertyKey](#cfn-customerprofiles-integration-taskpropertiesmap-operatorpropertykey)" : String, "[Property](#cfn-customerprofiles-integration-taskpropertiesmap-property)" : String } ``` ### YAML ``` [OperatorPropertyKey](#cfn-customerprofiles-integration-taskpropertiesmap-operatorpropertykey): String [Property](#cfn-customerprofiles-integration-taskpropertiesmap-property): String ``` ## Properties `OperatorPropertyKey` The task property key. *Required*: Yes *Type*: String *Allowed values*: `VALUE | VALUES | DATA_TYPE | UPPER_BOUND | LOWER_BOUND | SOURCE_DATA_TYPE | DESTINATION_DATA_TYPE | VALIDATION_ACTION | MASK_VALUE | MASK_LENGTH | TRUNCATE_LENGTH | MATH_OPERATION_FIELDS_ORDER | CONCAT_FORMAT | SUBFIELD_CATEGORY_MAP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Property` The task property value. *Required*: Yes *Type*: String *Pattern*: `.+` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration TriggerConfig The trigger settings that determine how and when Amazon AppFlow runs the specified flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TriggerProperties](#cfn-customerprofiles-integration-triggerconfig-triggerproperties)" : TriggerProperties, "[TriggerType](#cfn-customerprofiles-integration-triggerconfig-triggertype)" : String } ``` ### YAML ``` [TriggerProperties](#cfn-customerprofiles-integration-triggerconfig-triggerproperties): TriggerProperties [TriggerType](#cfn-customerprofiles-integration-triggerconfig-triggertype): String ``` ## Properties `TriggerProperties` Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type. *Required*: No *Type*: [TriggerProperties](aws-properties-customerprofiles-integration-triggerproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TriggerType` Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event. *Required*: Yes *Type*: String *Allowed values*: `Scheduled | Event | OnDemand` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration TriggerProperties Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Scheduled](#cfn-customerprofiles-integration-triggerproperties-scheduled)" : ScheduledTriggerProperties } ``` ### YAML ``` [Scheduled](#cfn-customerprofiles-integration-triggerproperties-scheduled): ScheduledTriggerProperties ``` ## Properties `Scheduled` Specifies the configuration details of a schedule-triggered flow that you define. *Required*: No *Type*: [ScheduledTriggerProperties](aws-properties-customerprofiles-integration-scheduledtriggerproperties.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Integration ZendeskSourceProperties The properties that are applied when using Zendesk as a flow source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Object](#cfn-customerprofiles-integration-zendesksourceproperties-object)" : String } ``` ### YAML ``` [Object](#cfn-customerprofiles-integration-zendesksourceproperties-object): String ``` ## Properties `Object` The object specified in the Zendesk flow source. *Required*: Yes *Type*: String *Pattern*: `\S+` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::ObjectType Specifies an Amazon Connect Customer Profiles Object Type Mapping. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CustomerProfiles::ObjectType", "Properties" : { "[AllowProfileCreation](#cfn-customerprofiles-objecttype-allowprofilecreation)" : Boolean, "[Description](#cfn-customerprofiles-objecttype-description)" : String, "[DomainName](#cfn-customerprofiles-objecttype-domainname)" : String, "[EncryptionKey](#cfn-customerprofiles-objecttype-encryptionkey)" : String, "[ExpirationDays](#cfn-customerprofiles-objecttype-expirationdays)" : Integer, "[Fields](#cfn-customerprofiles-objecttype-fields)" : [ FieldMap, ... ], "[Keys](#cfn-customerprofiles-objecttype-keys)" : [ KeyMap, ... ], "[MaxProfileObjectCount](#cfn-customerprofiles-objecttype-maxprofileobjectcount)" : Integer, "[ObjectTypeName](#cfn-customerprofiles-objecttype-objecttypename)" : String, "[SourceLastUpdatedTimestampFormat](#cfn-customerprofiles-objecttype-sourcelastupdatedtimestampformat)" : String, "[SourcePriority](#cfn-customerprofiles-objecttype-sourcepriority)" : Integer, "[Tags](#cfn-customerprofiles-objecttype-tags)" : [ Tag, ... ], "[TemplateId](#cfn-customerprofiles-objecttype-templateid)" : String } } ``` ### YAML ``` Type: AWS::CustomerProfiles::ObjectType Properties: [AllowProfileCreation](#cfn-customerprofiles-objecttype-allowprofilecreation): Boolean [Description](#cfn-customerprofiles-objecttype-description): String [DomainName](#cfn-customerprofiles-objecttype-domainname): String [EncryptionKey](#cfn-customerprofiles-objecttype-encryptionkey): String [ExpirationDays](#cfn-customerprofiles-objecttype-expirationdays): Integer [Fields](#cfn-customerprofiles-objecttype-fields): - FieldMap [Keys](#cfn-customerprofiles-objecttype-keys): - KeyMap [MaxProfileObjectCount](#cfn-customerprofiles-objecttype-maxprofileobjectcount): Integer [ObjectTypeName](#cfn-customerprofiles-objecttype-objecttypename): String [SourceLastUpdatedTimestampFormat](#cfn-customerprofiles-objecttype-sourcelastupdatedtimestampformat): String [SourcePriority](#cfn-customerprofiles-objecttype-sourcepriority): Integer [Tags](#cfn-customerprofiles-objecttype-tags): - Tag [TemplateId](#cfn-customerprofiles-objecttype-templateid): String ``` ## Properties `AllowProfileCreation` Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the profile object type mapping. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `10000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainName` The unique name of the domain. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EncryptionKey` The customer-provided key to encrypt the profile object that will be created in this profile object type mapping. If not specified the system will use the encryption key of the domain. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExpirationDays` The number of days until the data of this type expires. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `1098` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Fields` A list of field definitions for the object type mapping. *Required*: No *Type*: Array of [FieldMap](aws-properties-customerprofiles-objecttype-fieldmap.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Keys` A list of keys that can be used to map data to the profile or search for the profile. *Required*: No *Type*: Array of [KeyMap](aws-properties-customerprofiles-objecttype-keymap.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxProfileObjectCount` The amount of profile object max count assigned to the object type. *Required*: No *Type*: Integer *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectTypeName` The name of the profile object type. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z_][a-zA-Z_0-9-]*$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SourceLastUpdatedTimestampFormat` The format of your sourceLastUpdatedTimestamp that was previously set up. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourcePriority` An integer that determines the priority of this object type when data from multiple sources is ingested. Lower values take priority. Object types without a specified source priority default to the lowest priority. *Required*: No *Type*: Integer *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The tags used to organize, track, or control access for this resource. *Required*: No *Type*: Array of [Tag](aws-properties-customerprofiles-objecttype-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateId` A unique identifier for the template mapping. This can be used instead of specifying the Keys and Fields properties directly. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DomainName and the ObjectTypeName of the object type. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The timestamp of when the object type was created. `LastUpdatedAt` The timestamp of when the object type was most recently edited. `MaxAvailableProfileObjectCount` The amount of provisioned profile object max count available. ## Examples The following example creates a object type if Domain existed. ### #### YAML ``` Type: "AWS::CustomerProfiles::ObjectType" Properties: DomainName: "ExampleDomain" ObjectTypeName: "ExampleObjectType" AllowProfileCreation: false Description: "Description Example" ExpirationDays: 1 Fields: - Name: "email" ObjectTypeField: Source: "_source.email" Target: "_profile.BusinessEmail" ContentType: "EMAIL_ADDRESS" Keys: - Name: "_email" ObjectTypeKeyList: - FieldNames: - "email" StandardIdentifiers: - "PROFILE" - "UNIQUE" ``` #### JSON ``` "Type": "AWS::CustomerProfiles::ObjectType", "Properties": { "DomainName": "ExampleDomain", "ObjectTypeName": "ExampleObjectType", "AllowProfileCreation": false, "Description": "Description Example", "ExpirationDays": 1, "Fields": [{ "Name": "email", "ObjectTypeField": { "Source": "_source.email", "Target": "_profile.BusinessEmail", "ContentType": "EMAIL_ADDRESS" } }], "Keys": [{ "Name": "_email", "ObjectTypeKeyList": [{ "FieldNames": [ "email" ], "StandardIdentifiers": [ "PROFILE", "UNIQUE" ] }] }] } ``` # AWS::CustomerProfiles::ObjectType FieldMap A map of the name and ObjectType field. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-customerprofiles-objecttype-fieldmap-name)" : String, "[ObjectTypeField](#cfn-customerprofiles-objecttype-fieldmap-objecttypefield)" : ObjectTypeField } ``` ### YAML ``` [Name](#cfn-customerprofiles-objecttype-fieldmap-name): String [ObjectTypeField](#cfn-customerprofiles-objecttype-fieldmap-objecttypefield): ObjectTypeField ``` ## Properties `Name` Name of the field. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectTypeField` Represents a field in a ProfileObjectType. *Required*: No *Type*: [ObjectTypeField](aws-properties-customerprofiles-objecttype-objecttypefield.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::ObjectType KeyMap A unique key map that can be used to map data to the profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-customerprofiles-objecttype-keymap-name)" : String, "[ObjectTypeKeyList](#cfn-customerprofiles-objecttype-keymap-objecttypekeylist)" : [ ObjectTypeKey, ... ] } ``` ### YAML ``` [Name](#cfn-customerprofiles-objecttype-keymap-name): String [ObjectTypeKeyList](#cfn-customerprofiles-objecttype-keymap-objecttypekeylist): - ObjectTypeKey ``` ## Properties `Name` Name of the key. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectTypeKeyList` A list of ObjectTypeKey. *Required*: No *Type*: Array of [ObjectTypeKey](aws-properties-customerprofiles-objecttype-objecttypekey.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::ObjectType ObjectTypeField Represents a field in a ProfileObjectType. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ContentType](#cfn-customerprofiles-objecttype-objecttypefield-contenttype)" : String, "[Source](#cfn-customerprofiles-objecttype-objecttypefield-source)" : String, "[Target](#cfn-customerprofiles-objecttype-objecttypefield-target)" : String } ``` ### YAML ``` [ContentType](#cfn-customerprofiles-objecttype-objecttypefield-contenttype): String [Source](#cfn-customerprofiles-objecttype-objecttypefield-source): String [Target](#cfn-customerprofiles-objecttype-objecttypefield-target): String ``` ## Properties `ContentType` The content type of the field. Used for determining equality when searching. *Required*: No *Type*: String *Allowed values*: `STRING | NUMBER | PHONE_NUMBER | EMAIL_ADDRESS | NAME` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` A field of a ProfileObject. For example: \$1source.FirstName, where “\$1source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Target` The location of the data in the standard ProfileObject model. For example: \$1profile.Address.PostalCode. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::ObjectType ObjectTypeKey An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FieldNames](#cfn-customerprofiles-objecttype-objecttypekey-fieldnames)" : [ String, ... ], "[StandardIdentifiers](#cfn-customerprofiles-objecttype-objecttypekey-standardidentifiers)" : [ String, ... ] } ``` ### YAML ``` [FieldNames](#cfn-customerprofiles-objecttype-objecttypekey-fieldnames): - String [StandardIdentifiers](#cfn-customerprofiles-objecttype-objecttypekey-standardidentifiers): - String ``` ## Properties `FieldNames` The reference for the key name of the fields map. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StandardIdentifiers` The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP\$1ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW\$1ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles. *Required*: No *Type*: Array of String *Allowed values*: `PROFILE | UNIQUE | SECONDARY | LOOKUP_ONLY | NEW_ONLY | ASSET | CASE | ORDER | AIR_PREFERENCE | AIR_BOOKING | AIR_SEGMENT | HOTEL_PREFERENCE | HOTEL_STAY_REVENUE | HOTEL_RESERVATION | LOYALTY | LOYALTY_TRANSACTION | LOYALTY_PROMOTION | WEB_ANALYTICS | DEVICE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::ObjectType Tag The tags (keys and values) associated with the integration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-objecttype-tag-key)" : String, "[Value](#cfn-customerprofiles-objecttype-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-objecttype-tag-key): String [Value](#cfn-customerprofiles-objecttype-tag-value): String ``` ## Properties `Key` A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources. *Required*: Yes *Type*: String *Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value for the specified tag key. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Recommender The `AWS::CustomerProfiles::Recommender` resource Property description not available. for CustomerProfiles. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CustomerProfiles::Recommender", "Properties" : { "[Description](#cfn-customerprofiles-recommender-description)" : String, "[DomainName](#cfn-customerprofiles-recommender-domainname)" : String, "[RecommenderConfig](#cfn-customerprofiles-recommender-recommenderconfig)" : RecommenderConfig, "[RecommenderName](#cfn-customerprofiles-recommender-recommendername)" : String, "[RecommenderRecipeName](#cfn-customerprofiles-recommender-recommenderrecipename)" : String, "[Tags](#cfn-customerprofiles-recommender-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CustomerProfiles::Recommender Properties: [Description](#cfn-customerprofiles-recommender-description): String [DomainName](#cfn-customerprofiles-recommender-domainname): String [RecommenderConfig](#cfn-customerprofiles-recommender-recommenderconfig): RecommenderConfig [RecommenderName](#cfn-customerprofiles-recommender-recommendername): String [RecommenderRecipeName](#cfn-customerprofiles-recommender-recommenderrecipename): String [Tags](#cfn-customerprofiles-recommender-tags): - Tag ``` ## Properties `Description` A description of the recommender's purpose and characteristics. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DomainName` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RecommenderConfig` The configuration settings applied to this recommender. *Required*: No *Type*: [RecommenderConfig](aws-properties-customerprofiles-recommender-recommenderconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RecommenderName` The name of the recommender. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RecommenderRecipeName` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` The tags used to organize, track, or control access for this resource. *Required*: No *Type*: Array of [Tag](aws-properties-customerprofiles-recommender-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref ### Fn::GetAtt #### `CreatedAt` The timestamp when the recommender was created. `FailureReason` If the recommender is in a failed state, provides the reason for the failure. `LastUpdatedAt` The timestamp of when the recommender was edited. `RecommenderArn` Property description not available. `Status` The current operational status of the recommender. `TrainingMetrics` Property description not available. # AWS::CustomerProfiles::Recommender EventParameters The `EventParameters` property type specifies Property description not available. for an [AWS::CustomerProfiles::Recommender](aws-resource-customerprofiles-recommender.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EventType](#cfn-customerprofiles-recommender-eventparameters-eventtype)" : String, "[EventValueThreshold](#cfn-customerprofiles-recommender-eventparameters-eventvaluethreshold)" : Number } ``` ### YAML ``` [EventType](#cfn-customerprofiles-recommender-eventparameters-eventtype): String [EventValueThreshold](#cfn-customerprofiles-recommender-eventparameters-eventvaluethreshold): Number ``` ## Properties `EventType` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EventValueThreshold` Property description not available. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Recommender EventsConfig The `EventsConfig` property type specifies Property description not available. for an [AWS::CustomerProfiles::Recommender](aws-resource-customerprofiles-recommender.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EventParametersList](#cfn-customerprofiles-recommender-eventsconfig-eventparameterslist)" : [ EventParameters, ... ] } ``` ### YAML ``` [EventParametersList](#cfn-customerprofiles-recommender-eventsconfig-eventparameterslist): - EventParameters ``` ## Properties `EventParametersList` Property description not available. *Required*: Yes *Type*: Array of [EventParameters](aws-properties-customerprofiles-recommender-eventparameters.md) *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Recommender Metrics The `Metrics` property type specifies Property description not available. for an [AWS::CustomerProfiles::Recommender](aws-resource-customerprofiles-recommender.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[coverage](#cfn-customerprofiles-recommender-metrics-coverage)" : Number, "[freshness](#cfn-customerprofiles-recommender-metrics-freshness)" : Number, "[hit](#cfn-customerprofiles-recommender-metrics-hit)" : Number, "[popularity](#cfn-customerprofiles-recommender-metrics-popularity)" : Number, "[recall](#cfn-customerprofiles-recommender-metrics-recall)" : Number, "[similarity](#cfn-customerprofiles-recommender-metrics-similarity)" : Number } ``` ### YAML ``` [coverage](#cfn-customerprofiles-recommender-metrics-coverage): Number [freshness](#cfn-customerprofiles-recommender-metrics-freshness): Number [hit](#cfn-customerprofiles-recommender-metrics-hit): Number [popularity](#cfn-customerprofiles-recommender-metrics-popularity): Number [recall](#cfn-customerprofiles-recommender-metrics-recall): Number [similarity](#cfn-customerprofiles-recommender-metrics-similarity): Number ``` ## Properties `coverage` Property description not available. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `freshness` Property description not available. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `hit` Property description not available. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `popularity` Property description not available. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `recall` Property description not available. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `similarity` Property description not available. *Required*: No *Type*: Number *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Recommender RecommenderConfig The `RecommenderConfig` property type specifies Property description not available. for an [AWS::CustomerProfiles::Recommender](aws-resource-customerprofiles-recommender.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EventsConfig](#cfn-customerprofiles-recommender-recommenderconfig-eventsconfig)" : EventsConfig } ``` ### YAML ``` [EventsConfig](#cfn-customerprofiles-recommender-recommenderconfig-eventsconfig): EventsConfig ``` ## Properties `EventsConfig` Property description not available. *Required*: No *Type*: [EventsConfig](aws-properties-customerprofiles-recommender-eventsconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Recommender RecommenderUpdate The `RecommenderUpdate` property type specifies Property description not available. for an [AWS::CustomerProfiles::Recommender](aws-resource-customerprofiles-recommender.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CreationDateTime](#cfn-customerprofiles-recommender-recommenderupdate-creationdatetime)" : String, "[FailureReason](#cfn-customerprofiles-recommender-recommenderupdate-failurereason)" : String, "[LastUpdatedDateTime](#cfn-customerprofiles-recommender-recommenderupdate-lastupdateddatetime)" : String, "[RecommenderConfig](#cfn-customerprofiles-recommender-recommenderupdate-recommenderconfig)" : RecommenderConfig, "[Status](#cfn-customerprofiles-recommender-recommenderupdate-status)" : String } ``` ### YAML ``` [CreationDateTime](#cfn-customerprofiles-recommender-recommenderupdate-creationdatetime): String [FailureReason](#cfn-customerprofiles-recommender-recommenderupdate-failurereason): String [LastUpdatedDateTime](#cfn-customerprofiles-recommender-recommenderupdate-lastupdateddatetime): String [RecommenderConfig](#cfn-customerprofiles-recommender-recommenderupdate-recommenderconfig): RecommenderConfig [Status](#cfn-customerprofiles-recommender-recommenderupdate-status): String ``` ## Properties `CreationDateTime` Property description not available. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FailureReason` Property description not available. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LastUpdatedDateTime` Property description not available. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RecommenderConfig` Property description not available. *Required*: No *Type*: [RecommenderConfig](aws-properties-customerprofiles-recommender-recommenderconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Status` Property description not available. *Required*: No *Type*: String *Allowed values*: `PENDING | IN_PROGRESS | STOPPING | STARTING | ACTIVE | INACTIVE | FAILED | DELETING` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Recommender Tag The `Tag` property type specifies Property description not available. for an [AWS::CustomerProfiles::Recommender](aws-resource-customerprofiles-recommender.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-recommender-tag-key)" : String, "[Value](#cfn-customerprofiles-recommender-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-recommender-tag-key): String [Value](#cfn-customerprofiles-recommender-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::Recommender TrainingMetrics The `TrainingMetrics` property type specifies Property description not available. for an [AWS::CustomerProfiles::Recommender](aws-resource-customerprofiles-recommender.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Metrics](#cfn-customerprofiles-recommender-trainingmetrics-metrics)" : Metrics, "[Time](#cfn-customerprofiles-recommender-trainingmetrics-time)" : String } ``` ### YAML ``` [Metrics](#cfn-customerprofiles-recommender-trainingmetrics-metrics): Metrics [Time](#cfn-customerprofiles-recommender-trainingmetrics-time): String ``` ## Properties `Metrics` Property description not available. *Required*: No *Type*: [Metrics](aws-properties-customerprofiles-recommender-metrics.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Time` Property description not available. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::SegmentDefinition A segment definition resource of Amazon Connect Customer Profiles. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::CustomerProfiles::SegmentDefinition", "Properties" : { "[Description](#cfn-customerprofiles-segmentdefinition-description)" : String, "[DisplayName](#cfn-customerprofiles-segmentdefinition-displayname)" : String, "[DomainName](#cfn-customerprofiles-segmentdefinition-domainname)" : String, "[SegmentDefinitionName](#cfn-customerprofiles-segmentdefinition-segmentdefinitionname)" : String, "[SegmentGroups](#cfn-customerprofiles-segmentdefinition-segmentgroups)" : SegmentGroup, "[SegmentSort](#cfn-customerprofiles-segmentdefinition-segmentsort)" : SegmentSort, "[SegmentSqlQuery](#cfn-customerprofiles-segmentdefinition-segmentsqlquery)" : String, "[Tags](#cfn-customerprofiles-segmentdefinition-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::CustomerProfiles::SegmentDefinition Properties: [Description](#cfn-customerprofiles-segmentdefinition-description): String [DisplayName](#cfn-customerprofiles-segmentdefinition-displayname): String [DomainName](#cfn-customerprofiles-segmentdefinition-domainname): String [SegmentDefinitionName](#cfn-customerprofiles-segmentdefinition-segmentdefinitionname): String [SegmentGroups](#cfn-customerprofiles-segmentdefinition-segmentgroups): SegmentGroup [SegmentSort](#cfn-customerprofiles-segmentdefinition-segmentsort): SegmentSort [SegmentSqlQuery](#cfn-customerprofiles-segmentdefinition-segmentsqlquery): String [Tags](#cfn-customerprofiles-segmentdefinition-tags): - Tag ``` ## Properties `Description` The description of the segment definition. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `4000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DisplayName` Display name of the segment definition. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DomainName` The name of the domain. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SegmentDefinitionName` Name of the segment definition. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SegmentGroups` Contains all groups of the segment definition. *Required*: No *Type*: [SegmentGroup](aws-properties-customerprofiles-segmentdefinition-segmentgroup.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SegmentSort` Property description not available. *Required*: No *Type*: [SegmentSort](aws-properties-customerprofiles-segmentdefinition-segmentsort.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SegmentSqlQuery` Property description not available. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `50000` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` The tags belonging to the segment definition. *Required*: No *Type*: Array of [Tag](aws-properties-customerprofiles-segmentdefinition-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref ### Fn::GetAtt #### `CreatedAt` When the segment definition was created. `SegmentDefinitionArn` The arn of the segment definition. `SegmentType` The segment type. Classic : Segments created using traditional SegmentGroup structure Enhanced : Segments created using SQL queries # AWS::CustomerProfiles::SegmentDefinition AddressDimension Object that segments on Customer Profile's address object. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[City](#cfn-customerprofiles-segmentdefinition-addressdimension-city)" : ProfileDimension, "[Country](#cfn-customerprofiles-segmentdefinition-addressdimension-country)" : ProfileDimension, "[County](#cfn-customerprofiles-segmentdefinition-addressdimension-county)" : ProfileDimension, "[PostalCode](#cfn-customerprofiles-segmentdefinition-addressdimension-postalcode)" : ProfileDimension, "[Province](#cfn-customerprofiles-segmentdefinition-addressdimension-province)" : ProfileDimension, "[State](#cfn-customerprofiles-segmentdefinition-addressdimension-state)" : ProfileDimension } ``` ### YAML ``` [City](#cfn-customerprofiles-segmentdefinition-addressdimension-city): ProfileDimension [Country](#cfn-customerprofiles-segmentdefinition-addressdimension-country): ProfileDimension [County](#cfn-customerprofiles-segmentdefinition-addressdimension-county): ProfileDimension [PostalCode](#cfn-customerprofiles-segmentdefinition-addressdimension-postalcode): ProfileDimension [Province](#cfn-customerprofiles-segmentdefinition-addressdimension-province): ProfileDimension [State](#cfn-customerprofiles-segmentdefinition-addressdimension-state): ProfileDimension ``` ## Properties `City` The city belonging to the address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Country` The country belonging to the address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `County` The county belonging to the address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PostalCode` The postal code belonging to the address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Province` The province belonging to the address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `State` The state belonging to the address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition AttributeDimension Object that defines how to filter the incoming objects for the calculated attribute. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DimensionType](#cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype)" : String, "[Values](#cfn-customerprofiles-segmentdefinition-attributedimension-values)" : [ String, ... ] } ``` ### YAML ``` [DimensionType](#cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype): String [Values](#cfn-customerprofiles-segmentdefinition-attributedimension-values): - String ``` ## Properties `DimensionType` The action to segment with. *Required*: Yes *Type*: String *Allowed values*: `INCLUSIVE | EXCLUSIVE | CONTAINS | BEGINS_WITH | ENDS_WITH | BEFORE | AFTER | BETWEEN | NOT_BETWEEN | ON | GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Values` The values to apply the DimensionType on. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `255 | 50` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition CalculatedAttributeDimension Object that segments on Customer Profile's Calculated Attributes. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConditionOverrides](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides)" : ConditionOverrides, "[DimensionType](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype)" : String, "[Values](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values)" : [ String, ... ] } ``` ### YAML ``` [ConditionOverrides](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides): ConditionOverrides [DimensionType](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype): String [Values](#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values): - String ``` ## Properties `ConditionOverrides` Applies the given condition over the initial Calculated Attribute's definition. *Required*: No *Type*: [ConditionOverrides](aws-properties-customerprofiles-segmentdefinition-conditionoverrides.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DimensionType` The action to segment with. *Required*: Yes *Type*: String *Allowed values*: `INCLUSIVE | EXCLUSIVE | CONTAINS | BEGINS_WITH | ENDS_WITH | BEFORE | AFTER | BETWEEN | NOT_BETWEEN | ON | GREATER_THAN | LESS_THAN | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | EQUAL` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Values` The values to apply the DimensionType with. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `255 | 50` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition ConditionOverrides An object to override the original condition block of a calculated attribute. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Range](#cfn-customerprofiles-segmentdefinition-conditionoverrides-range)" : RangeOverride } ``` ### YAML ``` [Range](#cfn-customerprofiles-segmentdefinition-conditionoverrides-range): RangeOverride ``` ## Properties `Range` The relative time period over which data is included in the aggregation for this override. *Required*: No *Type*: [RangeOverride](aws-properties-customerprofiles-segmentdefinition-rangeoverride.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition DateDimension Object that segments on various Customer Profile's date fields. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DimensionType](#cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype)" : String, "[Values](#cfn-customerprofiles-segmentdefinition-datedimension-values)" : [ String, ... ] } ``` ### YAML ``` [DimensionType](#cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype): String [Values](#cfn-customerprofiles-segmentdefinition-datedimension-values): - String ``` ## Properties `DimensionType` The action to segment on. *Required*: Yes *Type*: String *Allowed values*: `BEFORE | AFTER | BETWEEN | NOT_BETWEEN | ON` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Values` The values to apply the DimensionType on. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `50` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition Dimension Defines the attribute to segment on. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CalculatedAttributes](#cfn-customerprofiles-segmentdefinition-dimension-calculatedattributes)" : {Key: Value, ...}, "[ProfileAttributes](#cfn-customerprofiles-segmentdefinition-dimension-profileattributes)" : ProfileAttributes } ``` ### YAML ``` [CalculatedAttributes](#cfn-customerprofiles-segmentdefinition-dimension-calculatedattributes): Key: Value [ProfileAttributes](#cfn-customerprofiles-segmentdefinition-dimension-profileattributes): ProfileAttributes ``` ## Properties `CalculatedAttributes` Object that holds the calculated attributes to segment on. *Required*: No *Type*: Object of [CalculatedAttributeDimension](aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProfileAttributes` Object that holds the profile attributes to segment on. *Required*: No *Type*: [ProfileAttributes](aws-properties-customerprofiles-segmentdefinition-profileattributes.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition ExtraLengthValueProfileDimension Object that segments on various Customer profile's fields that are larger than normal. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DimensionType](#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype)" : String, "[Values](#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values)" : [ String, ... ] } ``` ### YAML ``` [DimensionType](#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype): String [Values](#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values): - String ``` ## Properties `DimensionType` The action to segment with. *Required*: Yes *Type*: String *Allowed values*: `INCLUSIVE | EXCLUSIVE | CONTAINS | BEGINS_WITH | ENDS_WITH` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Values` The values to apply the DimensionType on. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `1000 | 50` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition Group Contains dimensions that determine what to segment on. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Dimensions](#cfn-customerprofiles-segmentdefinition-group-dimensions)" : [ Dimension, ... ], "[SourceSegments](#cfn-customerprofiles-segmentdefinition-group-sourcesegments)" : [ SourceSegment, ... ], "[SourceType](#cfn-customerprofiles-segmentdefinition-group-sourcetype)" : String, "[Type](#cfn-customerprofiles-segmentdefinition-group-type)" : String } ``` ### YAML ``` [Dimensions](#cfn-customerprofiles-segmentdefinition-group-dimensions): - Dimension [SourceSegments](#cfn-customerprofiles-segmentdefinition-group-sourcesegments): - SourceSegment [SourceType](#cfn-customerprofiles-segmentdefinition-group-sourcetype): String [Type](#cfn-customerprofiles-segmentdefinition-group-type): String ``` ## Properties `Dimensions` Defines the attributes to segment on. *Required*: No *Type*: Array of [Dimension](aws-properties-customerprofiles-segmentdefinition-dimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SourceSegments` Defines the starting source of data. *Required*: No *Type*: Array of [SourceSegment](aws-properties-customerprofiles-segmentdefinition-sourcesegment.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SourceType` Defines how to interact with the source data. *Required*: No *Type*: String *Allowed values*: `ALL | ANY | NONE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Type` Defines how to interact with the profiles found in the current filtering. *Required*: No *Type*: String *Allowed values*: `ALL | ANY | NONE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition ProfileAttributes The object used to segment on attributes within the customer profile. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AccountNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber)" : ProfileDimension, "[AdditionalInformation](#cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation)" : ExtraLengthValueProfileDimension, "[Address](#cfn-customerprofiles-segmentdefinition-profileattributes-address)" : AddressDimension, "[Attributes](#cfn-customerprofiles-segmentdefinition-profileattributes-attributes)" : {Key: Value, ...}, "[BillingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress)" : AddressDimension, "[BirthDate](#cfn-customerprofiles-segmentdefinition-profileattributes-birthdate)" : DateDimension, "[BusinessEmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress)" : ProfileDimension, "[BusinessName](#cfn-customerprofiles-segmentdefinition-profileattributes-businessname)" : ProfileDimension, "[BusinessPhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber)" : ProfileDimension, "[EmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress)" : ProfileDimension, "[FirstName](#cfn-customerprofiles-segmentdefinition-profileattributes-firstname)" : ProfileDimension, "[GenderString](#cfn-customerprofiles-segmentdefinition-profileattributes-genderstring)" : ProfileDimension, "[HomePhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber)" : ProfileDimension, "[LastName](#cfn-customerprofiles-segmentdefinition-profileattributes-lastname)" : ProfileDimension, "[MailingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress)" : AddressDimension, "[MiddleName](#cfn-customerprofiles-segmentdefinition-profileattributes-middlename)" : ProfileDimension, "[MobilePhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber)" : ProfileDimension, "[PartyTypeString](#cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring)" : ProfileDimension, "[PersonalEmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress)" : ProfileDimension, "[PhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber)" : ProfileDimension, "[ProfileType](#cfn-customerprofiles-segmentdefinition-profileattributes-profiletype)" : ProfileTypeDimension, "[ShippingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress)" : AddressDimension } ``` ### YAML ``` [AccountNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber): ProfileDimension [AdditionalInformation](#cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation): ExtraLengthValueProfileDimension [Address](#cfn-customerprofiles-segmentdefinition-profileattributes-address): AddressDimension [Attributes](#cfn-customerprofiles-segmentdefinition-profileattributes-attributes): Key: Value [BillingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress): AddressDimension [BirthDate](#cfn-customerprofiles-segmentdefinition-profileattributes-birthdate): DateDimension [BusinessEmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress): ProfileDimension [BusinessName](#cfn-customerprofiles-segmentdefinition-profileattributes-businessname): ProfileDimension [BusinessPhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber): ProfileDimension [EmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress): ProfileDimension [FirstName](#cfn-customerprofiles-segmentdefinition-profileattributes-firstname): ProfileDimension [GenderString](#cfn-customerprofiles-segmentdefinition-profileattributes-genderstring): ProfileDimension [HomePhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber): ProfileDimension [LastName](#cfn-customerprofiles-segmentdefinition-profileattributes-lastname): ProfileDimension [MailingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress): AddressDimension [MiddleName](#cfn-customerprofiles-segmentdefinition-profileattributes-middlename): ProfileDimension [MobilePhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber): ProfileDimension [PartyTypeString](#cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring): ProfileDimension [PersonalEmailAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress): ProfileDimension [PhoneNumber](#cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber): ProfileDimension [ProfileType](#cfn-customerprofiles-segmentdefinition-profileattributes-profiletype): ProfileTypeDimension [ShippingAddress](#cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress): AddressDimension ``` ## Properties `AccountNumber` A field to describe values to segment on within account number. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AdditionalInformation` A field to describe values to segment on within additional information. *Required*: No *Type*: [ExtraLengthValueProfileDimension](aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Address` A field to describe values to segment on within address. *Required*: No *Type*: [AddressDimension](aws-properties-customerprofiles-segmentdefinition-addressdimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Attributes` A field to describe values to segment on within attributes. *Required*: No *Type*: Object of [AttributeDimension](aws-properties-customerprofiles-segmentdefinition-attributedimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `BillingAddress` A field to describe values to segment on within billing address. *Required*: No *Type*: [AddressDimension](aws-properties-customerprofiles-segmentdefinition-addressdimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `BirthDate` A field to describe values to segment on within birthDate. *Required*: No *Type*: [DateDimension](aws-properties-customerprofiles-segmentdefinition-datedimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `BusinessEmailAddress` A field to describe values to segment on within business email address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `BusinessName` A field to describe values to segment on within business name. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `BusinessPhoneNumber` A field to describe values to segment on within business phone number. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EmailAddress` A field to describe values to segment on within email address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FirstName` A field to describe values to segment on within first name. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `GenderString` A field to describe values to segment on within genderString. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `HomePhoneNumber` A field to describe values to segment on within home phone number. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `LastName` A field to describe values to segment on within last name. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MailingAddress` A field to describe values to segment on within mailing address. *Required*: No *Type*: [AddressDimension](aws-properties-customerprofiles-segmentdefinition-addressdimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MiddleName` A field to describe values to segment on within middle name. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MobilePhoneNumber` A field to describe values to segment on within mobile phone number. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PartyTypeString` A field to describe values to segment on within partyTypeString. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PersonalEmailAddress` A field to describe values to segment on within personal email address. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PhoneNumber` A field to describe values to segment on within phone number. *Required*: No *Type*: [ProfileDimension](aws-properties-customerprofiles-segmentdefinition-profiledimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProfileType` The type of profile. *Required*: No *Type*: [ProfileTypeDimension](aws-properties-customerprofiles-segmentdefinition-profiletypedimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ShippingAddress` A field to describe values to segment on within shipping address. *Required*: No *Type*: [AddressDimension](aws-properties-customerprofiles-segmentdefinition-addressdimension.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition ProfileDimension Object that segments on various Customer profile's fields that are larger than normal. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DimensionType](#cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype)" : String, "[Values](#cfn-customerprofiles-segmentdefinition-profiledimension-values)" : [ String, ... ] } ``` ### YAML ``` [DimensionType](#cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype): String [Values](#cfn-customerprofiles-segmentdefinition-profiledimension-values): - String ``` ## Properties `DimensionType` The action to segment on. *Required*: Yes *Type*: String *Allowed values*: `INCLUSIVE | EXCLUSIVE | CONTAINS | BEGINS_WITH | ENDS_WITH` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Values` Property description not available. *Required*: Yes *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `255 | 50` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition ProfileTypeDimension Specifies profile type based criteria for a segment. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DimensionType](#cfn-customerprofiles-segmentdefinition-profiletypedimension-dimensiontype)" : String, "[Values](#cfn-customerprofiles-segmentdefinition-profiletypedimension-values)" : [ String, ... ] } ``` ### YAML ``` [DimensionType](#cfn-customerprofiles-segmentdefinition-profiletypedimension-dimensiontype): String [Values](#cfn-customerprofiles-segmentdefinition-profiletypedimension-values): - String ``` ## Properties `DimensionType` The action to segment on. *Required*: Yes *Type*: String *Allowed values*: `INCLUSIVE | EXCLUSIVE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Values` The values to apply the DimensionType on. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition RangeOverride Overrides the original range on a calculated attribute definition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[End](#cfn-customerprofiles-segmentdefinition-rangeoverride-end)" : Integer, "[Start](#cfn-customerprofiles-segmentdefinition-rangeoverride-start)" : Integer, "[Unit](#cfn-customerprofiles-segmentdefinition-rangeoverride-unit)" : String } ``` ### YAML ``` [End](#cfn-customerprofiles-segmentdefinition-rangeoverride-end): Integer [Start](#cfn-customerprofiles-segmentdefinition-rangeoverride-start): Integer [Unit](#cfn-customerprofiles-segmentdefinition-rangeoverride-unit): String ``` ## Properties `End` The end time of when to include objects. *Required*: No *Type*: Integer *Minimum*: `-2147483648` *Maximum*: `2147483647` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Start` The start time of when to include objects. *Required*: Yes *Type*: Integer *Minimum*: `-2147483648` *Maximum*: `2147483647` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Unit` The unit for start and end. *Required*: Yes *Type*: String *Allowed values*: `DAYS` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition SegmentGroup Contains all groups of the segment definition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Groups](#cfn-customerprofiles-segmentdefinition-segmentgroup-groups)" : [ Group, ... ], "[Include](#cfn-customerprofiles-segmentdefinition-segmentgroup-include)" : String } ``` ### YAML ``` [Groups](#cfn-customerprofiles-segmentdefinition-segmentgroup-groups): - Group [Include](#cfn-customerprofiles-segmentdefinition-segmentgroup-include): String ``` ## Properties `Groups` Holds the list of groups within the segment definition. *Required*: No *Type*: Array of [Group](aws-properties-customerprofiles-segmentdefinition-group.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Include` Defines whether to include or exclude the profiles that fit the segment criteria. *Required*: No *Type*: String *Allowed values*: `ALL | ANY | NONE` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition SegmentSort The `SegmentSort` property type specifies Property description not available. for an [AWS::CustomerProfiles::SegmentDefinition](aws-resource-customerprofiles-segmentdefinition.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Attributes](#cfn-customerprofiles-segmentdefinition-segmentsort-attributes)" : [ SortAttribute, ... ] } ``` ### YAML ``` [Attributes](#cfn-customerprofiles-segmentdefinition-segmentsort-attributes): - SortAttribute ``` ## Properties `Attributes` Property description not available. *Required*: Yes *Type*: Array of [SortAttribute](aws-properties-customerprofiles-segmentdefinition-sortattribute.md) *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::SegmentDefinition SortAttribute The `SortAttribute` property type specifies Property description not available. for an [AWS::CustomerProfiles::SegmentDefinition](aws-resource-customerprofiles-segmentdefinition.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataType](#cfn-customerprofiles-segmentdefinition-sortattribute-datatype)" : String, "[Name](#cfn-customerprofiles-segmentdefinition-sortattribute-name)" : String, "[Order](#cfn-customerprofiles-segmentdefinition-sortattribute-order)" : String, "[Type](#cfn-customerprofiles-segmentdefinition-sortattribute-type)" : String } ``` ### YAML ``` [DataType](#cfn-customerprofiles-segmentdefinition-sortattribute-datatype): String [Name](#cfn-customerprofiles-segmentdefinition-sortattribute-name): String [Order](#cfn-customerprofiles-segmentdefinition-sortattribute-order): String [Type](#cfn-customerprofiles-segmentdefinition-sortattribute-type): String ``` ## Properties `DataType` Property description not available. *Required*: No *Type*: String *Allowed values*: `STRING | NUMBER | DATE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Order` Property description not available. *Required*: Yes *Type*: String *Allowed values*: `ASC | DESC` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` Property description not available. *Required*: No *Type*: String *Allowed values*: `PROFILE | CALCULATED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::CustomerProfiles::SegmentDefinition SourceSegment The source segments to build off of. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SegmentDefinitionName](#cfn-customerprofiles-segmentdefinition-sourcesegment-segmentdefinitionname)" : String } ``` ### YAML ``` [SegmentDefinitionName](#cfn-customerprofiles-segmentdefinition-sourcesegment-segmentdefinitionname): String ``` ## Properties `SegmentDefinitionName` The name of the source segment. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::CustomerProfiles::SegmentDefinition Tag The tag belonging to the segment definition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-customerprofiles-segmentdefinition-tag-key)" : String, "[Value](#cfn-customerprofiles-segmentdefinition-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-customerprofiles-segmentdefinition-tag-key): String [Value](#cfn-customerprofiles-segmentdefinition-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)