Skip to content
v2.277.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'],
    }],
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

# tag_rule_configurations: Any

semantic_table_property = quicksight.CfnDataSet.SemanticTableProperty(
    alias="alias",
    destination_table_id="destinationTableId",

    # the properties below are optional
    row_level_permission_configuration=quicksight.CfnDataSet.RowLevelPermissionConfigurationProperty(
        row_level_permission_data_set=quicksight.CfnDataSet.RowLevelPermissionDataSetProperty(
            arn="arn",
            permission_policy="permissionPolicy",

            # the properties below are optional
            format_version="formatVersion",
            namespace="namespace",
            status="status"
        ),
        tag_configuration=quicksight.CfnDataSet.RowLevelPermissionTagConfigurationProperty(
            tag_rules=[quicksight.CfnDataSet.RowLevelPermissionTagRuleProperty(
                column_name="columnName",
                tag_key="tagKey",

                # the properties below are optional
                match_all_value="matchAllValue",
                tag_multi_value_delimiter="tagMultiValueDelimiter"
            )],

            # the properties below are optional
            status="status",
            tag_rule_configurations=tag_rule_configurations
        )
    ),
    semantic_metadata=quicksight.CfnDataSet.TableSemanticMetadataProperty(
        column_metadata=[quicksight.CfnDataSet.SharedColumnSemanticMetadataProperty(
            column_properties=[quicksight.CfnDataSet.ColumnSemanticPropertyProperty(
                additional_notes=quicksight.CfnDataSet.AdditionalNotesProperty(
                    text="text"
                ),
                description=quicksight.CfnDataSet.ColumnDescriptionProperty(
                    text="text"
                ),
                semantic_type=quicksight.CfnDataSet.ColumnSemanticTypeProperty(
                    geographical_role="geographicalRole"
                )
            )],

            # the properties below are optional
            column_names=["columnNames"]
        )]
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

Object tagRuleConfigurations;

SemanticTableProperty semanticTableProperty = SemanticTableProperty.builder()
        .alias("alias")
        .destinationTableId("destinationTableId")

        // the properties below are optional
        .rowLevelPermissionConfiguration(RowLevelPermissionConfigurationProperty.builder()
                .rowLevelPermissionDataSet(RowLevelPermissionDataSetProperty.builder()
                        .arn("arn")
                        .permissionPolicy("permissionPolicy")

                        // the properties below are optional
                        .formatVersion("formatVersion")
                        .namespace("namespace")
                        .status("status")
                        .build())
                .tagConfiguration(RowLevelPermissionTagConfigurationProperty.builder()
                        .tagRules(List.of(RowLevelPermissionTagRuleProperty.builder()
                                .columnName("columnName")
                                .tagKey("tagKey")

                                // the properties below are optional
                                .matchAllValue("matchAllValue")
                                .tagMultiValueDelimiter("tagMultiValueDelimiter")
                                .build()))

                        // the properties below are optional
                        .status("status")
                        .tagRuleConfigurations(tagRuleConfigurations)
                        .build())
                .build())
        .semanticMetadata(TableSemanticMetadataProperty.builder()
                .columnMetadata(List.of(SharedColumnSemanticMetadataProperty.builder()
                        .columnProperties(List.of(ColumnSemanticPropertyProperty.builder()
                                .additionalNotes(AdditionalNotesProperty.builder()
                                        .text("text")
                                        .build())
                                .description(ColumnDescriptionProperty.builder()
                                        .text("text")
                                        .build())
                                .semanticType(ColumnSemanticTypeProperty.builder()
                                        .geographicalRole("geographicalRole")
                                        .build())
                                .build()))

                        // the properties below are optional
                        .columnNames(List.of("columnNames"))
                        .build()))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var tagRuleConfigurations;

var semanticTableProperty = new SemanticTableProperty {
    Alias = "alias",
    DestinationTableId = "destinationTableId",

    // the properties below are optional
    RowLevelPermissionConfiguration = new RowLevelPermissionConfigurationProperty {
        RowLevelPermissionDataSet = new RowLevelPermissionDataSetProperty {
            Arn = "arn",
            PermissionPolicy = "permissionPolicy",

            // the properties below are optional
            FormatVersion = "formatVersion",
            Namespace = "namespace",
            Status = "status"
        },
        TagConfiguration = new RowLevelPermissionTagConfigurationProperty {
            TagRules = new [] { new RowLevelPermissionTagRuleProperty {
                ColumnName = "columnName",
                TagKey = "tagKey",

                // the properties below are optional
                MatchAllValue = "matchAllValue",
                TagMultiValueDelimiter = "tagMultiValueDelimiter"
            } },

            // the properties below are optional
            Status = "status",
            TagRuleConfigurations = tagRuleConfigurations
        }
    },
    SemanticMetadata = new TableSemanticMetadataProperty {
        ColumnMetadata = new [] { new SharedColumnSemanticMetadataProperty {
            ColumnProperties = new [] { new ColumnSemanticPropertyProperty {
                AdditionalNotes = new AdditionalNotesProperty {
                    Text = "text"
                },
                Description = new ColumnDescriptionProperty {
                    Text = "text"
                },
                SemanticType = new ColumnSemanticTypeProperty {
                    GeographicalRole = "geographicalRole"
                }
            } },

            // the properties below are optional
            ColumnNames = new [] { "columnNames" }
        } }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var tagRuleConfigurations interface{}

semanticTableProperty := &SemanticTableProperty{
	Alias: jsii.String("alias"),
	DestinationTableId: jsii.String("destinationTableId"),

	// the properties below are optional
	RowLevelPermissionConfiguration: &RowLevelPermissionConfigurationProperty{
		RowLevelPermissionDataSet: &RowLevelPermissionDataSetProperty{
			Arn: jsii.String("arn"),
			PermissionPolicy: jsii.String("permissionPolicy"),

			// the properties below are optional
			FormatVersion: jsii.String("formatVersion"),
			Namespace: jsii.String("namespace"),
			Status: jsii.String("status"),
		},
		TagConfiguration: &RowLevelPermissionTagConfigurationProperty{
			TagRules: []interface{}{
				&RowLevelPermissionTagRuleProperty{
					ColumnName: jsii.String("columnName"),
					TagKey: jsii.String("tagKey"),

					// the properties below are optional
					MatchAllValue: jsii.String("matchAllValue"),
					TagMultiValueDelimiter: jsii.String("tagMultiValueDelimiter"),
				},
			},

			// the properties below are optional
			Status: jsii.String("status"),
			TagRuleConfigurations: tagRuleConfigurations,
		},
	},
	SemanticMetadata: &TableSemanticMetadataProperty{
		ColumnMetadata: []interface{}{
			&SharedColumnSemanticMetadataProperty{
				ColumnProperties: []interface{}{
					&ColumnSemanticPropertyProperty{
						AdditionalNotes: &AdditionalNotesProperty{
							Text: jsii.String("text"),
						},
						Description: &ColumnDescriptionProperty{
							Text: jsii.String("text"),
						},
						SemanticType: &ColumnSemanticTypeProperty{
							GeographicalRole: jsii.String("geographicalRole"),
						},
					},
				},

				// the properties below are optional
				ColumnNames: []*string{
					jsii.String("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.
rowLevelPermissionConfigurationoptionalIResolvable | CfnDataSet.RowLevelPermissionConfigurationPropertyrow_level_permission_configurationoptionaltyping.Union[IResolvable, RowLevelPermissionConfigurationProperty]rowLevelPermissionConfigurationoptionalIResolvableRowLevelPermissionConfigurationoptionalIResolvableRowLevelPermissionConfigurationoptionalinterface{}#
Configuration for row level security that control data access for this semantic table.
semanticMetadataoptionalIResolvable | CfnDataSet.TableSemanticMetadataPropertysemantic_metadataoptionaltyping.Union[IResolvable, TableSemanticMetadataProperty]semanticMetadataoptionalIResolvableSemanticMetadataoptionalIResolvableSemanticMetadataoptionalinterface{}#