interface AnalysisRuleAggregationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CleanRooms.Mixins.CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscleanrooms/mixins#CfnConfiguredTablePropsMixin_AnalysisRuleAggregationProperty
Java	software.amazon.awscdk.mixins.preview.services.cleanrooms.mixins.CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty
Python	aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty
TypeScript	@aws-cdk/mixins-preview » aws_cleanrooms » mixins » CfnConfiguredTablePropsMixin » AnalysisRuleAggregationProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cleanrooms_mixins } from '@aws-cdk/mixins-preview/aws-cleanrooms';
const analysisRuleAggregationProperty: cleanrooms_mixins.CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty = {
  additionalAnalyses: 'additionalAnalyses',
  aggregateColumns: [{
    columnNames: ['columnNames'],
    function: 'function',
  }],
  allowedJoinOperators: ['allowedJoinOperators'],
  dimensionColumns: ['dimensionColumns'],
  joinColumns: ['joinColumns'],
  joinRequired: 'joinRequired',
  outputConstraints: [{
    columnName: 'columnName',
    minimum: 123,
    type: 'type',
  }],
  scalarFunctions: ['scalarFunctions'],
};

Properties

Name	Type	Description
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.
aggregateColumns?	IResolvable | (IResolvable | AggregateColumnProperty)[]	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.
dimensionColumns?	string[]	The columns that query runners are allowed to select, group by, or filter by.
joinColumns?	string[]	Columns in configured table that can be used in join statements and/or as aggregate columns.
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 | (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?	string[]	Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

---

additionalAnalyses?

Type: string (optional)

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 ).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-additionalanalyses

---

aggregateColumns?

Type: IResolvable | (IResolvable | AggregateColumnProperty)[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-aggregatecolumns

---

allowedJoinOperators?

Type: string[] (optional)

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

Default is AND .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-allowedjoinoperators

---

dimensionColumns?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-dimensioncolumns

---

joinColumns?

Type: string[] (optional)

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

They can never be outputted directly.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-joincolumns

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-joinrequired

---

outputConstraints?

Type: IResolvable | (IResolvable | AggregationConstraintProperty)[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-outputconstraints

---

scalarFunctions?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cleanrooms-configuredtable-analysisruleaggregation.html#cfn-cleanrooms-configuredtable-analysisruleaggregation-scalarfunctions