interface SemanticModelConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnDataSet.SemanticModelConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSet_SemanticModelConfigurationProperty
Java	software.amazon.awscdk.services.quicksight.CfnDataSet.SemanticModelConfigurationProperty
Python	aws_cdk.aws_quicksight.CfnDataSet.SemanticModelConfigurationProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnDataSet » SemanticModelConfigurationProperty

Configuration for the semantic model that defines how prepared data is structured for analysis and reporting.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semanticmodelconfiguration.html

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

declare const tagRuleConfigurations: any;
const semanticModelConfigurationProperty: quicksight.CfnDataSet.SemanticModelConfigurationProperty = {
  semanticMetadata: [{
    customInstructions: [{
      inlineCustomInstruction: {
        instructionText: 'instructionText',

        // the properties below are optional
        uploadedDocumentMetadata: {
          name: 'name',
        },
      },
    }],
    description: {
      text: 'text',
    },
  }],
  tableMap: {
    tableMapKey: {
      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

Name	Type	Description
semanticMetadata?	IResolvable | (IResolvable | DataSetSemanticMetadataProperty)[]
tableMap?	IResolvable | { [string]: IResolvable | SemanticTableProperty }	A map of semantic tables that define the analytical structure.

---

semanticMetadata?

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semanticmodelconfiguration.html#cfn-quicksight-dataset-semanticmodelconfiguration-semanticmetadata

---

tableMap?

Type: IResolvable | { [string]: IResolvable | SemanticTableProperty } (optional)

A map of semantic tables that define the analytical structure.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-semanticmodelconfiguration.html#cfn-quicksight-dataset-semanticmodelconfiguration-tablemap