# AnalysisRuleAggregationProperty

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

- Source: Generated code
- Type last changed: v2.154.0 · 22 Aug 2024

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cleanrooms as cleanrooms } from 'aws-cdk-lib';
const analysisRuleAggregationProperty: cleanrooms.CfnConfiguredTable.AnalysisRuleAggregationProperty = {
  aggregateColumns: [{
    columnNames: ['columnNames'],
    function: 'function',
  }],
  dimensionColumns: ['dimensionColumns'],
  joinColumns: ['joinColumns'],
  outputConstraints: [{
    columnName: 'columnName',
    minimum: 123,
    type: 'type',
  }],
  scalarFunctions: ['scalarFunctions'],

  // the properties below are optional
  additionalAnalyses: 'additionalAnalyses',
  allowedJoinOperators: ['allowedJoinOperators'],
  joinRequired: 'joinRequired',
};
```

## Properties

- `additionalAnalyses`: string — An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.

  The `additionalAnalyses` parameter is currently supported for the list analysis rule ( `AnalysisRuleList` ) and the custom analysis rule ( `AnalysisRuleCustom` ).

- `aggregateColumns`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConfiguredTable.AggregateColumnProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cleanrooms.CfnConfiguredTable.AggregateColumnProperty.html)[] (required) — The columns that query runners are allowed to use in aggregation queries.

- `allowedJoinOperators`: string[] — Which logical operators (if any) are to be used in an INNER JOIN match condition.

  Default is `AND` .

- `dimensionColumns`: string[] (required) — The columns that query runners are allowed to select, group by, or filter by.

- `joinColumns`: string[] (required) — Columns in configured table that can be used in join statements and/or as aggregate columns.

  They can never be outputted directly.

- `joinRequired`: string — Control that requires member who runs query to do a join with their configured table and/or other configured table in query.

- `outputConstraints`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnConfiguredTable.AggregationConstraintProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_cleanrooms.CfnConfiguredTable.AggregationConstraintProperty.html)[] (required) — Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

- `scalarFunctions`: string[] (required) — Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.