interface CfnConfiguredTableProps

Language	Type name
.NET	`Amazon.CDK.aws_cleanrooms.CfnConfiguredTableProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscleanrooms#CfnConfiguredTableProps`
Java	`software.amazon.awscdk.services.cleanrooms.CfnConfiguredTableProps`
Python	`aws_cdk.aws_cleanrooms.CfnConfiguredTableProps`
TypeScript	`aws-cdk-lib` » `aws_cleanrooms` » `CfnConfiguredTableProps`

Properties for defining a CfnConfiguredTable.

Example

// 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 cfnConfiguredTableProps: cleanrooms.CfnConfiguredTableProps = {
  allowedColumns: ['allowedColumns'],
  analysisMethod: 'analysisMethod',
  name: 'name',
  tableReference: {
    athena: {
      databaseName: 'databaseName',
      tableName: 'tableName',
      workGroup: 'workGroup',

      // the properties below are optional
      outputLocation: 'outputLocation',
    },
    glue: {
      databaseName: 'databaseName',
      tableName: 'tableName',
    },
    snowflake: {
      accountIdentifier: 'accountIdentifier',
      databaseName: 'databaseName',
      schemaName: 'schemaName',
      secretArn: 'secretArn',
      tableName: 'tableName',
      tableSchema: {
        v1: [{
          columnName: 'columnName',
          columnType: 'columnType',
        }],
      },
    },
  },

  // the properties below are optional
  analysisRules: [{
    policy: {
      v1: {
        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',
          allowedAnalysisProviders: ['allowedAnalysisProviders'],
          differentialPrivacy: {
            columns: [{
              name: 'name',
            }],
          },
          disallowedOutputColumns: ['disallowedOutputColumns'],
        },
        list: {
          joinColumns: ['joinColumns'],
          listColumns: ['listColumns'],

          // the properties below are optional
          additionalAnalyses: 'additionalAnalyses',
          allowedJoinOperators: ['allowedJoinOperators'],
        },
      },
    },
    type: 'type',
  }],
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
allowedColumns	`string[]`	The columns within the underlying AWS Glue table that can be utilized within collaborations.
analysisMethod	`string`	The analysis method for the configured table.
name	`string`	A name for the configured table.
tableReference	`IResolvable` `\|` `TableReferenceProperty`	The table that this configured table represents.
analysisRules?	`IResolvable` `\|` `IResolvable` `\|` `AnalysisRuleProperty[]`	The analysis rule that was created for the configured table.
description?	`string`	A description for the configured table.
tags?	`CfnTag[]`	An optional label that you can assign to a resource when you create it.

allowedColumns

Type: string[]

The columns within the underlying AWS Glue table that can be utilized within collaborations.

analysisMethod

Type: string

The analysis method for the configured table.

The only valid value is currently DIRECT_QUERY.

name

Type: string

A name for the configured table.

tableReference

Type: IResolvable | TableReferenceProperty

The table that this configured table represents.

analysisRules?

Type: IResolvable | IResolvable | AnalysisRuleProperty[] (optional)

The analysis rule that was created for the configured table.

description?

Type: string (optional)

A description for the configured table.

tags?

Type: CfnTag[] (optional)

An optional label that you can assign to a resource when you create it.

Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.