Interface CfnConfiguredTable.IAnalysisRuleAggregationProperty

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

Namespace: Amazon.CDK.AwsCleanrooms

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnConfiguredTable.IAnalysisRuleAggregationProperty

Syntax (vb)

Public Interface CfnConfiguredTable.IAnalysisRuleAggregationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Aws_cleanrooms;

             var analysisRuleAggregationProperty = new AnalysisRuleAggregationProperty {
                 AggregateColumns = new [] { new AggregateColumnProperty {
                     ColumnNames = new [] { "columnNames" },
                     Function = "function"
                 } },
                 DimensionColumns = new [] { "dimensionColumns" },
                 JoinColumns = new [] { "joinColumns" },
                 OutputConstraints = new [] { new AggregationConstraintProperty {
                     ColumnName = "columnName",
                     Minimum = 123,
                     Type = "type"
                 } },
                 ScalarFunctions = new [] { "scalarFunctions" },

                 // the properties below are optional
                 AdditionalAnalyses = "additionalAnalyses",
                 AllowedJoinOperators = new [] { "allowedJoinOperators" },
                 JoinRequired = "joinRequired"
             };

Synopsis

Properties

AdditionalAnalyses	An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.
AggregateColumns	The columns that query runners are allowed to use in aggregation queries.
AllowedJoinOperators	Which logical operators (if any) are to be used in an INNER JOIN match condition.
DimensionColumns	The columns that query runners are allowed to select, group by, or filter by.
JoinColumns	Columns in configured table that can be used in join statements and/or as aggregate columns.
JoinRequired	Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
OutputConstraints	Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
ScalarFunctions	Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

Properties

AdditionalAnalyses

An indicator as to whether additional analyses (such as AWS Clean Rooms ML) can be applied to the output of the direct query.

string? AdditionalAnalyses { get; }

Property Value

string

Remarks

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

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