Show / Hide Table of Contents

Class CfnTopic

Creates a new Q topic.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnTopic
Implements
IInspectable
ITaggableV2
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTopic : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnTopic Inherits CfnResource Implements IInspectable, ITaggableV2
Remarks

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

CloudformationResource: AWS::QuickSight::Topic

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 cfnTopic = new CfnTopic(this, "MyCfnTopic", new CfnTopicProps {
                 AwsAccountId = "awsAccountId",
                 ConfigOptions = new TopicConfigOptionsProperty {
                     QBusinessInsightsEnabled = false
                 },
                 DataSets = new [] { 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" }
                             }
                         }
                     } }
                 } },
                 Description = "description",
                 FolderArns = new [] { "folderArns" },
                 Name = "name",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TopicId = "topicId",
                 UserExperienceVersion = "userExperienceVersion"
             });

Synopsis

Constructors

CfnTopic(Construct, string, ICfnTopicProps?)

Creates a new Q topic.

Properties

AttrArn

The Amazon Resource Name (ARN) of the topic.

AwsAccountId

The ID of the AWS account that you want to create a topic in.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CdkTagManager

Tag Manager which manages the tags for this resource.

CfnProperties

Creates a new Q topic.

ConfigOptions

Configuration options for a Topic .

DataSets

The data sets that the topic is associated with.

Description

The description of the topic.

FolderArns

Creates a new Q topic.

Name

The name of the topic.

Tags

Creates a new Q topic.

TopicId

The ID for the topic.

UserExperienceVersion

The user experience version of the topic.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<string, object>)

Creates a new Q topic.

Constructors

CfnTopic(Construct, string, ICfnTopicProps?)

Creates a new Q topic.

public CfnTopic(Construct scope, string id, ICfnTopicProps? props = null)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnTopicProps

Resource properties.

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the topic.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AwsAccountId

The ID of the AWS account that you want to create a topic in.

public virtual string? AwsAccountId { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new Q topic.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

ConfigOptions

Configuration options for a Topic .

public virtual object? ConfigOptions { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

DataSets

The data sets that the topic is associated with.

public virtual object? DataSets { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

Description

The description of the topic.

public virtual string? Description { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

FolderArns

Creates a new Q topic.

public virtual string[]? FolderArns { get; set; }
Property Value

string[]

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

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 cfnTopic = new CfnTopic(this, "MyCfnTopic", new CfnTopicProps {
                 AwsAccountId = "awsAccountId",
                 ConfigOptions = new TopicConfigOptionsProperty {
                     QBusinessInsightsEnabled = false
                 },
                 DataSets = new [] { 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" }
                             }
                         }
                     } }
                 } },
                 Description = "description",
                 FolderArns = new [] { "folderArns" },
                 Name = "name",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TopicId = "topicId",
                 UserExperienceVersion = "userExperienceVersion"
             });

Name

The name of the topic.

public virtual string? Name { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

Tags

Creates a new Q topic.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

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 cfnTopic = new CfnTopic(this, "MyCfnTopic", new CfnTopicProps {
                 AwsAccountId = "awsAccountId",
                 ConfigOptions = new TopicConfigOptionsProperty {
                     QBusinessInsightsEnabled = false
                 },
                 DataSets = new [] { 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" }
                             }
                         }
                     } }
                 } },
                 Description = "description",
                 FolderArns = new [] { "folderArns" },
                 Name = "name",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TopicId = "topicId",
                 UserExperienceVersion = "userExperienceVersion"
             });

TopicId

The ID for the topic.

public virtual string? TopicId { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

UserExperienceVersion

The user experience version of the topic.

public virtual string? UserExperienceVersion { get; set; }
Property Value

string

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new Q topic.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

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

CloudformationResource: AWS::QuickSight::Topic

ExampleMetadata: fixture=_generated

Implements

IInspectable
ITaggableV2
Back to top Generated by DocFX