interface RelationalTableProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDataSet.RelationalTableProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDataSet.RelationalTableProperty`
Python	`aws_cdk.aws_quicksight.CfnDataSet.RelationalTableProperty`
TypeScript	`@aws-cdk/aws-quicksight` » `CfnDataSet` » `RelationalTableProperty`

A physical table type for relational data sources.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const relationalTableProperty: quicksight.CfnDataSet.RelationalTableProperty = {
  dataSourceArn: 'dataSourceArn',
  inputColumns: [{
    name: 'name',
    type: 'type',
  }],
  name: 'name',

  // the properties below are optional
  catalog: 'catalog',
  schema: 'schema',
};

Properties

Name	Type	Description
dataSourceArn	`string`	The Amazon Resource Name (ARN) for the data source.
inputColumns	`IResolvable` `\|` `IResolvable` `\|` `InputColumnProperty[]`	The column schema of the table.
name	`string`	The name of the relational table.
catalog?	`string`	`CfnDataSet.RelationalTableProperty.Catalog`.
schema?	`string`	The schema name.

dataSourceArn

Type: string

The Amazon Resource Name (ARN) for the data source.

inputColumns

Type: IResolvable | IResolvable | InputColumnProperty[]

The column schema of the table.

name

Type: string

The name of the relational table.

catalog?

Type: string (optional)

CfnDataSet.RelationalTableProperty.Catalog.

schema?

Type: string (optional)

The schema name.

This name applies to certain relational database engines.