AWS::QuickSight::Dashboard FilterGroup
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CrossDataset" :
String
, "FilterGroupId" :String
, "Filters" :[ Filter, ... ]
, "ScopeConfiguration" :FilterScopeConfiguration
, "Status" :String
}
YAML
CrossDataset:
String
FilterGroupId:String
Filters:- Filter
ScopeConfiguration:FilterScopeConfiguration
Status:String
Properties
CrossDataset
-
The filter new feature which can apply filter group to all data sets. Choose one of the following options:
-
ALL_DATASETS
-
SINGLE_DATASET
Required: Yes
Type: String
Allowed values:
ALL_DATASETS | SINGLE_DATASET
Update requires: No interruption
-
FilterGroupId
-
The value that uniquely identifies a
FilterGroup
within a dashboard, template, or analysis.Required: Yes
Type: String
Pattern:
^[\w\-]+$
Minimum:
1
Maximum:
512
Update requires: No interruption
Filters
-
The list of filters that are present in a
FilterGroup
.Required: Yes
Type: Array of Filter
Minimum:
0
Maximum:
20
Update requires: No interruption
ScopeConfiguration
-
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.
Required: Yes
Type: FilterScopeConfiguration
Update requires: No interruption
Status
-
The status of the
FilterGroup
.Required: No
Type: String
Allowed values:
ENABLED | DISABLED
Update requires: No interruption