Class CfnTopic
Creates a new Q topic.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTopic : CfnResource, IInspectableSyntax (vb)
Public Class CfnTopic
Inherits CfnResource
Implements IInspectableRemarks
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",
TopicId = "topicId",
UserExperienceVersion = "userExperienceVersion"
});Synopsis
Constructors
| Cfn |
Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| Cfn |
Used by jsii to construct an instance of this class from DeputyProps |
| Cfn |
Properties
| Attr |
The Amazon Resource Name (ARN) of the topic. |
| Aws |
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. |
| Cfn |
|
| Config |
Configuration options for a |
| Data |
The data sets that the topic is associated with. |
| Description | The description of the topic. |
| Folder |
|
| Name | The name of the topic. |
| Topic |
The ID for the topic. |
| User |
The user experience version of the topic. |
Methods
| Inspect(Tree |
Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTopic(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTopic(ByRefValue reference)Parameters
- reference Amazon.
JSII. Runtime. Deputy. By Ref Value The Javascript-owned object reference
CfnTopic(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTopic(DeputyBase.DeputyProps props)Parameters
- props Amazon.
JSII. Runtime. Deputy. Deputy Base. Deputy Props The deputy props
CfnTopic(Construct, String, ICfnTopicProps)
public CfnTopic(Construct scope, string id, ICfnTopicProps props = null)Parameters
- scope Constructs.
Construct Scope in which this resource is defined.
- id System.
String Construct identifier for this resource (unique in its scope).
- props ICfn
Topic Props Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the topic.
public virtual string AttrArn { get; }Property Value
System.
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
System.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
System.
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
System.
Overrides
ConfigOptions
Configuration options for a Topic .
public virtual object ConfigOptions { get; set; }Property Value
System.
DataSets
The data sets that the topic is associated with.
public virtual object DataSets { get; set; }Property Value
System.
Description
The description of the topic.
public virtual string Description { get; set; }Property Value
System.
FolderArns
public virtual string[] FolderArns { get; set; }Property Value
System.
Name
The name of the topic.
public virtual string Name { get; set; }Property Value
System.
TopicId
The ID for the topic.
public virtual string TopicId { get; set; }Property Value
System.
UserExperienceVersion
The user experience version of the topic.
public virtual string UserExperienceVersion { get; set; }Property Value
System.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector Tree
Inspector tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props System.
Collections. <System.Generic. IDictionary String , System.Object >
Returns
System.