Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.FilterGroupProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.FilterGroupProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.FilterGroupProperty
extends software.amazon.jsii.JsiiSerializable

A grouping of individual filters. Filter groups are applied to the same group of visuals.

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide .

Example:

 // 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.*;
 FilterGroupProperty filterGroupProperty = FilterGroupProperty.builder()
         .crossDataset("crossDataset")
         .filterGroupId("filterGroupId")
         .filters(List.of(FilterProperty.builder()
                 .categoryFilter(CategoryFilterProperty.builder()
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .configuration(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"))
                                         .selectAllOptions("selectAllOptions")
                                         .build())
                                 .build())
                         .filterId("filterId")
                         .build())
                 .numericEqualityFilter(NumericEqualityFilterProperty.builder()
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .filterId("filterId")
                         .matchOperator("matchOperator")
                         .nullOption("nullOption")
                         // the properties below are optional
                         .aggregationFunction(AggregationFunctionProperty.builder()
                                 .categoricalAggregationFunction("categoricalAggregationFunction")
                                 .dateAggregationFunction("dateAggregationFunction")
                                 .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                         .percentileAggregation(PercentileAggregationProperty.builder()
                                                 .percentileValue(123)
                                                 .build())
                                         .simpleNumericalAggregation("simpleNumericalAggregation")
                                         .build())
                                 .build())
                         .parameterName("parameterName")
                         .selectAllOptions("selectAllOptions")
                         .value(123)
                         .build())
                 .numericRangeFilter(NumericRangeFilterProperty.builder()
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .filterId("filterId")
                         .nullOption("nullOption")
                         // the properties below are optional
                         .aggregationFunction(AggregationFunctionProperty.builder()
                                 .categoricalAggregationFunction("categoricalAggregationFunction")
                                 .dateAggregationFunction("dateAggregationFunction")
                                 .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                         .percentileAggregation(PercentileAggregationProperty.builder()
                                                 .percentileValue(123)
                                                 .build())
                                         .simpleNumericalAggregation("simpleNumericalAggregation")
                                         .build())
                                 .build())
                         .includeMaximum(false)
                         .includeMinimum(false)
                         .rangeMaximum(NumericRangeFilterValueProperty.builder()
                                 .parameter("parameter")
                                 .staticValue(123)
                                 .build())
                         .rangeMinimum(NumericRangeFilterValueProperty.builder()
                                 .parameter("parameter")
                                 .staticValue(123)
                                 .build())
                         .selectAllOptions("selectAllOptions")
                         .build())
                 .relativeDatesFilter(RelativeDatesFilterProperty.builder()
                         .anchorDateConfiguration(AnchorDateConfigurationProperty.builder()
                                 .anchorOption("anchorOption")
                                 .parameterName("parameterName")
                                 .build())
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .filterId("filterId")
                         .nullOption("nullOption")
                         .relativeDateType("relativeDateType")
                         .timeGranularity("timeGranularity")
                         // the properties below are optional
                         .excludePeriodConfiguration(ExcludePeriodConfigurationProperty.builder()
                                 .amount(123)
                                 .granularity("granularity")
                                 // the properties below are optional
                                 .status("status")
                                 .build())
                         .minimumGranularity("minimumGranularity")
                         .parameterName("parameterName")
                         .relativeDateValue(123)
                         .build())
                 .timeEqualityFilter(TimeEqualityFilterProperty.builder()
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .filterId("filterId")
                         // the properties below are optional
                         .parameterName("parameterName")
                         .timeGranularity("timeGranularity")
                         .value("value")
                         .build())
                 .timeRangeFilter(TimeRangeFilterProperty.builder()
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .filterId("filterId")
                         .nullOption("nullOption")
                         // the properties below are optional
                         .excludePeriodConfiguration(ExcludePeriodConfigurationProperty.builder()
                                 .amount(123)
                                 .granularity("granularity")
                                 // the properties below are optional
                                 .status("status")
                                 .build())
                         .includeMaximum(false)
                         .includeMinimum(false)
                         .rangeMaximumValue(TimeRangeFilterValueProperty.builder()
                                 .parameter("parameter")
                                 .rollingDate(RollingDateConfigurationProperty.builder()
                                         .expression("expression")
                                         // the properties below are optional
                                         .dataSetIdentifier("dataSetIdentifier")
                                         .build())
                                 .staticValue("staticValue")
                                 .build())
                         .rangeMinimumValue(TimeRangeFilterValueProperty.builder()
                                 .parameter("parameter")
                                 .rollingDate(RollingDateConfigurationProperty.builder()
                                         .expression("expression")
                                         // the properties below are optional
                                         .dataSetIdentifier("dataSetIdentifier")
                                         .build())
                                 .staticValue("staticValue")
                                 .build())
                         .timeGranularity("timeGranularity")
                         .build())
                 .topBottomFilter(TopBottomFilterProperty.builder()
                         .aggregationSortConfigurations(List.of(AggregationSortConfigurationProperty.builder()
                                 .aggregationFunction(AggregationFunctionProperty.builder()
                                         .categoricalAggregationFunction("categoricalAggregationFunction")
                                         .dateAggregationFunction("dateAggregationFunction")
                                         .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                                 .percentileAggregation(PercentileAggregationProperty.builder()
                                                         .percentileValue(123)
                                                         .build())
                                                 .simpleNumericalAggregation("simpleNumericalAggregation")
                                                 .build())
                                         .build())
                                 .column(ColumnIdentifierProperty.builder()
                                         .columnName("columnName")
                                         .dataSetIdentifier("dataSetIdentifier")
                                         .build())
                                 .sortDirection("sortDirection")
                                 .build()))
                         .column(ColumnIdentifierProperty.builder()
                                 .columnName("columnName")
                                 .dataSetIdentifier("dataSetIdentifier")
                                 .build())
                         .filterId("filterId")
                         // the properties below are optional
                         .limit(123)
                         .parameterName("parameterName")
                         .timeGranularity("timeGranularity")
                         .build())
                 .build()))
         .scopeConfiguration(FilterScopeConfigurationProperty.builder()
                 .selectedSheets(SelectedSheetsFilterScopeConfigurationProperty.builder()
                         .sheetVisualScopingConfigurations(List.of(SheetVisualScopingConfigurationProperty.builder()
                                 .scope("scope")
                                 .sheetId("sheetId")
                                 // the properties below are optional
                                 .visualIds(List.of("visualIds"))
                                 .build()))
                         .build())
                 .build())
         // the properties below are optional
         .status("status")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.FilterGroupProperty.Builder	A builder for CfnDashboard.FilterGroupProperty
static final class	CfnDashboard.FilterGroupProperty.Jsii$Proxy	An implementation for CfnDashboard.FilterGroupProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.FilterGroupProperty.Builder	builder()
String	getCrossDataset()	The filter new feature which can apply filter group to all data sets.
String	getFilterGroupId()	The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.
Object	getFilters()	The list of filters that are present in a FilterGroup .
Object	getScopeConfiguration()	The configuration that specifies what scope to apply to a FilterGroup .
default String	getStatus()	The status of the FilterGroup .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCrossDataset

@Stability(Stable)
@NotNull
String getCrossDataset()

The filter new feature which can apply filter group to all data sets. Choose one of the following options:.

• ALL_DATASETS
• SINGLE_DATASET

getFilterGroupId

@Stability(Stable)
@NotNull
String getFilterGroupId()

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

getFilters

@Stability(Stable)
@NotNull
Object getFilters()

The list of filters that are present in a FilterGroup .

getScopeConfiguration

@Stability(Stable)
@NotNull
Object getScopeConfiguration()

The configuration that specifies what scope to apply to a FilterGroup .

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the FilterGroup .

builder

@Stability(Stable)
static CfnDashboard.FilterGroupProperty.Builder builder()

Returns:

a CfnDashboard.FilterGroupProperty.Builder of CfnDashboard.FilterGroupProperty