AWS::CleanRooms::ConfiguredTable AnalysisRuleAggregation

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

Syntax

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

JSON

{
  "AggregateColumns" : [ AggregateColumn, ... ],
  "AllowedJoinOperators" : [ String, ... ],
  "DimensionColumns" : [ String, ... ],
  "JoinColumns" : [ String, ... ],
  "JoinRequired" : String,
  "OutputConstraints" : [ AggregationConstraint, ... ],
  "ScalarFunctions" : [ String, ... ]
}

YAML

  AggregateColumns: 
    - AggregateColumn
  AllowedJoinOperators: 
    - String
  DimensionColumns: 
    - String
  JoinColumns: 
    - String
  JoinRequired: String
  OutputConstraints: 
    - AggregationConstraint
  ScalarFunctions: 
    - String

Properties

AggregateColumns

The columns that query runners are allowed to use in aggregation queries.

Required: Yes

Type: Array of AggregateColumn

Minimum: 1

Update requires: No interruption

AllowedJoinOperators

Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.

Required: No

Type: Array of String

Maximum: 2

Update requires: No interruption

DimensionColumns

The columns that query runners are allowed to select, group by, or filter by.

Required: Yes

Type: Array of String

Update requires: No interruption

JoinColumns

Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.

Required: Yes

Type: Array of String

Update requires: No interruption

JoinRequired

Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

Required: No

Type: String

Allowed values: QUERY_RUNNER

Update requires: No interruption

OutputConstraints

Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

Required: Yes

Type: Array of AggregationConstraint

Minimum: 1

Update requires: No interruption

ScalarFunctions

Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

Required: Yes

Type: Array of String

Update requires: No interruption