interface CategoryFilterConfigurationProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.QuickSight.CfnDashboard.CategoryFilterConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_CategoryFilterConfigurationProperty |
Java | software.amazon.awscdk.services.quicksight.CfnDashboard.CategoryFilterConfigurationProperty |
Python | aws_cdk.aws_quicksight.CfnDashboard.CategoryFilterConfigurationProperty |
TypeScript | aws-cdk-lib » aws_quicksight » CfnDashboard » 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.CfnDashboard.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'],
nullOption: 'nullOption',
selectAllOptions: 'selectAllOptions',
},
};
Properties
Name | Type | Description |
---|---|---|
custom | IResolvable | Custom | A custom filter that filters based on a single value. |
custom | IResolvable | Custom | A list of custom filter values. |
filter | IResolvable | Filter | A list of filter configurations. |
customFilterConfiguration?
Type:
IResolvable
|
Custom
(optional)
A custom filter that filters based on a single value.
This filter can be partially matched.
customFilterListConfiguration?
Type:
IResolvable
|
Custom
(optional)
A list of custom filter values.
In the Amazon QuickSight console, this filter type is called a custom filter list.
filterListConfiguration?
Type:
IResolvable
|
Filter
(optional)
A list of filter configurations.
In the Amazon QuickSight console, this filter type is called a filter list.