Package software.amazon.awscdk.services.quicksight

Class CfnTopic

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.quicksight.CfnTopic

All Implemented Interfaces:

IInspectable, IEnvironmentAware, ITopicRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:12.341Z")
@Stability(Stable)
public class CfnTopic
extends CfnResource
implements IInspectable, ITopicRef, ITaggableV2

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.services.quicksight.*;
 CfnTopic cfnTopic = CfnTopic.Builder.create(this, "MyCfnTopic")
         .awsAccountId("awsAccountId")
         .configOptions(TopicConfigOptionsProperty.builder()
                 .qBusinessInsightsEnabled(false)
                 .build())
         .customInstructions(CustomInstructionsProperty.builder()
                 .customInstructionsString("customInstructionsString")
                 .build())
         .dataSets(List.of(DatasetMetadataProperty.builder()
                 .datasetArn("datasetArn")
                 // the properties below are optional
                 .calculatedFields(List.of(TopicCalculatedFieldProperty.builder()
                         .calculatedFieldName("calculatedFieldName")
                         .expression("expression")
                         // the properties below are optional
                         .aggregation("aggregation")
                         .allowedAggregations(List.of("allowedAggregations"))
                         .calculatedFieldDescription("calculatedFieldDescription")
                         .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)
                         .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()
                         .columnName("columnName")
                         // the properties below are optional
                         .aggregation("aggregation")
                         .allowedAggregations(List.of("allowedAggregations"))
                         .cellValueSynonyms(List.of(CellValueSynonymProperty.builder()
                                 .cellValue("cellValue")
                                 .synonyms(List.of("synonyms"))
                                 .build()))
                         .columnDataRole("columnDataRole")
                         .columnDescription("columnDescription")
                         .columnFriendlyName("columnFriendlyName")
                         .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())
                 .datasetDescription("datasetDescription")
                 .datasetName("datasetName")
                 .filters(List.of(TopicFilterProperty.builder()
                         .filterName("filterName")
                         .operandFieldName("operandFieldName")
                         // the properties below are optional
                         .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")
                         .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())
                         .relativeDateFilter(TopicRelativeDateFilterProperty.builder()
                                 .constant(TopicSingularFilterConstantProperty.builder()
                                         .constantType("constantType")
                                         .singularConstant("singularConstant")
                                         .build())
                                 .relativeDateFilterFunction("relativeDateFilterFunction")
                                 .timeGranularity("timeGranularity")
                                 .build())
                         .build()))
                 .namedEntities(List.of(TopicNamedEntityProperty.builder()
                         .entityName("entityName")
                         // the properties below are optional
                         .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")
                         .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();
 

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.quicksight.ITopicRef

ITopicRef.Jsii$Default, ITopicRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTopic(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTopic(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTopic(software.constructs.Construct scope, String id)	Create a new AWS::QuickSight::Topic.
	CfnTopic(software.constructs.Construct scope, String id, CfnTopicProps props)	Create a new AWS::QuickSight::Topic.

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the topic.
String	getAwsAccountId()	The ID of the AWS account that you want to create a topic in.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getConfigOptions()	Configuration options for a Topic .
Object	getCustomInstructions()	Returns union: either IResolvable or CfnTopic.CustomInstructionsProperty
Object	getDataSets()	The data sets that the topic is associated with.
String	getDescription()	The description of the topic.
List<String>	getFolderArns()
String	getName()	The name of the topic.
List<CfnTag>	getTags()
String	getTopicId()	The ID for the topic.
TopicReference	getTopicRef()	A reference to a Topic resource.
String	getUserExperienceVersion()	The user experience version of the topic.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value)	The ID of the AWS account that you want to create a topic in.
void	setConfigOptions(IResolvable value)	Configuration options for a Topic .
void	setConfigOptions(CfnTopic.TopicConfigOptionsProperty value)	Configuration options for a Topic .
void	setCustomInstructions(IResolvable value)
void	setCustomInstructions(CfnTopic.CustomInstructionsProperty value)
void	setDataSets(List<Object> value)	The data sets that the topic is associated with.
void	setDataSets(IResolvable value)	The data sets that the topic is associated with.
void	setDescription(String value)	The description of the topic.
void	setFolderArns(List<String> value)
void	setName(String value)	The name of the topic.
void	setTags(List<CfnTag> value)
void	setTopicId(String value)	The ID for the topic.
void	setUserExperienceVersion(String value)	The user experience version of the topic.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTopic

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

CfnTopic

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

CfnTopic

@Stability(Stable)
public CfnTopic(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnTopicProps props)

Create a new AWS::QuickSight::Topic.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnTopic

@Stability(Stable)
public CfnTopic(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::QuickSight::Topic.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the topic.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTopicRef

@Stability(Stable)
@NotNull
public TopicReference getTopicRef()

A reference to a Topic resource.

Specified by:

getTopicRef in interface ITopicRef

getAwsAccountId

@Stability(Stable)
@Nullable
public String getAwsAccountId()

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

setAwsAccountId

@Stability(Stable)
public void setAwsAccountId(@Nullable
 String value)

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

getConfigOptions

@Stability(Stable)
@Nullable
public Object getConfigOptions()

Configuration options for a Topic .

Returns union: either IResolvable or CfnTopic.TopicConfigOptionsProperty

setConfigOptions

@Stability(Stable)
public void setConfigOptions(@Nullable
 IResolvable value)

Configuration options for a Topic .

setConfigOptions

@Stability(Stable)
public void setConfigOptions(@Nullable
 CfnTopic.TopicConfigOptionsProperty value)

Configuration options for a Topic .

getCustomInstructions

@Stability(Stable)
@Nullable
public Object getCustomInstructions()

Returns union: either IResolvable or CfnTopic.CustomInstructionsProperty

setCustomInstructions

@Stability(Stable)
public void setCustomInstructions(@Nullable
 IResolvable value)

setCustomInstructions

@Stability(Stable)
public void setCustomInstructions(@Nullable
 CfnTopic.CustomInstructionsProperty value)

getDataSets

@Stability(Stable)
@Nullable
public Object getDataSets()

The data sets that the topic is associated with.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopic.DatasetMetadataProperty>

setDataSets

@Stability(Stable)
public void setDataSets(@Nullable
 IResolvable value)

The data sets that the topic is associated with.

setDataSets

@Stability(Stable)
public void setDataSets(@Nullable
 List<Object> value)

The data sets that the topic is associated with.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the topic.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the topic.

getFolderArns

@Stability(Stable)
@Nullable
public List<String> getFolderArns()

setFolderArns

@Stability(Stable)
public void setFolderArns(@Nullable
 List<String> value)

getName

@Stability(Stable)
@Nullable
public String getName()

The name of the topic.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the topic.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

getTopicId

@Stability(Stable)
@Nullable
public String getTopicId()

The ID for the topic.

setTopicId

@Stability(Stable)
public void setTopicId(@Nullable
 String value)

The ID for the topic.

getUserExperienceVersion

@Stability(Stable)
@Nullable
public String getUserExperienceVersion()

The user experience version of the topic.

setUserExperienceVersion

@Stability(Stable)
public void setUserExperienceVersion(@Nullable
 String value)

The user experience version of the topic.