Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Class CfnTopicPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnTopicPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.229Z")
@Stability(Stable)
public class CfnTopicPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a new Q topic.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.quicksight.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnTopicPropsMixin cfnTopicPropsMixin = CfnTopicPropsMixin.Builder.create(CfnTopicMixinProps.builder()
         .awsAccountId("awsAccountId")
         .configOptions(TopicConfigOptionsProperty.builder()
                 .qBusinessInsightsEnabled(false)
                 .build())
         .customInstructions(CustomInstructionsProperty.builder()
                 .customInstructionsString("customInstructionsString")
                 .build())
         .dataSets(List.of(DatasetMetadataProperty.builder()
                 .calculatedFields(List.of(TopicCalculatedFieldProperty.builder()
                         .aggregation("aggregation")
                         .allowedAggregations(List.of("allowedAggregations"))
                         .calculatedFieldDescription("calculatedFieldDescription")
                         .calculatedFieldName("calculatedFieldName")
                         .calculatedFieldSynonyms(List.of("calculatedFieldSynonyms"))
                         .cellValueSynonyms(List.of(CellValueSynonymProperty.builder()
                                 .cellValue("cellValue")
                                 .synonyms(List.of("synonyms"))
                                 .build()))
                         .columnDataRole("columnDataRole")
                         .comparativeOrder(ComparativeOrderProperty.builder()
                                 .specifedOrder(List.of("specifedOrder"))
                                 .treatUndefinedSpecifiedValues("treatUndefinedSpecifiedValues")
                                 .useOrdering("useOrdering")
                                 .build())
                         .defaultFormatting(DefaultFormattingProperty.builder()
                                 .displayFormat("displayFormat")
                                 .displayFormatOptions(DisplayFormatOptionsProperty.builder()
                                         .blankCellFormat("blankCellFormat")
                                         .currencySymbol("currencySymbol")
                                         .dateFormat("dateFormat")
                                         .decimalSeparator("decimalSeparator")
                                         .fractionDigits(123)
                                         .groupingSeparator("groupingSeparator")
                                         .negativeFormat(NegativeFormatProperty.builder()
                                                 .prefix("prefix")
                                                 .suffix("suffix")
                                                 .build())
                                         .prefix("prefix")
                                         .suffix("suffix")
                                         .unitScaler("unitScaler")
                                         .useBlankCellFormat(false)
                                         .useGrouping(false)
                                         .build())
                                 .build())
                         .disableIndexing(false)
                         .expression("expression")
                         .isIncludedInTopic(false)
                         .neverAggregateInFilter(false)
                         .nonAdditive(false)
                         .notAllowedAggregations(List.of("notAllowedAggregations"))
                         .semanticType(SemanticTypeProperty.builder()
                                 .falseyCellValue("falseyCellValue")
                                 .falseyCellValueSynonyms(List.of("falseyCellValueSynonyms"))
                                 .subTypeName("subTypeName")
                                 .truthyCellValue("truthyCellValue")
                                 .truthyCellValueSynonyms(List.of("truthyCellValueSynonyms"))
                                 .typeName("typeName")
                                 .typeParameters(Map.of(
                                         "typeParametersKey", "typeParameters"))
                                 .build())
                         .timeGranularity("timeGranularity")
                         .build()))
                 .columns(List.of(TopicColumnProperty.builder()
                         .aggregation("aggregation")
                         .allowedAggregations(List.of("allowedAggregations"))
                         .cellValueSynonyms(List.of(CellValueSynonymProperty.builder()
                                 .cellValue("cellValue")
                                 .synonyms(List.of("synonyms"))
                                 .build()))
                         .columnDataRole("columnDataRole")
                         .columnDescription("columnDescription")
                         .columnFriendlyName("columnFriendlyName")
                         .columnName("columnName")
                         .columnSynonyms(List.of("columnSynonyms"))
                         .comparativeOrder(ComparativeOrderProperty.builder()
                                 .specifedOrder(List.of("specifedOrder"))
                                 .treatUndefinedSpecifiedValues("treatUndefinedSpecifiedValues")
                                 .useOrdering("useOrdering")
                                 .build())
                         .defaultFormatting(DefaultFormattingProperty.builder()
                                 .displayFormat("displayFormat")
                                 .displayFormatOptions(DisplayFormatOptionsProperty.builder()
                                         .blankCellFormat("blankCellFormat")
                                         .currencySymbol("currencySymbol")
                                         .dateFormat("dateFormat")
                                         .decimalSeparator("decimalSeparator")
                                         .fractionDigits(123)
                                         .groupingSeparator("groupingSeparator")
                                         .negativeFormat(NegativeFormatProperty.builder()
                                                 .prefix("prefix")
                                                 .suffix("suffix")
                                                 .build())
                                         .prefix("prefix")
                                         .suffix("suffix")
                                         .unitScaler("unitScaler")
                                         .useBlankCellFormat(false)
                                         .useGrouping(false)
                                         .build())
                                 .build())
                         .disableIndexing(false)
                         .isIncludedInTopic(false)
                         .neverAggregateInFilter(false)
                         .nonAdditive(false)
                         .notAllowedAggregations(List.of("notAllowedAggregations"))
                         .semanticType(SemanticTypeProperty.builder()
                                 .falseyCellValue("falseyCellValue")
                                 .falseyCellValueSynonyms(List.of("falseyCellValueSynonyms"))
                                 .subTypeName("subTypeName")
                                 .truthyCellValue("truthyCellValue")
                                 .truthyCellValueSynonyms(List.of("truthyCellValueSynonyms"))
                                 .typeName("typeName")
                                 .typeParameters(Map.of(
                                         "typeParametersKey", "typeParameters"))
                                 .build())
                         .timeGranularity("timeGranularity")
                         .build()))
                 .dataAggregation(DataAggregationProperty.builder()
                         .datasetRowDateGranularity("datasetRowDateGranularity")
                         .defaultDateColumnName("defaultDateColumnName")
                         .build())
                 .datasetArn("datasetArn")
                 .datasetDescription("datasetDescription")
                 .datasetName("datasetName")
                 .filters(List.of(TopicFilterProperty.builder()
                         .categoryFilter(TopicCategoryFilterProperty.builder()
                                 .categoryFilterFunction("categoryFilterFunction")
                                 .categoryFilterType("categoryFilterType")
                                 .constant(TopicCategoryFilterConstantProperty.builder()
                                         .collectiveConstant(CollectiveConstantProperty.builder()
                                                 .valueList(List.of("valueList"))
                                                 .build())
                                         .constantType("constantType")
                                         .singularConstant("singularConstant")
                                         .build())
                                 .inverse(false)
                                 .build())
                         .dateRangeFilter(TopicDateRangeFilterProperty.builder()
                                 .constant(TopicRangeFilterConstantProperty.builder()
                                         .constantType("constantType")
                                         .rangeConstant(RangeConstantProperty.builder()
                                                 .maximum("maximum")
                                                 .minimum("minimum")
                                                 .build())
                                         .build())
                                 .inclusive(false)
                                 .build())
                         .filterClass("filterClass")
                         .filterDescription("filterDescription")
                         .filterName("filterName")
                         .filterSynonyms(List.of("filterSynonyms"))
                         .filterType("filterType")
                         .numericEqualityFilter(TopicNumericEqualityFilterProperty.builder()
                                 .aggregation("aggregation")
                                 .constant(TopicSingularFilterConstantProperty.builder()
                                         .constantType("constantType")
                                         .singularConstant("singularConstant")
                                         .build())
                                 .build())
                         .numericRangeFilter(TopicNumericRangeFilterProperty.builder()
                                 .aggregation("aggregation")
                                 .constant(TopicRangeFilterConstantProperty.builder()
                                         .constantType("constantType")
                                         .rangeConstant(RangeConstantProperty.builder()
                                                 .maximum("maximum")
                                                 .minimum("minimum")
                                                 .build())
                                         .build())
                                 .inclusive(false)
                                 .build())
                         .operandFieldName("operandFieldName")
                         .relativeDateFilter(TopicRelativeDateFilterProperty.builder()
                                 .constant(TopicSingularFilterConstantProperty.builder()
                                         .constantType("constantType")
                                         .singularConstant("singularConstant")
                                         .build())
                                 .relativeDateFilterFunction("relativeDateFilterFunction")
                                 .timeGranularity("timeGranularity")
                                 .build())
                         .build()))
                 .namedEntities(List.of(TopicNamedEntityProperty.builder()
                         .definition(List.of(NamedEntityDefinitionProperty.builder()
                                 .fieldName("fieldName")
                                 .metric(NamedEntityDefinitionMetricProperty.builder()
                                         .aggregation("aggregation")
                                         .aggregationFunctionParameters(Map.of(
                                                 "aggregationFunctionParametersKey", "aggregationFunctionParameters"))
                                         .build())
                                 .propertyName("propertyName")
                                 .propertyRole("propertyRole")
                                 .propertyUsage("propertyUsage")
                                 .build()))
                         .entityDescription("entityDescription")
                         .entityName("entityName")
                         .entitySynonyms(List.of("entitySynonyms"))
                         .semanticEntityType(SemanticEntityTypeProperty.builder()
                                 .subTypeName("subTypeName")
                                 .typeName("typeName")
                                 .typeParameters(Map.of(
                                         "typeParametersKey", "typeParameters"))
                                 .build())
                         .build()))
                 .build()))
         .description("description")
         .folderArns(List.of("folderArns"))
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .topicId("topicId")
         .userExperienceVersion("userExperienceVersion")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTopicPropsMixin.Builder	A fluent builder for CfnTopicPropsMixin.
static interface	CfnTopicPropsMixin.CellValueSynonymProperty	A structure that represents the cell value synonym.
static interface	CfnTopicPropsMixin.CollectiveConstantProperty	A structure that represents a collective constant.
static interface	CfnTopicPropsMixin.ComparativeOrderProperty	The order in which data is displayed for the column when it's used in a comparative context.
static interface	CfnTopicPropsMixin.CustomInstructionsProperty	Example:
static interface	CfnTopicPropsMixin.DataAggregationProperty	The definition of a data aggregation.
static interface	CfnTopicPropsMixin.DatasetMetadataProperty	A structure that represents a dataset.
static interface	CfnTopicPropsMixin.DefaultFormattingProperty	A structure that represents a default formatting definition.
static interface	CfnTopicPropsMixin.DisplayFormatOptionsProperty	A structure that represents additional options for display formatting.
static interface	CfnTopicPropsMixin.NamedEntityDefinitionMetricProperty	A structure that represents a metric.
static interface	CfnTopicPropsMixin.NamedEntityDefinitionProperty	A structure that represents a named entity.
static interface	CfnTopicPropsMixin.NegativeFormatProperty	A structure that represents a negative format.
static interface	CfnTopicPropsMixin.RangeConstantProperty	The value of the constant that is used to specify the endpoints of a range filter.
static interface	CfnTopicPropsMixin.SemanticEntityTypeProperty	A structure that represents a semantic entity type.
static interface	CfnTopicPropsMixin.SemanticTypeProperty	A structure that represents a semantic type.
static interface	CfnTopicPropsMixin.TopicCalculatedFieldProperty	A structure that represents a calculated field.
static interface	CfnTopicPropsMixin.TopicCategoryFilterConstantProperty	A constant used in a category filter.
static interface	CfnTopicPropsMixin.TopicCategoryFilterProperty	A structure that represents a category filter.
static interface	CfnTopicPropsMixin.TopicColumnProperty	Represents a column in a dataset.
static interface	CfnTopicPropsMixin.TopicConfigOptionsProperty	Configuration options for a Topic .
static interface	CfnTopicPropsMixin.TopicDateRangeFilterProperty	A filter used to restrict data based on a range of dates or times.
static interface	CfnTopicPropsMixin.TopicFilterProperty	A structure that represents a filter used to select items for a topic.
static interface	CfnTopicPropsMixin.TopicNamedEntityProperty	A structure that represents a named entity.
static interface	CfnTopicPropsMixin.TopicNumericEqualityFilterProperty	A filter that filters topics based on the value of a numeric field.
static interface	CfnTopicPropsMixin.TopicNumericRangeFilterProperty	A filter that filters topics based on the value of a numeric field.
static interface	CfnTopicPropsMixin.TopicRangeFilterConstantProperty	A constant value that is used in a range filter to specify the endpoints of the range.
static interface	CfnTopicPropsMixin.TopicRelativeDateFilterProperty	A structure that represents a relative date filter.
static interface	CfnTopicPropsMixin.TopicSingularFilterConstantProperty	A structure that represents a singular filter constant, used in filters to specify a single value to match against.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnTopicPropsMixin(CfnTopicMixinProps props)	Create a mixin to apply properties to AWS::QuickSight::Topic.
	CfnTopicPropsMixin(CfnTopicMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::QuickSight::Topic.
protected	CfnTopicPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTopicPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnTopicMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnTopicPropsMixin

protected CfnTopicPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnTopicPropsMixin

protected CfnTopicPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTopicPropsMixin

@Stability(Stable)
public CfnTopicPropsMixin(@NotNull
 CfnTopicMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::QuickSight::Topic.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnTopicPropsMixin

@Stability(Stable)
public CfnTopicPropsMixin(@NotNull
 CfnTopicMixinProps props)

Create a mixin to apply properties to AWS::QuickSight::Topic.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnTopicMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()