interface LogicalTableProperty

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

A logical table is a unit that joins and that data transformations operate on.

A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.

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 logicalTableProperty: quicksight.CfnDataSet.LogicalTableProperty = {
  alias: 'alias',
  source: {
    dataSetArn: 'dataSetArn',
    joinInstruction: {
      leftOperand: 'leftOperand',
      onClause: 'onClause',
      rightOperand: 'rightOperand',
      type: 'type',

      // the properties below are optional
      leftJoinKeyProperties: {
        uniqueKey: false,
      },
      rightJoinKeyProperties: {
        uniqueKey: false,
      },
    },
    physicalTableId: 'physicalTableId',
  },

  // the properties below are optional
  dataTransforms: [{
    castColumnTypeOperation: {
      columnName: 'columnName',
      newColumnType: 'newColumnType',

      // the properties below are optional
      format: 'format',
    },
    createColumnsOperation: {
      columns: [{
        columnId: 'columnId',
        columnName: 'columnName',
        expression: 'expression',
      }],
    },
    filterOperation: {
      conditionExpression: 'conditionExpression',
    },
    overrideDatasetParameterOperation: {
      parameterName: 'parameterName',

      // the properties below are optional
      newDefaultValues: {
        dateTimeStaticValues: ['dateTimeStaticValues'],
        decimalStaticValues: [123],
        integerStaticValues: [123],
        stringStaticValues: ['stringStaticValues'],
      },
      newParameterName: 'newParameterName',
    },
    projectOperation: {
      projectedColumns: ['projectedColumns'],
    },
    renameColumnOperation: {
      columnName: 'columnName',
      newColumnName: 'newColumnName',
    },
    tagColumnOperation: {
      columnName: 'columnName',
      tags: [{
        columnDescription: {
          text: 'text',
        },
        columnGeographicRole: 'columnGeographicRole',
      }],
    },
  }],
};

Properties

Name	Type	Description
alias	string	A display name for the logical table.
source	IResolvable | LogicalTableSourceProperty	Source of this logical table.
dataTransforms?	IResolvable | IResolvable | TransformOperationProperty[]	Transform operations that act on this logical table.

---

alias

Type: string

A display name for the logical table.

---

source

Type: IResolvable | LogicalTableSourceProperty

Source of this logical table.

---

dataTransforms?

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

Transform operations that act on this logical table.

For this structure to be valid, only one of the attributes can be non-null.