aws-cdk-lib.aws_cleanrooms.CfnConfiguredTableProps

interface CfnConfiguredTableProps

LanguageType name
.NETAmazon.CDK.aws_cleanrooms.CfnConfiguredTableProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscleanrooms#CfnConfiguredTableProps
Javaservices.cleanrooms.CfnConfiguredTableProps
Pythonaws_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: {
    glue: {
      databaseName: 'databaseName',
      tableName: 'tableName',
    },
  },

  // 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
          joinRequired: 'joinRequired',
        },
        list: {
          joinColumns: ['joinColumns'],
          listColumns: ['listColumns'],
        },
      },
    },
    type: 'type',
  }],
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
allowedColumnsstring[]The columns within the underlying AWS Glue table that can be utilized within collaborations.
analysisMethodstringThe analysis method for the configured table.
namestringA name for the configured table.
tableReferenceIResolvable | TableReferencePropertyThe AWS Glue table that this configured table represents.
analysisRules?IResolvable | IResolvable | AnalysisRuleProperty[]The entire created analysis rule.
description?stringA 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 AWS Glue table that this configured table represents.


analysisRules?

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

The entire created analysis rule.


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.