Package software.amazon.awscdk.services.cleanrooms

Interface CfnConfiguredTable.AnalysisRuleAggregationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfiguredTable.AnalysisRuleAggregationProperty.Jsii$Proxy

Enclosing class:

CfnConfiguredTable

@Stability(Stable)
public static interface CfnConfiguredTable.AnalysisRuleAggregationProperty
extends software.amazon.jsii.JsiiSerializable

A type of analysis rule that 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 software.amazon.awscdk.services.cleanrooms.*;
 AnalysisRuleAggregationProperty analysisRuleAggregationProperty = AnalysisRuleAggregationProperty.builder()
         .aggregateColumns(List.of(AggregateColumnProperty.builder()
                 .columnNames(List.of("columnNames"))
                 .function("function")
                 .build()))
         .dimensionColumns(List.of("dimensionColumns"))
         .joinColumns(List.of("joinColumns"))
         .outputConstraints(List.of(AggregationConstraintProperty.builder()
                 .columnName("columnName")
                 .minimum(123)
                 .type("type")
                 .build()))
         .scalarFunctions(List.of("scalarFunctions"))
         // the properties below are optional
         .additionalAnalyses("additionalAnalyses")
         .allowedJoinOperators(List.of("allowedJoinOperators"))
         .joinRequired("joinRequired")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConfiguredTable.AnalysisRuleAggregationProperty.Builder	A builder for CfnConfiguredTable.AnalysisRuleAggregationProperty
static final class	CfnConfiguredTable.AnalysisRuleAggregationProperty.Jsii$Proxy	An implementation for CfnConfiguredTable.AnalysisRuleAggregationProperty

Method Summary

Modifier and Type	Method	Description
static CfnConfiguredTable.AnalysisRuleAggregationProperty.Builder	builder()
default String	getAdditionalAnalyses()	An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.
Object	getAggregateColumns()	The columns that query runners are allowed to use in aggregation queries.
default List<String>	getAllowedJoinOperators()	Which logical operators (if any) are to be used in an INNER JOIN match condition.
List<String>	getDimensionColumns()	The columns that query runners are allowed to select, group by, or filter by.
List<String>	getJoinColumns()	Columns in configured table that can be used in join statements and/or as aggregate columns.
default String	getJoinRequired()	Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
Object	getOutputConstraints()	Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
List<String>	getScalarFunctions()	Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregateColumns

@Stability(Stable)
@NotNull
Object getAggregateColumns()

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

getDimensionColumns

@Stability(Stable)
@NotNull
List<String> getDimensionColumns()

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

getJoinColumns

@Stability(Stable)
@NotNull
List<String> getJoinColumns()

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

getOutputConstraints

@Stability(Stable)
@NotNull
Object getOutputConstraints()

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

getScalarFunctions

@Stability(Stable)
@NotNull
List<String> getScalarFunctions()

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

getAdditionalAnalyses

@Stability(Stable)
@Nullable
default String getAdditionalAnalyses()

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

getAllowedJoinOperators

@Stability(Stable)
@Nullable
default List<String> getAllowedJoinOperators()

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

getJoinRequired

@Stability(Stable)
@Nullable
default String getJoinRequired()

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

builder

@Stability(Stable)
static CfnConfiguredTable.AnalysisRuleAggregationProperty.Builder builder()

Returns:

a CfnConfiguredTable.AnalysisRuleAggregationProperty.Builder of CfnConfiguredTable.AnalysisRuleAggregationProperty