CategoryFilterConfigurationProperty Struct
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
ts
// 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',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight
category_filter_configuration_property = quicksight.CfnDashboard.CategoryFilterConfigurationProperty(
custom_filter_configuration=quicksight.CfnDashboard.CustomFilterConfigurationProperty(
match_operator="matchOperator",
null_option="nullOption",
# the properties below are optional
category_value="categoryValue",
parameter_name="parameterName",
select_all_options="selectAllOptions"
),
custom_filter_list_configuration=quicksight.CfnDashboard.CustomFilterListConfigurationProperty(
match_operator="matchOperator",
null_option="nullOption",
# the properties below are optional
category_values=["categoryValues"],
select_all_options="selectAllOptions"
),
filter_list_configuration=quicksight.CfnDashboard.FilterListConfigurationProperty(
match_operator="matchOperator",
# the properties below are optional
category_values=["categoryValues"],
null_option="nullOption",
select_all_options="selectAllOptions"
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;
CategoryFilterConfigurationProperty categoryFilterConfigurationProperty = CategoryFilterConfigurationProperty.builder()
.customFilterConfiguration(CustomFilterConfigurationProperty.builder()
.matchOperator("matchOperator")
.nullOption("nullOption")
// the properties below are optional
.categoryValue("categoryValue")
.parameterName("parameterName")
.selectAllOptions("selectAllOptions")
.build())
.customFilterListConfiguration(CustomFilterListConfigurationProperty.builder()
.matchOperator("matchOperator")
.nullOption("nullOption")
// the properties below are optional
.categoryValues(List.of("categoryValues"))
.selectAllOptions("selectAllOptions")
.build())
.filterListConfiguration(FilterListConfigurationProperty.builder()
.matchOperator("matchOperator")
// the properties below are optional
.categoryValues(List.of("categoryValues"))
.nullOption("nullOption")
.selectAllOptions("selectAllOptions")
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;
var categoryFilterConfigurationProperty = new CategoryFilterConfigurationProperty {
CustomFilterConfiguration = new CustomFilterConfigurationProperty {
MatchOperator = "matchOperator",
NullOption = "nullOption",
// the properties below are optional
CategoryValue = "categoryValue",
ParameterName = "parameterName",
SelectAllOptions = "selectAllOptions"
},
CustomFilterListConfiguration = new CustomFilterListConfigurationProperty {
MatchOperator = "matchOperator",
NullOption = "nullOption",
// the properties below are optional
CategoryValues = new [] { "categoryValues" },
SelectAllOptions = "selectAllOptions"
},
FilterListConfiguration = new FilterListConfigurationProperty {
MatchOperator = "matchOperator",
// the properties below are optional
CategoryValues = new [] { "categoryValues" },
NullOption = "nullOption",
SelectAllOptions = "selectAllOptions"
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
categoryFilterConfigurationProperty := &CategoryFilterConfigurationProperty{
CustomFilterConfiguration: &CustomFilterConfigurationProperty{
MatchOperator: jsii.String("matchOperator"),
NullOption: jsii.String("nullOption"),
// the properties below are optional
CategoryValue: jsii.String("categoryValue"),
ParameterName: jsii.String("parameterName"),
SelectAllOptions: jsii.String("selectAllOptions"),
},
CustomFilterListConfiguration: &CustomFilterListConfigurationProperty{
MatchOperator: jsii.String("matchOperator"),
NullOption: jsii.String("nullOption"),
// the properties below are optional
CategoryValues: []*string{
jsii.String("categoryValues"),
},
SelectAllOptions: jsii.String("selectAllOptions"),
},
FilterListConfiguration: &FilterListConfigurationProperty{
MatchOperator: jsii.String("matchOperator"),
// the properties below are optional
CategoryValues: []*string{
jsii.String("categoryValues"),
},
NullOption: jsii.String("nullOption"),
SelectAllOptions: jsii.String("selectAllOptions"),
},
}
Properties
customFilterConfigurationoptionalIResolvable | CfnDashboard.CustomFilterConfigurationPropertycustom_filter_configurationoptionaltyping.Union[IResolvable, CustomFilterConfigurationProperty]customFilterConfigurationoptionalIResolvableCustomFilterConfigurationoptionalIResolvableCustomFilterConfigurationoptionalinterface{}#A custom filter that filters based on a single value.
This filter can be partially matched.
customFilterListConfigurationoptionalIResolvable | CfnDashboard.CustomFilterListConfigurationPropertycustom_filter_list_configurationoptionaltyping.Union[IResolvable, CustomFilterListConfigurationProperty]customFilterListConfigurationoptionalIResolvableCustomFilterListConfigurationoptionalIResolvableCustomFilterListConfigurationoptionalinterface{}#A list of custom filter values.
In the Quick Sight console, this filter type is called a custom filter list.
filterListConfigurationoptionalIResolvable | CfnDashboard.FilterListConfigurationPropertyfilter_list_configurationoptionaltyping.Union[IResolvable, FilterListConfigurationProperty]filterListConfigurationoptionalIResolvableFilterListConfigurationoptionalIResolvableFilterListConfigurationoptionalinterface{}#A list of filter configurations.
In the Quick Sight console, this filter type is called a filter list.