This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::QuickSight::Dashboard NumericEqualityFilter
A NumericEqualityFilter filters values that are equal to the specified value.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AggregationFunction" :AggregationFunction, "Column" :ColumnIdentifier, "DefaultFilterControlConfiguration" :DefaultFilterControlConfiguration, "FilterId" :String, "MatchOperator" :String, "NullOption" :String, "ParameterName" :String, "SelectAllOptions" :String, "Value" :Number}
YAML
AggregationFunction:AggregationFunctionColumn:ColumnIdentifierDefaultFilterControlConfiguration:DefaultFilterControlConfigurationFilterId:StringMatchOperator:StringNullOption:StringParameterName:StringSelectAllOptions:StringValue:Number
Properties
AggregationFunction-
The aggregation function of the filter.
Required: No
Type: AggregationFunction
Update requires: No interruption
Column-
The column that the filter is applied to.
Required: Yes
Type: ColumnIdentifier
Update requires: No interruption
DefaultFilterControlConfiguration-
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
Required: No
Type: DefaultFilterControlConfiguration
Update requires: No interruption
FilterId-
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
Required: Yes
Type: String
Pattern:
^[\w\-]+$Minimum:
1Maximum:
512Update requires: No interruption
MatchOperator-
The match operator that is used to determine if a filter should be applied.
Required: Yes
Type: String
Allowed values:
EQUALS | DOES_NOT_EQUALUpdate requires: No interruption
NullOption-
This option determines how null values should be treated when filtering data.
-
ALL_VALUES: Include null values in filtered results. -
NULLS_ONLY: Only include null values in filtered results. -
NON_NULLS_ONLY: Exclude null values from filtered results.
Required: Yes
Type: String
Allowed values:
ALL_VALUES | NULLS_ONLY | NON_NULLS_ONLYUpdate requires: No interruption
-
ParameterName-
The parameter whose value should be used for the filter value.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9]+$Minimum:
1Maximum:
2048Update requires: No interruption
SelectAllOptions-
Select all of the values. Null is not the assigned value of select all.
-
FILTER_ALL_VALUES
Required: No
Type: String
Allowed values:
FILTER_ALL_VALUESUpdate requires: No interruption
-
Value-
The input value.
Required: No
Type: Number
Update requires: No interruption
