AWS::CustomerProfiles::CalculatedAttributeDefinition - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::CustomerProfiles::CalculatedAttributeDefinition

A calculated attribute definition for Customer Profiles.

Syntax

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

JSON

{
  "Type" : "AWS::CustomerProfiles::CalculatedAttributeDefinition",
  "Properties" : {
      "AttributeDetails" : AttributeDetails,
      "CalculatedAttributeName" : String,
      "Conditions" : Conditions,
      "Description" : String,
      "DisplayName" : String,
      "DomainName" : String,
      "Statistic" : String,
      "Tags" : [ Tag, ... ],
      "UseHistoricalData" : Boolean
    }
}

YAML

Type: AWS::CustomerProfiles::CalculatedAttributeDefinition
Properties:
  AttributeDetails: 
    AttributeDetails
  CalculatedAttributeName: String
  Conditions: 
    Conditions
  Description: String
  DisplayName: String
  DomainName: String
  Statistic: String
  Tags: 
    - Tag
  UseHistoricalData: Boolean

Properties

AttributeDetails

Mathematical expression and a list of attribute items specified in that expression.

Required: Yes

Type: AttributeDetails

Update requires: No interruption

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

Conditions

The conditions including range, object count, and threshold for the calculated attribute.

Required: No

Type: Conditions

Update requires: No interruption

Description

The description of the calculated attribute.

Required: No

Type: String

Minimum: 1

Maximum: 1000

Update requires: No interruption

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

DomainName

The unique name of the domain.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 64

Update requires: 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

Tags

An array of key-value pairs to apply to this resource.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

UseHistoricalData

Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

Required: No

Type: Boolean

Update requires: 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.)