View a markdown version of this page

AWS::CleanRooms::ConfiguredTable AggregationThreshold - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::CleanRooms::ConfiguredTable AggregationThreshold

Specifies the minimum number of distinct identities that each query output group must represent.

Syntax

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

JSON

{
  "AllowedAggregateExpressionType" : String,
  "IdentityColumns" : [ String, ... ],
  "MinimumIdentityCount" : Integer,
  "OutputColumnThresholds" : [ OutputColumnThreshold, ... ],
  "Type" : String
}

Properties

AllowedAggregateExpressionType

Specifies whether a query can aggregate a transformed column. This applies to the arguments of both aggregate and window functions. Valid values are:

COLUMNS_ONLY – A query can aggregate only a direct column reference, such as SUM(amount), or a constant. Amazon Clean Rooms rejects a query that transforms a column and then aggregates it, such as SUM(amount * 2) or SUM(ROUND(amount)).

ANY_EXPRESSION – A query can aggregate any expression. This includes arithmetic, such as SUM(price * quantity); a cast, such as SUM(CAST(amount AS DECIMAL)); a nested function call, such as SUM(COALESCE(amount, 0)); and a conditional, such as SUM(CASE WHEN region = 'EU' THEN amount ELSE 0 END).

Required: Yes

Type: String

Allowed values: COLUMNS_ONLY | ANY_EXPRESSION

Update requires: No interruption

IdentityColumns

The identity column, such as user_id, whose distinct values Amazon Clean Rooms counts to enforce minimum aggregation thresholds. Currently, you can specify only one column, and its data type must be string, varchar, or char.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 1

Update requires: No interruption

MinimumIdentityCount

The minimum number of distinct identities that each query output group must represent. This threshold applies to all output columns in the table. To override this threshold for a specific column, use outputColumnThresholds.

Required: Yes

Type: Integer

Minimum: 2

Maximum: 100000

Update requires: No interruption

OutputColumnThresholds

The per-column overrides of minimumIdentityCount. An output column without an override uses minimumIdentityCount.

Required: No

Type: Array of OutputColumnThreshold

Update requires: No interruption

Type

The type of aggregation that the threshold enforces. Currently, the only supported value is COUNT_DISTINCT, which counts the distinct values in the identity column.

Required: Yes

Type: String

Allowed values: COUNT_DISTINCT

Update requires: No interruption