CfnTopicProps Struct
Properties for defining a CfnTopic.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const cfnTopicProps: quicksight.CfnTopicProps = {
awsAccountId: 'awsAccountId',
configOptions: {
qBusinessInsightsEnabled: false,
},
customInstructions: {
customInstructionsString: 'customInstructionsString',
},
dataSets: [{
datasetArn: 'datasetArn',
// the properties below are optional
calculatedFields: [{
calculatedFieldName: 'calculatedFieldName',
expression: 'expression',
// the properties below are optional
aggregation: 'aggregation',
allowedAggregations: ['allowedAggregations'],
calculatedFieldDescription: 'calculatedFieldDescription',
calculatedFieldSynonyms: ['calculatedFieldSynonyms'],
cellValueSynonyms: [{
cellValue: 'cellValue',
synonyms: ['synonyms'],
}],
columnDataRole: 'columnDataRole',
comparativeOrder: {
specifedOrder: ['specifedOrder'],
treatUndefinedSpecifiedValues: 'treatUndefinedSpecifiedValues',
useOrdering: 'useOrdering',
},
defaultFormatting: {
displayFormat: 'displayFormat',
displayFormatOptions: {
blankCellFormat: 'blankCellFormat',
currencySymbol: 'currencySymbol',
dateFormat: 'dateFormat',
decimalSeparator: 'decimalSeparator',
fractionDigits: 123,
groupingSeparator: 'groupingSeparator',
negativeFormat: {
prefix: 'prefix',
suffix: 'suffix',
},
prefix: 'prefix',
suffix: 'suffix',
unitScaler: 'unitScaler',
useBlankCellFormat: false,
useGrouping: false,
},
},
disableIndexing: false,
isIncludedInTopic: false,
neverAggregateInFilter: false,
nonAdditive: false,
notAllowedAggregations: ['notAllowedAggregations'],
semanticType: {
falseyCellValue: 'falseyCellValue',
falseyCellValueSynonyms: ['falseyCellValueSynonyms'],
subTypeName: 'subTypeName',
truthyCellValue: 'truthyCellValue',
truthyCellValueSynonyms: ['truthyCellValueSynonyms'],
typeName: 'typeName',
typeParameters: {
typeParametersKey: 'typeParameters',
},
},
timeGranularity: 'timeGranularity',
}],
columns: [{
columnName: 'columnName',
// the properties below are optional
aggregation: 'aggregation',
allowedAggregations: ['allowedAggregations'],
cellValueSynonyms: [{
cellValue: 'cellValue',
synonyms: ['synonyms'],
}],
columnDataRole: 'columnDataRole',
columnDescription: 'columnDescription',
columnFriendlyName: 'columnFriendlyName',
columnSynonyms: ['columnSynonyms'],
comparativeOrder: {
specifedOrder: ['specifedOrder'],
treatUndefinedSpecifiedValues: 'treatUndefinedSpecifiedValues',
useOrdering: 'useOrdering',
},
defaultFormatting: {
displayFormat: 'displayFormat',
displayFormatOptions: {
blankCellFormat: 'blankCellFormat',
currencySymbol: 'currencySymbol',
dateFormat: 'dateFormat',
decimalSeparator: 'decimalSeparator',
fractionDigits: 123,
groupingSeparator: 'groupingSeparator',
negativeFormat: {
prefix: 'prefix',
suffix: 'suffix',
},
prefix: 'prefix',
suffix: 'suffix',
unitScaler: 'unitScaler',
useBlankCellFormat: false,
useGrouping: false,
},
},
disableIndexing: false,
isIncludedInTopic: false,
neverAggregateInFilter: false,
nonAdditive: false,
notAllowedAggregations: ['notAllowedAggregations'],
semanticType: {
falseyCellValue: 'falseyCellValue',
falseyCellValueSynonyms: ['falseyCellValueSynonyms'],
subTypeName: 'subTypeName',
truthyCellValue: 'truthyCellValue',
truthyCellValueSynonyms: ['truthyCellValueSynonyms'],
typeName: 'typeName',
typeParameters: {
typeParametersKey: 'typeParameters',
},
},
timeGranularity: 'timeGranularity',
}],
dataAggregation: {
datasetRowDateGranularity: 'datasetRowDateGranularity',
defaultDateColumnName: 'defaultDateColumnName',
},
datasetDescription: 'datasetDescription',
datasetName: 'datasetName',
filters: [{
filterName: 'filterName',
operandFieldName: 'operandFieldName',
// the properties below are optional
categoryFilter: {
categoryFilterFunction: 'categoryFilterFunction',
categoryFilterType: 'categoryFilterType',
constant: {
collectiveConstant: {
valueList: ['valueList'],
},
constantType: 'constantType',
singularConstant: 'singularConstant',
},
inverse: false,
},
dateRangeFilter: {
constant: {
constantType: 'constantType',
rangeConstant: {
maximum: 'maximum',
minimum: 'minimum',
},
},
inclusive: false,
},
filterClass: 'filterClass',
filterDescription: 'filterDescription',
filterSynonyms: ['filterSynonyms'],
filterType: 'filterType',
numericEqualityFilter: {
aggregation: 'aggregation',
constant: {
constantType: 'constantType',
singularConstant: 'singularConstant',
},
},
numericRangeFilter: {
aggregation: 'aggregation',
constant: {
constantType: 'constantType',
rangeConstant: {
maximum: 'maximum',
minimum: 'minimum',
},
},
inclusive: false,
},
relativeDateFilter: {
constant: {
constantType: 'constantType',
singularConstant: 'singularConstant',
},
relativeDateFilterFunction: 'relativeDateFilterFunction',
timeGranularity: 'timeGranularity',
},
}],
namedEntities: [{
entityName: 'entityName',
// the properties below are optional
definition: [{
fieldName: 'fieldName',
metric: {
aggregation: 'aggregation',
aggregationFunctionParameters: {
aggregationFunctionParametersKey: 'aggregationFunctionParameters',
},
},
propertyName: 'propertyName',
propertyRole: 'propertyRole',
propertyUsage: 'propertyUsage',
}],
entityDescription: 'entityDescription',
entitySynonyms: ['entitySynonyms'],
semanticEntityType: {
subTypeName: 'subTypeName',
typeName: 'typeName',
typeParameters: {
typeParametersKey: 'typeParameters',
},
},
}],
}],
description: 'description',
folderArns: ['folderArns'],
name: 'name',
tags: [{
key: 'key',
value: 'value',
}],
topicId: 'topicId',
userExperienceVersion: 'userExperienceVersion',
};
Properties
The ID of the AWS account that you want to create a topic in.
configOptionsIResolvable | CfnTopic.TopicConfigOptionsPropertyconfig_optionstyping.Union[IResolvable, TopicConfigOptionsProperty]configOptionsIResolvableConfigOptionsIResolvableConfigOptionsinterface{}#Configuration options for a `Topic` .
customInstructionsIResolvable | CfnTopic.CustomInstructionsPropertycustom_instructionstyping.Union[IResolvable, CustomInstructionsProperty]customInstructionsIResolvableCustomInstructionsIResolvableCustomInstructionsinterface{}#<p>Instructions that provide additional guidance and context for response generation.</p>.
dataSetsIResolvable | IResolvable | CfnTopic.DatasetMetadataProperty[]data_setstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DatasetMetadataProperty]]]dataSetsIResolvableDataSetsIResolvableDataSetsinterface{}#The data sets that the topic is associated with.
The description of the topic.
folderArnsstring[]folder_arnstyping.List[str]folderArnsList<String>FolderArnsstring[]FolderArns*[]*string#The name of the topic.
The ID for the topic.
This ID is unique per AWS Region for each AWS account.
userExperienceVersionstringuser_experience_versionstruserExperienceVersionStringUserExperienceVersionstringUserExperienceVersion*string#The user experience version of the topic.