aws-cdk-lib.aws_quicksight.CfnAnalysis.CustomFilterConfigurationProperty

interface CustomFilterConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnAnalysis.CustomFilterConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnAnalysis_CustomFilterConfigurationProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnAnalysis.CustomFilterConfigurationProperty
Pythonaws_cdk.aws_quicksight.CfnAnalysis.CustomFilterConfigurationProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnAnalysis » 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.CfnAnalysis.CustomFilterConfigurationProperty = {
  matchOperator: 'matchOperator',
  nullOption: 'nullOption',

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

Properties

NameTypeDescription
matchOperatorstringThe match operator that is used to determine if a filter should be applied.
nullOptionstringThis option determines how null values should be treated when filtering data.
categoryValue?stringThe category value for the filter.
parameterName?stringThe parameter whose value should be used for the filter value.
selectAllOptions?stringSelect 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