java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:08.303Z") @Stability(Stable) public class CfnTopic extends CfnResource implements IInspectable
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")
         .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")
         .name("name")
         .topicId("topicId")
         .userExperienceVersion("userExperienceVersion")
         .build();
 

See Also:
  • 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)
      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)
      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.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • 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.
    • getDataSets

      @Stability(Stable) @Nullable public Object getDataSets()
      The data sets that the topic is associated with.
    • 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.
    • 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.
    • 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.