aws-cdk-lib.aws_quicksight.CfnTemplate.CategoryFilterProperty

interface CategoryFilterProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.CategoryFilterProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_CategoryFilterProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.CategoryFilterProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.CategoryFilterProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTemplate » CategoryFilterProperty

A CategoryFilter filters text values.

For more information, see Adding text filters in the Amazon QuickSight User Guide .

Example

// 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 categoryFilterProperty: quicksight.CfnTemplate.CategoryFilterProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  configuration: {
    customFilterConfiguration: {
      matchOperator: 'matchOperator',
      nullOption: 'nullOption',

      // the properties below are optional
      categoryValue: 'categoryValue',
      parameterName: 'parameterName',
      selectAllOptions: 'selectAllOptions',
    },
    customFilterListConfiguration: {
      matchOperator: 'matchOperator',
      nullOption: 'nullOption',

      // the properties below are optional
      categoryValues: ['categoryValues'],
      selectAllOptions: 'selectAllOptions',
    },
    filterListConfiguration: {
      matchOperator: 'matchOperator',

      // the properties below are optional
      categoryValues: ['categoryValues'],
      selectAllOptions: 'selectAllOptions',
    },
  },
  filterId: 'filterId',
};

Properties

NameTypeDescription
columnIResolvable | ColumnIdentifierPropertyThe column that the filter is applied to.
configurationIResolvable | CategoryFilterConfigurationPropertyThe configuration for a CategoryFilter .
filterIdstringAn identifier that uniquely identifies a filter within a dashboard, analysis, or template.

column

Type: IResolvable | ColumnIdentifierProperty

The column that the filter is applied to.


configuration

Type: IResolvable | CategoryFilterConfigurationProperty

The configuration for a CategoryFilter .


filterId

Type: string

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.