aws-cdk-lib.aws_cleanrooms.CfnConfiguredTable.AnalysisRuleAggregationProperty

interface AnalysisRuleAggregationProperty

LanguageType name
.NETAmazon.CDK.aws_cleanrooms.CfnConfiguredTable.AnalysisRuleAggregationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscleanrooms#CfnConfiguredTable_AnalysisRuleAggregationProperty
Javaservices.cleanrooms.CfnConfiguredTable.AnalysisRuleAggregationProperty
Pythonaws_cdk.aws_cleanrooms.CfnConfiguredTable.AnalysisRuleAggregationProperty
TypeScript aws-cdk-lib » aws_cleanrooms » CfnConfiguredTable » AnalysisRuleAggregationProperty

Enables query structure and specified queries that produce aggregate statistics.

Example

// 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
  joinRequired: 'joinRequired',
};

Properties

NameTypeDescription
aggregateColumnsIResolvable | IResolvable | AggregateColumnProperty[]The columns that query runners are allowed to use in aggregation queries.
dimensionColumnsstring[]The columns that query runners are allowed to select, group by, or filter by.
joinColumnsstring[]Columns in configured table that can be used in join statements and/or as aggregate columns.
outputConstraintsIResolvable | IResolvable | AggregationConstraintProperty[]Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
scalarFunctionsstring[]Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
joinRequired?stringControl that requires member who runs query to do a join with their configured table and/or other configured table in query.

aggregateColumns

Type: IResolvable | IResolvable | AggregateColumnProperty[]

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


dimensionColumns

Type: string[]

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


joinColumns

Type: string[]

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

They can never be outputted directly.


outputConstraints

Type: IResolvable | IResolvable | AggregationConstraintProperty[]

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


scalarFunctions

Type: string[]

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


joinRequired?

Type: string (optional)

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