Package software.amazon.awscdk.mixins.preview.services.cleanrooms.mixins

Interface CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty.Jsii$Proxy

Enclosing class:

CfnConfiguredTablePropsMixin

@Stability(Stable)
public static interface CfnConfiguredTablePropsMixin.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.mixins.preview.services.cleanrooms.mixins.*;
 AnalysisRuleAggregationProperty analysisRuleAggregationProperty = AnalysisRuleAggregationProperty.builder()
         .additionalAnalyses("additionalAnalyses")
         .aggregateColumns(List.of(AggregateColumnProperty.builder()
                 .columnNames(List.of("columnNames"))
                 .function("function")
                 .build()))
         .allowedJoinOperators(List.of("allowedJoinOperators"))
         .dimensionColumns(List.of("dimensionColumns"))
         .joinColumns(List.of("joinColumns"))
         .joinRequired("joinRequired")
         .outputConstraints(List.of(AggregationConstraintProperty.builder()
                 .columnName("columnName")
                 .minimum(123)
                 .type("type")
                 .build()))
         .scalarFunctions(List.of("scalarFunctions"))
         .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	CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty.Builder	A builder for CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty
static final class	CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty.Jsii$Proxy	An implementation for CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty

Method Summary

Modifier and Type	Method	Description
static CfnConfiguredTablePropsMixin.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.
default 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.
default List<String>	getDimensionColumns()	The columns that query runners are allowed to select, group by, or filter by.
default 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.
default 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.
default 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

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

getAggregateColumns

@Stability(Stable)
@Nullable
default Object getAggregateColumns()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnConfiguredTablePropsMixin.AggregateColumnProperty>

See Also:

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

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

getDimensionColumns

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

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

getOutputConstraints

@Stability(Stable)
@Nullable
default 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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnConfiguredTablePropsMixin.AggregationConstraintProperty>

See Also:

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

getScalarFunctions

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty.Builder of CfnConfiguredTablePropsMixin.AnalysisRuleAggregationProperty