class CfnTopicPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnTopicPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnTopicPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnTopicPropsMixin
Python	aws_cdk.mixins_preview.aws_quicksight.mixins.CfnTopicPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_quicksight » mixins » CfnTopicPropsMixin

Implements IMixin

Extends Mixin

Creates a new Q topic.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-topic.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as quicksight_mixins } from '@aws-cdk/mixins-preview/aws-quicksight';
const cfnTopicPropsMixin = new quicksight_mixins.CfnTopicPropsMixin({
  awsAccountId: 'awsAccountId',
  configOptions: {
    qBusinessInsightsEnabled: false,
  },
  customInstructions: {
    customInstructionsString: 'customInstructionsString',
  },
  dataSets: [{
    calculatedFields: [{
      aggregation: 'aggregation',
      allowedAggregations: ['allowedAggregations'],
      calculatedFieldDescription: 'calculatedFieldDescription',
      calculatedFieldName: 'calculatedFieldName',
      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,
      expression: 'expression',
      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: [{
      aggregation: 'aggregation',
      allowedAggregations: ['allowedAggregations'],
      cellValueSynonyms: [{
        cellValue: 'cellValue',
        synonyms: ['synonyms'],
      }],
      columnDataRole: 'columnDataRole',
      columnDescription: 'columnDescription',
      columnFriendlyName: 'columnFriendlyName',
      columnName: 'columnName',
      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',
    },
    datasetArn: 'datasetArn',
    datasetDescription: 'datasetDescription',
    datasetName: 'datasetName',
    filters: [{
      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',
      filterName: 'filterName',
      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,
      },
      operandFieldName: 'operandFieldName',
      relativeDateFilter: {
        constant: {
          constantType: 'constantType',
          singularConstant: 'singularConstant',
        },
        relativeDateFilterFunction: 'relativeDateFilterFunction',
        timeGranularity: 'timeGranularity',
      },
    }],
    namedEntities: [{
      definition: [{
        fieldName: 'fieldName',
        metric: {
          aggregation: 'aggregation',
          aggregationFunctionParameters: {
            aggregationFunctionParametersKey: 'aggregationFunctionParameters',
          },
        },
        propertyName: 'propertyName',
        propertyRole: 'propertyRole',
        propertyUsage: 'propertyUsage',
      }],
      entityDescription: 'entityDescription',
      entityName: 'entityName',
      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',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnTopicPropsMixin(props: CfnTopicMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnTopicMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::QuickSight::Topic.

Properties

Name	Type	Description
props	CfnTopicMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnTopicMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.