Interface ICfnTopicMixinProps

Properties for CfnTopicPropsMixin.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QuickSight

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface ICfnTopicMixinProps

Syntax (vb)

Public Interface ICfnTopicMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.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 cfnTopicMixinProps = new CfnTopicMixinProps {
                 AwsAccountId = "awsAccountId",
                 ConfigOptions = new TopicConfigOptionsProperty {
                     QBusinessInsightsEnabled = false
                 },
                 CustomInstructions = new CustomInstructionsProperty {
                     CustomInstructionsString = "customInstructionsString"
                 },
                 DataSets = new [] { new DatasetMetadataProperty {
                     CalculatedFields = new [] { new TopicCalculatedFieldProperty {
                         Aggregation = "aggregation",
                         AllowedAggregations = new [] { "allowedAggregations" },
                         CalculatedFieldDescription = "calculatedFieldDescription",
                         CalculatedFieldName = "calculatedFieldName",
                         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,
                         Expression = "expression",
                         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 {
                         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"
                     } },
                     DataAggregation = new DataAggregationProperty {
                         DatasetRowDateGranularity = "datasetRowDateGranularity",
                         DefaultDateColumnName = "defaultDateColumnName"
                     },
                     DatasetArn = "datasetArn",
                     DatasetDescription = "datasetDescription",
                     DatasetName = "datasetName",
                     Filters = new [] { new TopicFilterProperty {
                         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",
                         FilterName = "filterName",
                         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
                         },
                         OperandFieldName = "operandFieldName",
                         RelativeDateFilter = new TopicRelativeDateFilterProperty {
                             Constant = new TopicSingularFilterConstantProperty {
                                 ConstantType = "constantType",
                                 SingularConstant = "singularConstant"
                             },
                             RelativeDateFilterFunction = "relativeDateFilterFunction",
                             TimeGranularity = "timeGranularity"
                         }
                     } },
                     NamedEntities = new [] { new TopicNamedEntityProperty {
                         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",
                         EntityName = "entityName",
                         EntitySynonyms = new [] { "entitySynonyms" },
                         SemanticEntityType = new SemanticEntityTypeProperty {
                             SubTypeName = "subTypeName",
                             TypeName = "typeName",
                             TypeParameters = new Dictionary<string, string> {
                                 { "typeParametersKey", "typeParameters" }
                             }
                         }
                     } }
                 } },
                 Description = "description",
                 FolderArns = new [] { "folderArns" },
                 Name = "name",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TopicId = "topicId",
                 UserExperienceVersion = "userExperienceVersion"
             };

Synopsis

Properties

AwsAccountId	The ID of the AWS account that you want to create a topic in.
ConfigOptions	Configuration options for a `Topic` .
CustomInstructions	Properties for CfnTopicPropsMixin.
DataSets	The data sets that the topic is associated with.
Description	The description of the topic.
FolderArns	Properties for CfnTopicPropsMixin.
Name	The name of the topic.
Tags	Properties for CfnTopicPropsMixin.
TopicId	The ID for the topic.
UserExperienceVersion	The user experience version of the topic.