interface CfnConfiguredTableMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CleanRooms.Mixins.CfnConfiguredTableMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscleanrooms/mixins#CfnConfiguredTableMixinProps
Java	software.amazon.awscdk.mixins.preview.services.cleanrooms.mixins.CfnConfiguredTableMixinProps
Python	aws_cdk.mixins_preview.aws_cleanrooms.mixins.CfnConfiguredTableMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_cleanrooms » mixins » CfnConfiguredTableMixinProps

Properties for CfnConfiguredTablePropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cleanrooms_mixins } from '@aws-cdk/mixins-preview/aws-cleanrooms';
const cfnConfiguredTableMixinProps: cleanrooms_mixins.CfnConfiguredTableMixinProps = {
  allowedColumns: ['allowedColumns'],
  analysisMethod: 'analysisMethod',
  analysisRules: [{
    policy: {
      v1: {
        aggregation: {
          additionalAnalyses: 'additionalAnalyses',
          aggregateColumns: [{
            columnNames: ['columnNames'],
            function: 'function',
          }],
          allowedJoinOperators: ['allowedJoinOperators'],
          dimensionColumns: ['dimensionColumns'],
          joinColumns: ['joinColumns'],
          joinRequired: 'joinRequired',
          outputConstraints: [{
            columnName: 'columnName',
            minimum: 123,
            type: 'type',
          }],
          scalarFunctions: ['scalarFunctions'],
        },
        custom: {
          additionalAnalyses: 'additionalAnalyses',
          allowedAnalyses: ['allowedAnalyses'],
          allowedAnalysisProviders: ['allowedAnalysisProviders'],
          differentialPrivacy: {
            columns: [{
              name: 'name',
            }],
          },
          disallowedOutputColumns: ['disallowedOutputColumns'],
        },
        list: {
          additionalAnalyses: 'additionalAnalyses',
          allowedJoinOperators: ['allowedJoinOperators'],
          joinColumns: ['joinColumns'],
          listColumns: ['listColumns'],
        },
      },
    },
    type: 'type',
  }],
  description: 'description',
  name: 'name',
  selectedAnalysisMethods: ['selectedAnalysisMethods'],
  tableReference: {
    athena: {
      databaseName: 'databaseName',
      outputLocation: 'outputLocation',
      region: 'region',
      tableName: 'tableName',
      workGroup: 'workGroup',
    },
    glue: {
      databaseName: 'databaseName',
      region: 'region',
      tableName: 'tableName',
    },
    snowflake: {
      accountIdentifier: 'accountIdentifier',
      databaseName: 'databaseName',
      schemaName: 'schemaName',
      secretArn: 'secretArn',
      tableName: 'tableName',
      tableSchema: {
        v1: [{
          columnName: 'columnName',
          columnType: 'columnType',
        }],
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

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

---

allowedColumns?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-allowedcolumns

---

analysisMethod?

Type: string (optional)

The analysis method for the configured table.

DIRECT_QUERY allows SQL queries to be run directly on this table.

DIRECT_JOB allows PySpark jobs to be run directly on this table.

MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-analysismethod

---

analysisRules?

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

The analysis rule that was created for the configured table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-analysisrules

---

description?

Type: string (optional)

A description for the configured table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-description

---

name?

Type: string (optional)

A name for the configured table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-name

---

selectedAnalysisMethods?

Type: string[] (optional)

The selected analysis methods for the configured table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-selectedanalysismethods

---

tableReference?

Type: IResolvable | TableReferenceProperty (optional)

The table that this configured table represents.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-tablereference

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cleanrooms-configuredtable.html#cfn-cleanrooms-configuredtable-tags