Class CfnTopicPropsMixin.TopicColumnProperty

Represents a column in a dataset.

Inheritance

object

CfnTopicPropsMixin.TopicColumnProperty

Implements

CfnTopicPropsMixin.ITopicColumnProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QuickSight

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnTopicPropsMixin.TopicColumnProperty : CfnTopicPropsMixin.ITopicColumnProperty

Syntax (vb)

Public Class CfnTopicPropsMixin.TopicColumnProperty Implements CfnTopicPropsMixin.ITopicColumnProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.QuickSight;

             var topicColumnProperty = new TopicColumnProperty {
                 Aggregation = "aggregation",
                 AllowedAggregations = new [] { "allowedAggregations" },
                 CellValueSynonyms = new [] { new CellValueSynonymProperty {
                     CellValue = "cellValue",
                     Synonyms = new [] { "synonyms" }
                 } },
                 ColumnDataRole = "columnDataRole",
                 ColumnDescription = "columnDescription",
                 ColumnFriendlyName = "columnFriendlyName",
                 ColumnName = "columnName",
                 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"
             };

Synopsis

Constructors

TopicColumnProperty()

Represents a column in a dataset.

Properties

Aggregation	The type of aggregation that is performed on the column data when it's queried.
AllowedAggregations	The list of aggregation types that are allowed for the column.
CellValueSynonyms	The other names or aliases for the column cell value.
ColumnDataRole	The role of the column in the data.
ColumnDescription	A description of the column and its contents.
ColumnFriendlyName	A user-friendly name for the column.
ColumnName	The name of the column.
ColumnSynonyms	The other names or aliases for the column.
ComparativeOrder	The order in which data is displayed for the column when it's used in a comparative context.
DefaultFormatting	The default formatting used for values in the column.
DisableIndexing	A Boolean value that indicates whether the column shows in the autocomplete functionality.
IsIncludedInTopic	A Boolean value that indicates whether the column is included in the query results.
NeverAggregateInFilter	A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
NonAdditive	The non additive value for the column.
NotAllowedAggregations	The list of aggregation types that are not allowed for the column.
SemanticType	The semantic type of data contained in the column.
TimeGranularity	The level of time precision that is used to aggregate `DateTime` values.

Constructors

TopicColumnProperty()

Represents a column in a dataset.

public TopicColumnProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.QuickSight;

             var topicColumnProperty = new TopicColumnProperty {
                 Aggregation = "aggregation",
                 AllowedAggregations = new [] { "allowedAggregations" },
                 CellValueSynonyms = new [] { new CellValueSynonymProperty {
                     CellValue = "cellValue",
                     Synonyms = new [] { "synonyms" }
                 } },
                 ColumnDataRole = "columnDataRole",
                 ColumnDescription = "columnDescription",
                 ColumnFriendlyName = "columnFriendlyName",
                 ColumnName = "columnName",
                 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"
             };

Properties

Aggregation

The type of aggregation that is performed on the column data when it's queried.

public string? Aggregation { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-aggregation

AllowedAggregations

The list of aggregation types that are allowed for the column.

public string[]? AllowedAggregations { get; set; }

Property Value

string[]

Remarks

Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-allowedaggregations

CellValueSynonyms

The other names or aliases for the column cell value.

public object? CellValueSynonyms { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-cellvaluesynonyms

Type union: either IResolvable or (either IResolvable or CfnTopicPropsMixin.ICellValueSynonymProperty)[]

ColumnDataRole

The role of the column in the data.

public string? ColumnDataRole { get; set; }

Property Value

string

Remarks

Valid values are DIMENSION and MEASURE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columndatarole

ColumnDescription

A description of the column and its contents.

public string? ColumnDescription { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columndescription

ColumnFriendlyName

A user-friendly name for the column.

public string? ColumnFriendlyName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnfriendlyname

ColumnName

The name of the column.

public string? ColumnName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnname

ColumnSynonyms

The other names or aliases for the column.

public string[]? ColumnSynonyms { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnsynonyms

ComparativeOrder

The order in which data is displayed for the column when it's used in a comparative context.

public object? ComparativeOrder { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-comparativeorder

Type union: either IResolvable or CfnTopicPropsMixin.IComparativeOrderProperty

DefaultFormatting

The default formatting used for values in the column.

public object? DefaultFormatting { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-defaultformatting

Type union: either IResolvable or CfnTopicPropsMixin.IDefaultFormattingProperty

DisableIndexing

A Boolean value that indicates whether the column shows in the autocomplete functionality.

public object? DisableIndexing { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-disableindexing

Type union: either bool or IResolvable

IsIncludedInTopic

A Boolean value that indicates whether the column is included in the query results.

public object? IsIncludedInTopic { get; set; }

Property Value

object

Remarks

Default: - false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-isincludedintopic

Type union: either bool or IResolvable

NeverAggregateInFilter

A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.

public object? NeverAggregateInFilter { get; set; }

Property Value

object

Remarks

Default: - false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-neveraggregateinfilter

Type union: either bool or IResolvable

NonAdditive

The non additive value for the column.

public object? NonAdditive { get; set; }

Property Value

object

Remarks

Default: - false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-nonadditive

Type union: either bool or IResolvable

NotAllowedAggregations

The list of aggregation types that are not allowed for the column.

public string[]? NotAllowedAggregations { get; set; }

Property Value

string[]

Remarks

Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-notallowedaggregations

SemanticType

The semantic type of data contained in the column.

public object? SemanticType { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-semantictype

Type union: either IResolvable or CfnTopicPropsMixin.ISemanticTypeProperty

TimeGranularity

The level of time precision that is used to aggregate DateTime values.

public string? TimeGranularity { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-timegranularity