All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnTopicProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:12.455Z") @Stability(Stable) public interface CfnTopicProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTopic.

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.*;
 CfnTopicProps cfnTopicProps = CfnTopicProps.builder()
         .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:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnTopicProps.Builder

A builder for CfnTopicProps

static final class

CfnTopicProps.Jsii$Proxy

An implementation for CfnTopicProps
Method Summary

Modifier and Type

Method

Description

static CfnTopicProps.Builder

builder()

default String

getAwsAccountId()

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

default Object

getDataSets()

The data sets that the topic is associated with.

default String

getDescription()

The description of the topic.

default String

getName()

The name of the topic.

default String

getTopicId()

The ID for the topic.

default String

getUserExperienceVersion()

The user experience version of the topic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAwsAccountId
  
  @Stability(Stable) @Nullable default String getAwsAccountId()
  
  The ID of the AWS account that you want to create a topic in.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-awsaccountid
- getDataSets
  
  @Stability(Stable) @Nullable default Object getDataSets()
  
  The data sets that the topic is associated with.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-datasets
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  The description of the topic.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-description
- getName
  
  @Stability(Stable) @Nullable default String getName()
  
  The name of the topic.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-name
- getTopicId
  
  @Stability(Stable) @Nullable default String getTopicId()
  
  The ID for the topic.
  This ID is unique per AWS Region for each AWS account.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-topicid
- getUserExperienceVersion
  
  @Stability(Stable) @Nullable default String getUserExperienceVersion()
  
  The user experience version of the topic.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html#cfn-quicksight-topic-userexperienceversion
- builder
  
  @Stability(Stable) static CfnTopicProps.Builder builder()
  
  Returns:
  
  a CfnTopicProps.Builder of CfnTopicProps

Interface CfnTopicProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAwsAccountId

getDataSets

getDescription

getName

getTopicId

getUserExperienceVersion

builder