SemanticModelConfigurationProperty Struct
Configuration for the semantic model that defines how prepared data is structured for analysis and reporting.
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 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'],
}],
},
},
},
};
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_model_configuration_property = quicksight.CfnDataSet.SemanticModelConfigurationProperty(
semantic_metadata=[quicksight.CfnDataSet.DataSetSemanticMetadataProperty(
custom_instructions=[quicksight.CfnDataSet.CustomInstructionProperty(
inline_custom_instruction=quicksight.CfnDataSet.InlineCustomInstructionProperty(
instruction_text="instructionText",
# the properties below are optional
uploaded_document_metadata=quicksight.CfnDataSet.UploadedDocumentMetadataProperty(
name="name"
)
)
)],
description=quicksight.CfnDataSet.DataSetSemanticDescriptionProperty(
text="text"
)
)],
table_map={
"table_map_key": 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;
SemanticModelConfigurationProperty semanticModelConfigurationProperty = SemanticModelConfigurationProperty.builder()
.semanticMetadata(List.of(DataSetSemanticMetadataProperty.builder()
.customInstructions(List.of(CustomInstructionProperty.builder()
.inlineCustomInstruction(InlineCustomInstructionProperty.builder()
.instructionText("instructionText")
// the properties below are optional
.uploadedDocumentMetadata(UploadedDocumentMetadataProperty.builder()
.name("name")
.build())
.build())
.build()))
.description(DataSetSemanticDescriptionProperty.builder()
.text("text")
.build())
.build()))
.tableMap(Map.of(
"tableMapKey", 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()))
.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 semanticModelConfigurationProperty = new SemanticModelConfigurationProperty {
SemanticMetadata = new [] { new DataSetSemanticMetadataProperty {
CustomInstructions = new [] { new CustomInstructionProperty {
InlineCustomInstruction = new InlineCustomInstructionProperty {
InstructionText = "instructionText",
// the properties below are optional
UploadedDocumentMetadata = new UploadedDocumentMetadataProperty {
Name = "name"
}
}
} },
Description = new DataSetSemanticDescriptionProperty {
Text = "text"
}
} },
TableMap = new Dictionary<string, object> {
{ "tableMapKey", 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{}
semanticModelConfigurationProperty := &SemanticModelConfigurationProperty{
SemanticMetadata: []interface{}{
&DataSetSemanticMetadataProperty{
CustomInstructions: []interface{}{
&CustomInstructionProperty{
InlineCustomInstruction: &InlineCustomInstructionProperty{
InstructionText: jsii.String("instructionText"),
// the properties below are optional
UploadedDocumentMetadata: &UploadedDocumentMetadataProperty{
Name: jsii.String("name"),
},
},
},
},
Description: &DataSetSemanticDescriptionProperty{
Text: jsii.String("text"),
},
},
},
TableMap: map[string]interface{}{
"tableMapKey": &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
semanticMetadataoptionalIResolvable | IResolvable | CfnDataSet.DataSetSemanticMetadataProperty[]semantic_metadataoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSetSemanticMetadataProperty]]]semanticMetadataoptionalIResolvableSemanticMetadataoptionalIResolvableSemanticMetadataoptionalinterface{}#tableMapoptionalIResolvable | { [key: string]: IResolvable | CfnDataSet.SemanticTableProperty }table_mapoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, SemanticTableProperty]]]tableMapoptionalIResolvableTableMapoptionalIResolvableTableMapoptionalinterface{}#A map of semantic tables that define the analytical structure.