Skip to content
v2.273.0

SemanticTableProperty Struct ​

A semantic table that represents the final analytical structure of the data.

Example ​

ts
// 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';

declare const tagRuleConfigurations: any;
const semanticTableProperty: quicksight.CfnDataSet.SemanticTableProperty = {
  alias: 'alias',
  destinationTableId: 'destinationTableId',

  // the properties below are optional
  rowLevelPermissionConfiguration: {
    rowLevelPermissionDataSet: {
      arn: 'arn',
      permissionPolicy: 'permissionPolicy',

      // the properties below are optional
      formatVersion: 'formatVersion',
      namespace: 'namespace',
      status: 'status',
    },
    tagConfiguration: {
      tagRules: [{
        columnName: 'columnName',
        tagKey: 'tagKey',

        // the properties below are optional
        matchAllValue: 'matchAllValue',
        tagMultiValueDelimiter: 'tagMultiValueDelimiter',
      }],

      // the properties below are optional
      status: 'status',
      tagRuleConfigurations: tagRuleConfigurations,
    },
  },
  semanticMetadata: {
    columnMetadata: [{
      columnProperties: [{
        additionalNotes: {
          text: 'text',
        },
        description: {
          text: 'text',
        },
        semanticType: {
          geographicalRole: 'geographicalRole',
        },
      }],

      // the properties below are optional
      columnNames: ['columnNames'],
    }],
  },
};

Properties ​

aliasstringaliasstraliasStringAliasstringAlias*stringrequired#
Alias for the semantic table.
destinationTableIdstringdestination_table_idstrdestinationTableIdStringDestinationTableIdstringDestinationTableId*stringrequired#
The identifier of the destination table from data preparation that provides data to this semantic table.
rowLevelPermissionConfigurationIResolvable | CfnDataSet.RowLevelPermissionConfigurationPropertyrow_level_permission_configurationtyping.Union[IResolvable, RowLevelPermissionConfigurationProperty]rowLevelPermissionConfigurationIResolvableRowLevelPermissionConfigurationIResolvableRowLevelPermissionConfigurationinterface{}#
Configuration for row level security that control data access for this semantic table.
semanticMetadataIResolvable | CfnDataSet.TableSemanticMetadataPropertysemantic_metadatatyping.Union[IResolvable, TableSemanticMetadataProperty]semanticMetadataIResolvableSemanticMetadataIResolvableSemanticMetadatainterface{}#