aws-cdk-lib.aws_quicksight.CfnTemplate.CategoryFilterConfigurationProperty

interface CategoryFilterConfigurationProperty

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

The configuration for a CategoryFilter .

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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 categoryFilterConfigurationProperty: quicksight.CfnTemplate.CategoryFilterConfigurationProperty = {
  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',
  },
};

Properties

NameTypeDescription
customFilterConfiguration?IResolvable | CustomFilterConfigurationPropertyA custom filter that filters based on a single value.
customFilterListConfiguration?IResolvable | CustomFilterListConfigurationPropertyA list of custom filter values.
filterListConfiguration?IResolvable | FilterListConfigurationPropertyA list of filter configurations.

customFilterConfiguration?

Type: IResolvable | CustomFilterConfigurationProperty (optional)

A custom filter that filters based on a single value.

This filter can be partially matched.


customFilterListConfiguration?

Type: IResolvable | CustomFilterListConfigurationProperty (optional)

A list of custom filter values.

In the Amazon QuickSight console, this filter type is called a custom filter list.


filterListConfiguration?

Type: IResolvable | FilterListConfigurationProperty (optional)

A list of filter configurations.

In the Amazon QuickSight console, this filter type is called a filter list.