TopicColumnProperty Struct
Represents a column in a dataset.
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';
const topicColumnProperty: quicksight.CfnTopic.TopicColumnProperty = {
columnName: 'columnName',
// the properties below are optional
aggregation: 'aggregation',
allowedAggregations: ['allowedAggregations'],
cellValueSynonyms: [{
cellValue: 'cellValue',
synonyms: ['synonyms'],
}],
columnDataRole: 'columnDataRole',
columnDescription: 'columnDescription',
columnFriendlyName: 'columnFriendlyName',
columnSynonyms: ['columnSynonyms'],
comparativeOrder: {
specifedOrder: ['specifedOrder'],
treatUndefinedSpecifiedValues: 'treatUndefinedSpecifiedValues',
useOrdering: 'useOrdering',
},
defaultFormatting: {
displayFormat: 'displayFormat',
displayFormatOptions: {
blankCellFormat: 'blankCellFormat',
currencySymbol: 'currencySymbol',
dateFormat: 'dateFormat',
decimalSeparator: 'decimalSeparator',
fractionDigits: 123,
groupingSeparator: 'groupingSeparator',
negativeFormat: {
prefix: 'prefix',
suffix: 'suffix',
},
prefix: 'prefix',
suffix: 'suffix',
unitScaler: 'unitScaler',
useBlankCellFormat: false,
useGrouping: false,
},
},
disableIndexing: false,
isIncludedInTopic: false,
neverAggregateInFilter: false,
nonAdditive: false,
notAllowedAggregations: ['notAllowedAggregations'],
semanticType: {
falseyCellValue: 'falseyCellValue',
falseyCellValueSynonyms: ['falseyCellValueSynonyms'],
subTypeName: 'subTypeName',
truthyCellValue: 'truthyCellValue',
truthyCellValueSynonyms: ['truthyCellValueSynonyms'],
typeName: 'typeName',
typeParameters: {
typeParametersKey: 'typeParameters',
},
},
timeGranularity: 'timeGranularity',
};
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
topic_column_property = quicksight.CfnTopic.TopicColumnProperty(
column_name="columnName",
# the properties below are optional
aggregation="aggregation",
allowed_aggregations=["allowedAggregations"],
cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty(
cell_value="cellValue",
synonyms=["synonyms"]
)],
column_data_role="columnDataRole",
column_description="columnDescription",
column_friendly_name="columnFriendlyName",
column_synonyms=["columnSynonyms"],
comparative_order=quicksight.CfnTopic.ComparativeOrderProperty(
specifed_order=["specifedOrder"],
treat_undefined_specified_values="treatUndefinedSpecifiedValues",
use_ordering="useOrdering"
),
default_formatting=quicksight.CfnTopic.DefaultFormattingProperty(
display_format="displayFormat",
display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty(
blank_cell_format="blankCellFormat",
currency_symbol="currencySymbol",
date_format="dateFormat",
decimal_separator="decimalSeparator",
fraction_digits=123,
grouping_separator="groupingSeparator",
negative_format=quicksight.CfnTopic.NegativeFormatProperty(
prefix="prefix",
suffix="suffix"
),
prefix="prefix",
suffix="suffix",
unit_scaler="unitScaler",
use_blank_cell_format=False,
use_grouping=False
)
),
disable_indexing=False,
is_included_in_topic=False,
never_aggregate_in_filter=False,
non_additive=False,
not_allowed_aggregations=["notAllowedAggregations"],
semantic_type=quicksight.CfnTopic.SemanticTypeProperty(
falsey_cell_value="falseyCellValue",
falsey_cell_value_synonyms=["falseyCellValueSynonyms"],
sub_type_name="subTypeName",
truthy_cell_value="truthyCellValue",
truthy_cell_value_synonyms=["truthyCellValueSynonyms"],
type_name="typeName",
type_parameters={
"type_parameters_key": "typeParameters"
}
),
time_granularity="timeGranularity"
)
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.*;
TopicColumnProperty topicColumnProperty = TopicColumnProperty.builder()
.columnName("columnName")
// the properties below are optional
.aggregation("aggregation")
.allowedAggregations(List.of("allowedAggregations"))
.cellValueSynonyms(List.of(CellValueSynonymProperty.builder()
.cellValue("cellValue")
.synonyms(List.of("synonyms"))
.build()))
.columnDataRole("columnDataRole")
.columnDescription("columnDescription")
.columnFriendlyName("columnFriendlyName")
.columnSynonyms(List.of("columnSynonyms"))
.comparativeOrder(ComparativeOrderProperty.builder()
.specifedOrder(List.of("specifedOrder"))
.treatUndefinedSpecifiedValues("treatUndefinedSpecifiedValues")
.useOrdering("useOrdering")
.build())
.defaultFormatting(DefaultFormattingProperty.builder()
.displayFormat("displayFormat")
.displayFormatOptions(DisplayFormatOptionsProperty.builder()
.blankCellFormat("blankCellFormat")
.currencySymbol("currencySymbol")
.dateFormat("dateFormat")
.decimalSeparator("decimalSeparator")
.fractionDigits(123)
.groupingSeparator("groupingSeparator")
.negativeFormat(NegativeFormatProperty.builder()
.prefix("prefix")
.suffix("suffix")
.build())
.prefix("prefix")
.suffix("suffix")
.unitScaler("unitScaler")
.useBlankCellFormat(false)
.useGrouping(false)
.build())
.build())
.disableIndexing(false)
.isIncludedInTopic(false)
.neverAggregateInFilter(false)
.nonAdditive(false)
.notAllowedAggregations(List.of("notAllowedAggregations"))
.semanticType(SemanticTypeProperty.builder()
.falseyCellValue("falseyCellValue")
.falseyCellValueSynonyms(List.of("falseyCellValueSynonyms"))
.subTypeName("subTypeName")
.truthyCellValue("truthyCellValue")
.truthyCellValueSynonyms(List.of("truthyCellValueSynonyms"))
.typeName("typeName")
.typeParameters(Map.of(
"typeParametersKey", "typeParameters"))
.build())
.timeGranularity("timeGranularity")
.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 topicColumnProperty = new TopicColumnProperty {
ColumnName = "columnName",
// the properties below are optional
Aggregation = "aggregation",
AllowedAggregations = new [] { "allowedAggregations" },
CellValueSynonyms = new [] { new CellValueSynonymProperty {
CellValue = "cellValue",
Synonyms = new [] { "synonyms" }
} },
ColumnDataRole = "columnDataRole",
ColumnDescription = "columnDescription",
ColumnFriendlyName = "columnFriendlyName",
ColumnSynonyms = new [] { "columnSynonyms" },
ComparativeOrder = new ComparativeOrderProperty {
SpecifedOrder = new [] { "specifedOrder" },
TreatUndefinedSpecifiedValues = "treatUndefinedSpecifiedValues",
UseOrdering = "useOrdering"
},
DefaultFormatting = new DefaultFormattingProperty {
DisplayFormat = "displayFormat",
DisplayFormatOptions = new DisplayFormatOptionsProperty {
BlankCellFormat = "blankCellFormat",
CurrencySymbol = "currencySymbol",
DateFormat = "dateFormat",
DecimalSeparator = "decimalSeparator",
FractionDigits = 123,
GroupingSeparator = "groupingSeparator",
NegativeFormat = new NegativeFormatProperty {
Prefix = "prefix",
Suffix = "suffix"
},
Prefix = "prefix",
Suffix = "suffix",
UnitScaler = "unitScaler",
UseBlankCellFormat = false,
UseGrouping = false
}
},
DisableIndexing = false,
IsIncludedInTopic = false,
NeverAggregateInFilter = false,
NonAdditive = false,
NotAllowedAggregations = new [] { "notAllowedAggregations" },
SemanticType = new SemanticTypeProperty {
FalseyCellValue = "falseyCellValue",
FalseyCellValueSynonyms = new [] { "falseyCellValueSynonyms" },
SubTypeName = "subTypeName",
TruthyCellValue = "truthyCellValue",
TruthyCellValueSynonyms = new [] { "truthyCellValueSynonyms" },
TypeName = "typeName",
TypeParameters = new Dictionary<string, string> {
{ "typeParametersKey", "typeParameters" }
}
},
TimeGranularity = "timeGranularity"
};
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"
topicColumnProperty := &TopicColumnProperty{
ColumnName: jsii.String("columnName"),
// the properties below are optional
Aggregation: jsii.String("aggregation"),
AllowedAggregations: []*string{
jsii.String("allowedAggregations"),
},
CellValueSynonyms: []interface{}{
&CellValueSynonymProperty{
CellValue: jsii.String("cellValue"),
Synonyms: []*string{
jsii.String("synonyms"),
},
},
},
ColumnDataRole: jsii.String("columnDataRole"),
ColumnDescription: jsii.String("columnDescription"),
ColumnFriendlyName: jsii.String("columnFriendlyName"),
ColumnSynonyms: []*string{
jsii.String("columnSynonyms"),
},
ComparativeOrder: &ComparativeOrderProperty{
SpecifedOrder: []*string{
jsii.String("specifedOrder"),
},
TreatUndefinedSpecifiedValues: jsii.String("treatUndefinedSpecifiedValues"),
UseOrdering: jsii.String("useOrdering"),
},
DefaultFormatting: &DefaultFormattingProperty{
DisplayFormat: jsii.String("displayFormat"),
DisplayFormatOptions: &DisplayFormatOptionsProperty{
BlankCellFormat: jsii.String("blankCellFormat"),
CurrencySymbol: jsii.String("currencySymbol"),
DateFormat: jsii.String("dateFormat"),
DecimalSeparator: jsii.String("decimalSeparator"),
FractionDigits: jsii.Number(123),
GroupingSeparator: jsii.String("groupingSeparator"),
NegativeFormat: &NegativeFormatProperty{
Prefix: jsii.String("prefix"),
Suffix: jsii.String("suffix"),
},
Prefix: jsii.String("prefix"),
Suffix: jsii.String("suffix"),
UnitScaler: jsii.String("unitScaler"),
UseBlankCellFormat: jsii.Boolean(false),
UseGrouping: jsii.Boolean(false),
},
},
DisableIndexing: jsii.Boolean(false),
IsIncludedInTopic: jsii.Boolean(false),
NeverAggregateInFilter: jsii.Boolean(false),
NonAdditive: jsii.Boolean(false),
NotAllowedAggregations: []*string{
jsii.String("notAllowedAggregations"),
},
SemanticType: &SemanticTypeProperty{
FalseyCellValue: jsii.String("falseyCellValue"),
FalseyCellValueSynonyms: []*string{
jsii.String("falseyCellValueSynonyms"),
},
SubTypeName: jsii.String("subTypeName"),
TruthyCellValue: jsii.String("truthyCellValue"),
TruthyCellValueSynonyms: []*string{
jsii.String("truthyCellValueSynonyms"),
},
TypeName: jsii.String("typeName"),
TypeParameters: map[string]*string{
"typeParametersKey": jsii.String("typeParameters"),
},
},
TimeGranularity: jsii.String("timeGranularity"),
}
Properties
aggregationoptionalstringaggregationoptionalstraggregationoptionalStringAggregationoptionalstringAggregationoptional*string#The type of aggregation that is performed on the column data when it's queried.
allowedAggregationsoptionalstring[]allowed_aggregationsoptionaltyping.List[str]allowedAggregationsoptionalList<String>AllowedAggregationsoptionalstring[]AllowedAggregationsoptional*[]*string#The list of aggregation types that are allowed for the column.
Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
cellValueSynonymsoptionalIResolvable | IResolvable | CfnTopic.CellValueSynonymProperty[]cell_value_synonymsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CellValueSynonymProperty]]]cellValueSynonymsoptionalIResolvableCellValueSynonymsoptionalIResolvableCellValueSynonymsoptionalinterface{}#The other names or aliases for the column cell value.
columnDataRoleoptionalstringcolumn_data_roleoptionalstrcolumnDataRoleoptionalStringColumnDataRoleoptionalstringColumnDataRoleoptional*string#The role of the column in the data.
Valid values are DIMENSION and MEASURE .
columnDescriptionoptionalstringcolumn_descriptionoptionalstrcolumnDescriptionoptionalStringColumnDescriptionoptionalstringColumnDescriptionoptional*string#A description of the column and its contents.
columnFriendlyNameoptionalstringcolumn_friendly_nameoptionalstrcolumnFriendlyNameoptionalStringColumnFriendlyNameoptionalstringColumnFriendlyNameoptional*string#A user-friendly name for the column.
The name of the column.
columnSynonymsoptionalstring[]column_synonymsoptionaltyping.List[str]columnSynonymsoptionalList<String>ColumnSynonymsoptionalstring[]ColumnSynonymsoptional*[]*string#The other names or aliases for the column.
comparativeOrderoptionalIResolvable | CfnTopic.ComparativeOrderPropertycomparative_orderoptionaltyping.Union[IResolvable, ComparativeOrderProperty]comparativeOrderoptionalIResolvableComparativeOrderoptionalIResolvableComparativeOrderoptionalinterface{}#The order in which data is displayed for the column when it's used in a comparative context.
defaultFormattingoptionalIResolvable | CfnTopic.DefaultFormattingPropertydefault_formattingoptionaltyping.Union[IResolvable, DefaultFormattingProperty]defaultFormattingoptionalIResolvableDefaultFormattingoptionalIResolvableDefaultFormattingoptionalinterface{}#The default formatting used for values in the column.
disableIndexingoptionalboolean | IResolvabledisable_indexingoptionaltyping.Union[bool, IResolvable]disableIndexingoptionalBooleanDisableIndexingoptionalboolDisableIndexingoptionalinterface{}#A Boolean value that indicates whether the column shows in the autocomplete functionality.
isIncludedInTopicoptionalboolean | IResolvableis_included_in_topicoptionaltyping.Union[bool, IResolvable]isIncludedInTopicoptionalBooleanIsIncludedInTopicoptionalboolIsIncludedInTopicoptionalinterface{}= false#A Boolean value that indicates whether the column is included in the query results.
neverAggregateInFilteroptionalboolean | IResolvablenever_aggregate_in_filteroptionaltyping.Union[bool, IResolvable]neverAggregateInFilteroptionalBooleanNeverAggregateInFilteroptionalboolNeverAggregateInFilteroptionalinterface{}= false#A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
nonAdditiveoptionalboolean | IResolvablenon_additiveoptionaltyping.Union[bool, IResolvable]nonAdditiveoptionalBooleanNonAdditiveoptionalboolNonAdditiveoptionalinterface{}= false#The non additive value for the column.
notAllowedAggregationsoptionalstring[]not_allowed_aggregationsoptionaltyping.List[str]notAllowedAggregationsoptionalList<String>NotAllowedAggregationsoptionalstring[]NotAllowedAggregationsoptional*[]*string#The list of aggregation types that are not allowed for the column.
Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
semanticTypeoptionalIResolvable | CfnTopic.SemanticTypePropertysemantic_typeoptionaltyping.Union[IResolvable, SemanticTypeProperty]semanticTypeoptionalIResolvableSemanticTypeoptionalIResolvableSemanticTypeoptionalinterface{}#The semantic type of data contained in the column.
timeGranularityoptionalstringtime_granularityoptionalstrtimeGranularityoptionalStringTimeGranularityoptionalstringTimeGranularityoptional*string#The level of time precision that is used to aggregate `DateTime` values.