AWS::QuickSight::Template NumericEqualityFilter - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::QuickSight::Template NumericEqualityFilter

A NumericEqualityFilter filters values that are equal to the specified value.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AggregationFunction" : AggregationFunction,
  "Column" : ColumnIdentifier,
  "FilterId" : String,
  "MatchOperator" : String,
  "NullOption" : String,
  "ParameterName" : String,
  "SelectAllOptions" : String,
  "Value" : Double
}

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

FilterId

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Required: Yes

Type: String

Minimum: 1

Maximum: 512

Pattern: [\w\-]+

Update requires: No interruption

MatchOperator

The match operator that is used to determine if a filter should be applied.

Required: Yes

Type: String

Allowed values: DOES_NOT_EQUAL | EQUALS

Update 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 | NON_NULLS_ONLY | NULLS_ONLY

Update requires: No interruption

ParameterName

The parameter whose value should be used for the filter value.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Pattern: ^[a-zA-Z0-9]+$

Update 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_VALUES

Update requires: No interruption

Value

The input value.

Required: No

Type: Double

Update requires: No interruption