Class CfnTopicProps
Properties for defining a CfnTopic
.
Inheritance
System.Object
CfnTopicProps
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public class CfnTopicProps : Object, ICfnTopicProps
Syntax (vb)
Public Class CfnTopicProps
Inherits Object
Implements ICfnTopicProps
Remarks
Link: 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.AWS.QuickSight;
var cfnTopicProps = new CfnTopicProps {
AwsAccountId = "awsAccountId",
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
}
},
IsIncludedInTopic = false,
NeverAggregateInFilter = 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
}
},
IsIncludedInTopic = false,
NeverAggregateInFilter = 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",
Name = "name",
TopicId = "topicId"
};
Synopsis
Constructors
CfnTopicProps() |
Properties
AwsAccountId | The ID of the AWS account that you want to create a topic in. |
DataSets | The data sets that the topic is associated with. |
Description | The description of the topic. |
Name | The name of the topic. |
TopicId | The ID for the topic. |
Constructors
CfnTopicProps()
public CfnTopicProps()
Properties
AwsAccountId
The ID of the AWS account that you want to create a topic in.
public string AwsAccountId { get; set; }
Property Value
System.String
Remarks
DataSets
The data sets that the topic is associated with.
public object DataSets { get; set; }
Property Value
System.Object
Remarks
Description
The description of the topic.
public string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the topic.
public string Name { get; set; }
Property Value
System.String
Remarks
TopicId
The ID for the topic.
public string TopicId { get; set; }
Property Value
System.String
Remarks
This ID is unique per AWS Region for each AWS account.