Package software.amazon.awscdk.services.cleanrooms

Interface CfnConfiguredTable.AnalysisRuleCustomProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConfiguredTable.AnalysisRuleCustomProperty.Jsii$Proxy

Enclosing class:

CfnConfiguredTable

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

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.

It supports differential privacy.

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.*;
 AnalysisRuleCustomProperty analysisRuleCustomProperty = AnalysisRuleCustomProperty.builder()
         .allowedAnalyses(List.of("allowedAnalyses"))
         // the properties below are optional
         .additionalAnalyses("additionalAnalyses")
         .aggregationThresholds(List.of(AggregationThresholdProperty.builder()
                 .allowedAggregateExpressionType("allowedAggregateExpressionType")
                 .identityColumns(List.of("identityColumns"))
                 .minimumIdentityCount(123)
                 .type("type")
                 // the properties below are optional
                 .outputColumnThresholds(List.of(OutputColumnThresholdProperty.builder()
                         .minimumIdentityCount(123)
                         .outputColumnName("outputColumnName")
                         .build()))
                 .build()))
         .allowedAnalysisProviders(List.of("allowedAnalysisProviders"))
         .comparisonControls(ComparisonControlsProperty.builder()
                 .allowedColumnComparisonColumns(List.of("allowedColumnComparisonColumns"))
                 .allowedLiteralComparisonColumns(List.of("allowedLiteralComparisonColumns"))
                 .build())
         .differentialPrivacy(DifferentialPrivacyProperty.builder()
                 .columns(List.of(DifferentialPrivacyColumnProperty.builder()
                         .name("name")
                         .build()))
                 .build())
         .disallowedOutputColumns(List.of("disallowedOutputColumns"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnConfiguredTable.AnalysisRuleCustomProperty.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	getAggregationThresholds()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnConfiguredTable.AggregationThresholdProperty>
List<String>	getAllowedAnalyses()	The ARN of the analysis templates that are allowed by the custom analysis rule.
default List<String>	getAllowedAnalysisProviders()	The IDs of the AWS accounts that are allowed to query by the custom analysis rule.
default Object	getComparisonControls()	Returns union: either IResolvable or CfnConfiguredTable.ComparisonControlsProperty
default Object	getDifferentialPrivacy()	The differential privacy configuration.
default List<String>	getDisallowedOutputColumns()	A list of columns that aren't allowed to be shown in the query output.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowedAnalyses

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

The ARN of the analysis templates that are allowed by the custom analysis rule.

See Also:

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

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.

See Also:

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

getAggregationThresholds

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnConfiguredTable.AggregationThresholdProperty>

See Also:

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

getAllowedAnalysisProviders

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

The IDs of the AWS accounts that are allowed to query by the custom analysis rule.

Required when allowedAnalyses is ANY_QUERY .

See Also:

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

getComparisonControls

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

Returns union: either IResolvable or CfnConfiguredTable.ComparisonControlsProperty

See Also:

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

getDifferentialPrivacy

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

The differential privacy configuration.

Returns union: either IResolvable or CfnConfiguredTable.DifferentialPrivacyProperty

See Also:

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

getDisallowedOutputColumns

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

A list of columns that aren't allowed to be shown in the query output.

See Also:

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

builder

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

Returns:

a CfnConfiguredTable.AnalysisRuleCustomProperty.Builder of CfnConfiguredTable.AnalysisRuleCustomProperty