AWS::QuickSight::Topic TopicFilter
A structure that represents a filter used to select items for a topic.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "CategoryFilter" :TopicCategoryFilter, "DateRangeFilter" :TopicDateRangeFilter, "FilterClass" :String, "FilterDescription" :String, "FilterName" :String, "FilterSynonyms" :[ String, ... ], "FilterType" :String, "NumericEqualityFilter" :TopicNumericEqualityFilter, "NumericRangeFilter" :TopicNumericRangeFilter, "OperandFieldName" :String, "RelativeDateFilter" :TopicRelativeDateFilter}
YAML
CategoryFilter:TopicCategoryFilterDateRangeFilter:TopicDateRangeFilterFilterClass:StringFilterDescription:StringFilterName:StringFilterSynonyms:- StringFilterType:StringNumericEqualityFilter:TopicNumericEqualityFilterNumericRangeFilter:TopicNumericRangeFilterOperandFieldName:StringRelativeDateFilter:TopicRelativeDateFilter
Properties
CategoryFilter-
The category filter that is associated with this filter.
Required: No
Type: TopicCategoryFilter
Update requires: No interruption
DateRangeFilter-
The date range filter.
Required: No
Type: TopicDateRangeFilter
Update requires: No interruption
FilterClass-
The class of the filter. Valid values for this structure are
ENFORCED_VALUE_FILTER,CONDITIONAL_VALUE_FILTER, andNAMED_VALUE_FILTER.Required: No
Type: String
Allowed values:
ENFORCED_VALUE_FILTER | CONDITIONAL_VALUE_FILTER | NAMED_VALUE_FILTERUpdate requires: No interruption
FilterDescription-
A description of the filter used to select items for a topic.
Required: No
Type: String
Minimum:
0Maximum:
256Update requires: No interruption
FilterName-
The name of the filter.
Required: Yes
Type: String
Minimum:
0Maximum:
256Update requires: No interruption
FilterSynonyms-
The other names or aliases for the filter.
Required: No
Type: Array of String
Minimum:
0Maximum:
256Update requires: No interruption
FilterType-
The type of the filter. Valid values for this structure are
CATEGORY_FILTER,NUMERIC_EQUALITY_FILTER,NUMERIC_RANGE_FILTER,DATE_RANGE_FILTER, andRELATIVE_DATE_FILTER.Required: No
Type: String
Allowed values:
CATEGORY_FILTER | NUMERIC_EQUALITY_FILTER | NUMERIC_RANGE_FILTER | DATE_RANGE_FILTER | RELATIVE_DATE_FILTERUpdate requires: No interruption
NumericEqualityFilter-
The numeric equality filter.
Required: No
Type: TopicNumericEqualityFilter
Update requires: No interruption
NumericRangeFilter-
The numeric range filter.
Required: No
Type: TopicNumericRangeFilter
Update requires: No interruption
OperandFieldName-
The name of the field that the filter operates on.
Required: Yes
Type: String
Minimum:
0Maximum:
256Update requires: No interruption
RelativeDateFilter-
The relative date filter.
Required: No
Type: TopicRelativeDateFilter
Update requires: No interruption