aws-cdk-lib.aws_quicksight.CfnDataSet.PhysicalTableProperty

interface PhysicalTableProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnDataSet.PhysicalTableProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSet_PhysicalTableProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnDataSet.PhysicalTableProperty
Pythonaws_cdk.aws_quicksight.CfnDataSet.PhysicalTableProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnDataSet » PhysicalTableProperty

A view of a data source that contains information about the shape of the data in the underlying source.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const physicalTableProperty: quicksight.CfnDataSet.PhysicalTableProperty = {
  customSql: {
    columns: [{
      name: 'name',
      type: 'type',
    }],
    dataSourceArn: 'dataSourceArn',
    name: 'name',
    sqlQuery: 'sqlQuery',
  },
  relationalTable: {
    dataSourceArn: 'dataSourceArn',
    inputColumns: [{
      name: 'name',
      type: 'type',
    }],
    name: 'name',

    // the properties below are optional
    catalog: 'catalog',
    schema: 'schema',
  },
  s3Source: {
    dataSourceArn: 'dataSourceArn',
    inputColumns: [{
      name: 'name',
      type: 'type',
    }],

    // the properties below are optional
    uploadSettings: {
      containsHeader: false,
      delimiter: 'delimiter',
      format: 'format',
      startFromRow: 123,
      textQualifier: 'textQualifier',
    },
  },
};

Properties

NameTypeDescription
customSql?IResolvable | CustomSqlPropertyA physical table type built from the results of the custom SQL query.
relationalTable?IResolvable | RelationalTablePropertyA physical table type for relational data sources.
s3Source?IResolvable | S3SourcePropertyA physical table type for as S3 data source.

customSql?

Type: IResolvable | CustomSqlProperty (optional)

A physical table type built from the results of the custom SQL query.


relationalTable?

Type: IResolvable | RelationalTableProperty (optional)

A physical table type for relational data sources.


s3Source?

Type: IResolvable | S3SourceProperty (optional)

A physical table type for as S3 data source.