Skip to content
v2.275.0

ConfiguredTableAnalysisRulePolicyV1Property Struct ​

Controls on the query specifications that can be run on a configured table.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cleanrooms as cleanrooms } from 'aws-cdk-lib';
const configuredTableAnalysisRulePolicyV1Property: cleanrooms.CfnConfiguredTable.ConfiguredTableAnalysisRulePolicyV1Property = {
  aggregation: {
    aggregateColumns: [{
      columnNames: ['columnNames'],
      function: 'function',
    }],
    dimensionColumns: ['dimensionColumns'],
    joinColumns: ['joinColumns'],
    outputConstraints: [{
      columnName: 'columnName',
      minimum: 123,
      type: 'type',
    }],
    scalarFunctions: ['scalarFunctions'],

    // the properties below are optional
    additionalAnalyses: 'additionalAnalyses',
    allowedJoinOperators: ['allowedJoinOperators'],
    joinRequired: 'joinRequired',
  },
  custom: {
    allowedAnalyses: ['allowedAnalyses'],

    // the properties below are optional
    additionalAnalyses: 'additionalAnalyses',
    aggregationThresholds: [{
      allowedAggregateExpressionType: 'allowedAggregateExpressionType',
      identityColumns: ['identityColumns'],
      minimumIdentityCount: 123,
      type: 'type',

      // the properties below are optional
      outputColumnThresholds: [{
        minimumIdentityCount: 123,
        outputColumnName: 'outputColumnName',
      }],
    }],
    allowedAnalysisProviders: ['allowedAnalysisProviders'],
    comparisonControls: {
      allowedColumnComparisonColumns: ['allowedColumnComparisonColumns'],
      allowedLiteralComparisonColumns: ['allowedLiteralComparisonColumns'],
    },
    differentialPrivacy: {
      columns: [{
        name: 'name',
      }],
    },
    disallowedOutputColumns: ['disallowedOutputColumns'],
  },
  list: {
    joinColumns: ['joinColumns'],
    listColumns: ['listColumns'],

    // the properties below are optional
    additionalAnalyses: 'additionalAnalyses',
    allowedJoinOperators: ['allowedJoinOperators'],
  },
};

Properties ​

aggregationoptionalIResolvable | CfnConfiguredTable.AnalysisRuleAggregationPropertyaggregationoptionaltyping.Union[IResolvable, AnalysisRuleAggregationProperty]aggregationoptionalIResolvableAggregationoptionalIResolvableAggregationoptionalinterface{}#
Analysis rule type that enables only aggregation queries on a configured table.
customoptionalIResolvable | CfnConfiguredTable.AnalysisRuleCustomPropertycustomoptionaltyping.Union[IResolvable, AnalysisRuleCustomProperty]customoptionalIResolvableCustomoptionalIResolvableCustomoptionalinterface{}#
Analysis rule type that enables custom SQL queries on a configured table.
listoptionalIResolvable | CfnConfiguredTable.AnalysisRuleListPropertylistoptionaltyping.Union[IResolvable, AnalysisRuleListProperty]listoptionalIResolvableListoptionalIResolvableListoptionalinterface{}#
Analysis rule type that enables only list queries on a configured table.