CfnTopicProps
- class aws_cdk.aws_quicksight.CfnTopicProps(*, aws_account_id=None, data_sets=None, description=None, name=None, topic_id=None)
Bases:
object
Properties for defining a
CfnTopic
.- Parameters:
aws_account_id (
Optional
[str
]) – The ID of the AWS account that you want to create a topic in.data_sets (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,DatasetMetadataProperty
,Dict
[str
,Any
]]],None
]) – The data sets that the topic is associated with.description (
Optional
[str
]) – The description of the topic.name (
Optional
[str
]) – The name of the topic.topic_id (
Optional
[str
]) – The ID for the topic. This ID is unique per AWS Region for each AWS account.
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_quicksight as quicksight cfn_topic_props = quicksight.CfnTopicProps( aws_account_id="awsAccountId", data_sets=[quicksight.CfnTopic.DatasetMetadataProperty( dataset_arn="datasetArn", # the properties below are optional calculated_fields=[quicksight.CfnTopic.TopicCalculatedFieldProperty( calculated_field_name="calculatedFieldName", expression="expression", # the properties below are optional aggregation="aggregation", allowed_aggregations=["allowedAggregations"], calculated_field_description="calculatedFieldDescription", calculated_field_synonyms=["calculatedFieldSynonyms"], cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty( cell_value="cellValue", synonyms=["synonyms"] )], column_data_role="columnDataRole", comparative_order=quicksight.CfnTopic.ComparativeOrderProperty( specifed_order=["specifedOrder"], treat_undefined_specified_values="treatUndefinedSpecifiedValues", use_ordering="useOrdering" ), default_formatting=quicksight.CfnTopic.DefaultFormattingProperty( display_format="displayFormat", display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty( blank_cell_format="blankCellFormat", currency_symbol="currencySymbol", date_format="dateFormat", decimal_separator="decimalSeparator", fraction_digits=123, grouping_separator="groupingSeparator", negative_format=quicksight.CfnTopic.NegativeFormatProperty( prefix="prefix", suffix="suffix" ), prefix="prefix", suffix="suffix", unit_scaler="unitScaler", use_blank_cell_format=False, use_grouping=False ) ), is_included_in_topic=False, never_aggregate_in_filter=False, not_allowed_aggregations=["notAllowedAggregations"], semantic_type=quicksight.CfnTopic.SemanticTypeProperty( falsey_cell_value="falseyCellValue", falsey_cell_value_synonyms=["falseyCellValueSynonyms"], sub_type_name="subTypeName", truthy_cell_value="truthyCellValue", truthy_cell_value_synonyms=["truthyCellValueSynonyms"], type_name="typeName", type_parameters={ "type_parameters_key": "typeParameters" } ), time_granularity="timeGranularity" )], columns=[quicksight.CfnTopic.TopicColumnProperty( column_name="columnName", # the properties below are optional aggregation="aggregation", allowed_aggregations=["allowedAggregations"], cell_value_synonyms=[quicksight.CfnTopic.CellValueSynonymProperty( cell_value="cellValue", synonyms=["synonyms"] )], column_data_role="columnDataRole", column_description="columnDescription", column_friendly_name="columnFriendlyName", column_synonyms=["columnSynonyms"], comparative_order=quicksight.CfnTopic.ComparativeOrderProperty( specifed_order=["specifedOrder"], treat_undefined_specified_values="treatUndefinedSpecifiedValues", use_ordering="useOrdering" ), default_formatting=quicksight.CfnTopic.DefaultFormattingProperty( display_format="displayFormat", display_format_options=quicksight.CfnTopic.DisplayFormatOptionsProperty( blank_cell_format="blankCellFormat", currency_symbol="currencySymbol", date_format="dateFormat", decimal_separator="decimalSeparator", fraction_digits=123, grouping_separator="groupingSeparator", negative_format=quicksight.CfnTopic.NegativeFormatProperty( prefix="prefix", suffix="suffix" ), prefix="prefix", suffix="suffix", unit_scaler="unitScaler", use_blank_cell_format=False, use_grouping=False ) ), is_included_in_topic=False, never_aggregate_in_filter=False, not_allowed_aggregations=["notAllowedAggregations"], semantic_type=quicksight.CfnTopic.SemanticTypeProperty( falsey_cell_value="falseyCellValue", falsey_cell_value_synonyms=["falseyCellValueSynonyms"], sub_type_name="subTypeName", truthy_cell_value="truthyCellValue", truthy_cell_value_synonyms=["truthyCellValueSynonyms"], type_name="typeName", type_parameters={ "type_parameters_key": "typeParameters" } ), time_granularity="timeGranularity" )], data_aggregation=quicksight.CfnTopic.DataAggregationProperty( dataset_row_date_granularity="datasetRowDateGranularity", default_date_column_name="defaultDateColumnName" ), dataset_description="datasetDescription", dataset_name="datasetName", filters=[quicksight.CfnTopic.TopicFilterProperty( filter_name="filterName", operand_field_name="operandFieldName", # the properties below are optional category_filter=quicksight.CfnTopic.TopicCategoryFilterProperty( category_filter_function="categoryFilterFunction", category_filter_type="categoryFilterType", constant=quicksight.CfnTopic.TopicCategoryFilterConstantProperty( collective_constant=quicksight.CfnTopic.CollectiveConstantProperty( value_list=["valueList"] ), constant_type="constantType", singular_constant="singularConstant" ), inverse=False ), date_range_filter=quicksight.CfnTopic.TopicDateRangeFilterProperty( constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty( constant_type="constantType", range_constant=quicksight.CfnTopic.RangeConstantProperty( maximum="maximum", minimum="minimum" ) ), inclusive=False ), filter_class="filterClass", filter_description="filterDescription", filter_synonyms=["filterSynonyms"], filter_type="filterType", numeric_equality_filter=quicksight.CfnTopic.TopicNumericEqualityFilterProperty( aggregation="aggregation", constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty( constant_type="constantType", singular_constant="singularConstant" ) ), numeric_range_filter=quicksight.CfnTopic.TopicNumericRangeFilterProperty( aggregation="aggregation", constant=quicksight.CfnTopic.TopicRangeFilterConstantProperty( constant_type="constantType", range_constant=quicksight.CfnTopic.RangeConstantProperty( maximum="maximum", minimum="minimum" ) ), inclusive=False ), relative_date_filter=quicksight.CfnTopic.TopicRelativeDateFilterProperty( constant=quicksight.CfnTopic.TopicSingularFilterConstantProperty( constant_type="constantType", singular_constant="singularConstant" ), relative_date_filter_function="relativeDateFilterFunction", time_granularity="timeGranularity" ) )], named_entities=[quicksight.CfnTopic.TopicNamedEntityProperty( entity_name="entityName", # the properties below are optional definition=[quicksight.CfnTopic.NamedEntityDefinitionProperty( field_name="fieldName", metric=quicksight.CfnTopic.NamedEntityDefinitionMetricProperty( aggregation="aggregation", aggregation_function_parameters={ "aggregation_function_parameters_key": "aggregationFunctionParameters" } ), property_name="propertyName", property_role="propertyRole", property_usage="propertyUsage" )], entity_description="entityDescription", entity_synonyms=["entitySynonyms"], semantic_entity_type=quicksight.CfnTopic.SemanticEntityTypeProperty( sub_type_name="subTypeName", type_name="typeName", type_parameters={ "type_parameters_key": "typeParameters" } ) )] )], description="description", name="name", topic_id="topicId" )
Attributes
- aws_account_id
The ID of the AWS account that you want to create a topic in.
- data_sets
The data sets that the topic is associated with.
- description
The description of the topic.
- name
The name of the topic.
- topic_id
The ID for the topic.
This ID is unique per AWS Region for each AWS account.