AWS::CleanRooms::ConfiguredTable AnalysisRuleCustom

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy, minimum aggregation thresholds, and comparison controls.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON


{
  "AdditionalAnalyses" : String,
  "AggregationThresholds" : [ AggregationThreshold, ... ],
  "AllowedAnalyses" : [ String, ... ],
  "AllowedAnalysisProviders" : [ String, ... ],
  "ComparisonControls" : ComparisonControls,
  "DifferentialPrivacy" : DifferentialPrivacy,
  "DisallowedOutputColumns" : [ String, ... ]
}

YAML


  AdditionalAnalyses: String
  AggregationThresholds: 
    - AggregationThreshold
  AllowedAnalyses: 
    - String
  AllowedAnalysisProviders: 
    - String
  ComparisonControls: 
    ComparisonControls
  DifferentialPrivacy: 
    DifferentialPrivacy
  DisallowedOutputColumns: 
    - String

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.

Required: No

Type: String

Allowed values: ALLOWED | REQUIRED | NOT_ALLOWED

Update requires: No interruption

AggregationThresholds

The aggregation thresholds that each query output group must satisfy. AWS Clean Rooms filters out any group that represents fewer than the specified number of distinct identities. You can specify at most one threshold. You can't use aggregation thresholds with differential privacy, or when allowedAnalyses allows only jobs.

Required: No

Type: Array of AggregationThreshold

Minimum: 1

Maximum: 1

Update requires: No interruption

AllowedAnalyses

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

Required: Yes

Type: Array of String

Minimum: 0

Update requires: No interruption

AllowedAnalysisProviders

The IDs of the AWS accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.

Required: No

Type: Array of String

Minimum: 0

Update requires: No interruption

ComparisonControls

The controls that restrict how a query can compare the columns in the configured table. You can't use comparison controls with differential privacy, or when allowedAnalyses allows only jobs.

Required: No

Type: ComparisonControls

Update requires: No interruption

DifferentialPrivacy