Class CfnTopic.DatasetMetadataProperty

A structure that represents a dataset.

Inheritance

object

CfnTopic.DatasetMetadataProperty

Implements

CfnTopic.IDatasetMetadataProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnTopic.DatasetMetadataProperty : CfnTopic.IDatasetMetadataProperty

Syntax (vb)

Public Class CfnTopic.DatasetMetadataProperty Implements CfnTopic.IDatasetMetadataProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.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.AWS.QuickSight;

             var datasetMetadataProperty = new DatasetMetadataProperty {
                 DatasetArn = "datasetArn",

                 // the properties below are optional
                 CalculatedFields = new [] { new TopicCalculatedFieldProperty {
                     CalculatedFieldName = "calculatedFieldName",
                     Expression = "expression",

                     // the properties below are optional
                     Aggregation = "aggregation",
                     AllowedAggregations = new [] { "allowedAggregations" },
                     CalculatedFieldDescription = "calculatedFieldDescription",
                     CalculatedFieldSynonyms = new [] { "calculatedFieldSynonyms" },
                     CellValueSynonyms = new [] { new CellValueSynonymProperty {
                         CellValue = "cellValue",
                         Synonyms = new [] { "synonyms" }
                     } },
                     ColumnDataRole = "columnDataRole",
                     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"
                 } },
                 Columns = new [] { 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"
                 } },
                 DataAggregation = new DataAggregationProperty {
                     DatasetRowDateGranularity = "datasetRowDateGranularity",
                     DefaultDateColumnName = "defaultDateColumnName"
                 },
                 DatasetDescription = "datasetDescription",
                 DatasetName = "datasetName",
                 Filters = new [] { new TopicFilterProperty {
                     FilterName = "filterName",
                     OperandFieldName = "operandFieldName",

                     // the properties below are optional
                     CategoryFilter = new TopicCategoryFilterProperty {
                         CategoryFilterFunction = "categoryFilterFunction",
                         CategoryFilterType = "categoryFilterType",
                         Constant = new TopicCategoryFilterConstantProperty {
                             CollectiveConstant = new CollectiveConstantProperty {
                                 ValueList = new [] { "valueList" }
                             },
                             ConstantType = "constantType",
                             SingularConstant = "singularConstant"
                         },
                         Inverse = false
                     },
                     DateRangeFilter = new TopicDateRangeFilterProperty {
                         Constant = new TopicRangeFilterConstantProperty {
                             ConstantType = "constantType",
                             RangeConstant = new RangeConstantProperty {
                                 Maximum = "maximum",
                                 Minimum = "minimum"
                             }
                         },
                         Inclusive = false
                     },
                     FilterClass = "filterClass",
                     FilterDescription = "filterDescription",
                     FilterSynonyms = new [] { "filterSynonyms" },
                     FilterType = "filterType",
                     NumericEqualityFilter = new TopicNumericEqualityFilterProperty {
                         Aggregation = "aggregation",
                         Constant = new TopicSingularFilterConstantProperty {
                             ConstantType = "constantType",
                             SingularConstant = "singularConstant"
                         }
                     },
                     NumericRangeFilter = new TopicNumericRangeFilterProperty {
                         Aggregation = "aggregation",
                         Constant = new TopicRangeFilterConstantProperty {
                             ConstantType = "constantType",
                             RangeConstant = new RangeConstantProperty {
                                 Maximum = "maximum",
                                 Minimum = "minimum"
                             }
                         },
                         Inclusive = false
                     },
                     RelativeDateFilter = new TopicRelativeDateFilterProperty {
                         Constant = new TopicSingularFilterConstantProperty {
                             ConstantType = "constantType",
                             SingularConstant = "singularConstant"
                         },
                         RelativeDateFilterFunction = "relativeDateFilterFunction",
                         TimeGranularity = "timeGranularity"
                     }
                 } },
                 NamedEntities = new [] { new TopicNamedEntityProperty {
                     EntityName = "entityName",

                     // the properties below are optional
                     Definition = new [] { new NamedEntityDefinitionProperty {
                         FieldName = "fieldName",
                         Metric = new NamedEntityDefinitionMetricProperty {
                             Aggregation = "aggregation",
                             AggregationFunctionParameters = new Dictionary<string, string> {
                                 { "aggregationFunctionParametersKey", "aggregationFunctionParameters" }
                             }
                         },
                         PropertyName = "propertyName",
                         PropertyRole = "propertyRole",
                         PropertyUsage = "propertyUsage"
                     } },
                     EntityDescription = "entityDescription",
                     EntitySynonyms = new [] { "entitySynonyms" },
                     SemanticEntityType = new SemanticEntityTypeProperty {
                         SubTypeName = "subTypeName",
                         TypeName = "typeName",
                         TypeParameters = new Dictionary<string, string> {
                             { "typeParametersKey", "typeParameters" }
                         }
                     }
                 } }
             };

Synopsis

Constructors

DatasetMetadataProperty()

A structure that represents a dataset.

Properties

CalculatedFields	The list of calculated field definitions.
Columns	The list of column definitions.
DataAggregation	The definition of a data aggregation.
DatasetArn	The Amazon Resource Name (ARN) of the dataset.
DatasetDescription	The description of the dataset.
DatasetName	The name of the dataset.
Filters	The list of filter definitions.
NamedEntities	The list of named entities definitions.

Constructors

DatasetMetadataProperty()

A structure that represents a dataset.

public DatasetMetadataProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-datasetmetadata.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.AWS.QuickSight;

             var datasetMetadataProperty = new DatasetMetadataProperty {
                 DatasetArn = "datasetArn",

                 // the properties below are optional
                 CalculatedFields = new [] { new TopicCalculatedFieldProperty {
                     CalculatedFieldName = "calculatedFieldName",
                     Expression = "expression",

                     // the properties below are optional
                     Aggregation = "aggregation",
                     AllowedAggregations = new [] { "allowedAggregations" },
                     CalculatedFieldDescription = "calculatedFieldDescription",
                     CalculatedFieldSynonyms = new [] { "calculatedFieldSynonyms" },
                     CellValueSynonyms = new [] { new CellValueSynonymProperty {
                         CellValue = "cellValue",
                         Synonyms = new [] { "synonyms" }
                     } },
                     ColumnDataRole = "columnDataRole",
                     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"
                 } },
                 Columns = new [] { 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"
                 } },
                 DataAggregation = new DataAggregationProperty {
                     DatasetRowDateGranularity = "datasetRowDateGranularity",
                     DefaultDateColumnName = "defaultDateColumnName"
                 },
                 DatasetDescription = "datasetDescription",
                 DatasetName = "datasetName",
                 Filters = new [] { new TopicFilterProperty {
                     FilterName = "filterName",
                     OperandFieldName = "operandFieldName",

                     // the properties below are optional
                     CategoryFilter = new TopicCategoryFilterProperty {
                         CategoryFilterFunction = "categoryFilterFunction",
                         CategoryFilterType = "categoryFilterType",
                         Constant = new TopicCategoryFilterConstantProperty {
                             CollectiveConstant = new CollectiveConstantProperty {
                                 ValueList = new [] { "valueList" }
                             },
                             ConstantType = "constantType",
                             SingularConstant = "singularConstant"
                         },
                         Inverse = false
                     },
                     DateRangeFilter = new TopicDateRangeFilterProperty {
                         Constant = new TopicRangeFilterConstantProperty {
                             ConstantType = "constantType",
                             RangeConstant = new RangeConstantProperty {
                                 Maximum = "maximum",
                                 Minimum = "minimum"
                             }
                         },
                         Inclusive = false
                     },
                     FilterClass = "filterClass",
                     FilterDescription = "filterDescription",
                     FilterSynonyms = new [] { "filterSynonyms" },
                     FilterType = "filterType",
                     NumericEqualityFilter = new TopicNumericEqualityFilterProperty {
                         Aggregation = "aggregation",
                         Constant = new TopicSingularFilterConstantProperty {
                             ConstantType = "constantType",
                             SingularConstant = "singularConstant"
                         }
                     },
                     NumericRangeFilter = new TopicNumericRangeFilterProperty {
                         Aggregation = "aggregation",
                         Constant = new TopicRangeFilterConstantProperty {
                             ConstantType = "constantType",
                             RangeConstant = new RangeConstantProperty {
                                 Maximum = "maximum",
                                 Minimum = "minimum"
                             }
                         },
                         Inclusive = false
                     },
                     RelativeDateFilter = new TopicRelativeDateFilterProperty {
                         Constant = new TopicSingularFilterConstantProperty {
                             ConstantType = "constantType",
                             SingularConstant = "singularConstant"
                         },
                         RelativeDateFilterFunction = "relativeDateFilterFunction",
                         TimeGranularity = "timeGranularity"
                     }
                 } },
                 NamedEntities = new [] { new TopicNamedEntityProperty {
                     EntityName = "entityName",

                     // the properties below are optional
                     Definition = new [] { new NamedEntityDefinitionProperty {
                         FieldName = "fieldName",
                         Metric = new NamedEntityDefinitionMetricProperty {
                             Aggregation = "aggregation",
                             AggregationFunctionParameters = new Dictionary<string, string> {
                                 { "aggregationFunctionParametersKey", "aggregationFunctionParameters" }
                             }
                         },
                         PropertyName = "propertyName",
                         PropertyRole = "propertyRole",
                         PropertyUsage = "propertyUsage"
                     } },
                     EntityDescription = "entityDescription",
                     EntitySynonyms = new [] { "entitySynonyms" },
                     SemanticEntityType = new SemanticEntityTypeProperty {
                         SubTypeName = "subTypeName",
                         TypeName = "typeName",
                         TypeParameters = new Dictionary<string, string> {
                             { "typeParametersKey", "typeParameters" }
                         }
                     }
                 } }
             };

Properties

CalculatedFields

The list of calculated field definitions.

public object? CalculatedFields { get; set; }

Property Value

object

Remarks

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

Columns

The list of column definitions.

public object? Columns { get; set; }

Property Value

object

Remarks

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

DataAggregation

The definition of a data aggregation.

public object? DataAggregation { get; set; }

Property Value

object

Remarks

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

DatasetArn

The Amazon Resource Name (ARN) of the dataset.

public string DatasetArn { get; set; }

Property Value

string

Remarks

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

DatasetDescription

The description of the dataset.

public string? DatasetDescription { get; set; }

Property Value

string

Remarks

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

DatasetName

The name of the dataset.

public string? DatasetName { get; set; }

Property Value

string

Remarks

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

Filters

The list of filter definitions.

public object? Filters { get; set; }

Property Value

object

Remarks

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

NamedEntities

The list of named entities definitions.

public object? NamedEntities { get; set; }

Property Value

object

Remarks

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

Implements

CfnTopic.IDatasetMetadataProperty