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',
};
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.