interface CfnTopicProps

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTopicProps
Java	software.amazon.awscdk.services.quicksight.CfnTopicProps
Python	aws_cdk.aws_quicksight.CfnTopicProps
TypeScript	@aws-cdk/aws-quicksight » CfnTopicProps

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 * as quicksight from '@aws-cdk/aws-quicksight';
const cfnTopicProps: quicksight.CfnTopicProps = {
  awsAccountId: 'awsAccountId',
  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,
        },
      },
      isIncludedInTopic: false,
      neverAggregateInFilter: 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,
        },
      },
      isIncludedInTopic: false,
      neverAggregateInFilter: 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',
  name: 'name',
  topicId: 'topicId',
};

Properties

Name	Type	Description
awsAccountId?	string	The ID of the AWS account that you want to create a topic in.
dataSets?	IResolvable | IResolvable | DatasetMetadataProperty[]	The data sets that the topic is associated with.
description?	string	The description of the topic.
name?	string	The name of the topic.
topicId?	string	The ID for the topic.

---

awsAccountId?

Type: string (optional)

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

---

dataSets?

Type: IResolvable | IResolvable | DatasetMetadataProperty[] (optional)

The data sets that the topic is associated with.

---

description?

Type: string (optional)

The description of the topic.

---

name?

Type: string (optional)

The name of the topic.

---

topicId?

Type: string (optional)

The ID for the topic.

This ID is unique per AWS Region for each AWS account.