interface CustomFilterConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDashboard.CustomFilterConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_CustomFilterConfigurationProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDashboard.CustomFilterConfigurationProperty`
Python	`aws_cdk.aws_quicksight.CfnDashboard.CustomFilterConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDashboard` » `CustomFilterConfigurationProperty`

A custom filter that filters based on a single value.

This filter can be partially matched.

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 customFilterConfigurationProperty: quicksight.CfnDashboard.CustomFilterConfigurationProperty = {
  matchOperator: 'matchOperator',
  nullOption: 'nullOption',

  // the properties below are optional
  categoryValue: 'categoryValue',
  parameterName: 'parameterName',
  selectAllOptions: 'selectAllOptions',
};

Properties

Name	Type	Description
matchOperator	`string`	The match operator that is used to determine if a filter should be applied.
nullOption	`string`	This option determines how null values should be treated when filtering data.
categoryValue?	`string`	The category value for the filter.
parameterName?	`string`	The parameter whose value should be used for the filter value.
selectAllOptions?	`string`	Select all of the values. Null is not the assigned value of select all.

matchOperator

Type: string

The match operator that is used to determine if a filter should be applied.

nullOption

Type: string

This option determines how null values should be treated when filtering data.

ALL_VALUES : Include null values in filtered results.
NULLS_ONLY : Only include null values in filtered results.
NON_NULLS_ONLY : Exclude null values from filtered results.

categoryValue?

Type: string (optional)

The category value for the filter.

This field is mutually exclusive to ParameterName .

parameterName?

Type: string (optional)

The parameter whose value should be used for the filter value.

This field is mutually exclusive to CategoryValue .

selectAllOptions?

Type: string (optional)

Select all of the values. Null is not the assigned value of select all.

FILTER_ALL_VALUES