

This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::QuickSight::Dashboard NumericRangeFilter
<a name="aws-properties-quicksight-dashboard-numericrangefilter"></a>

A `NumericRangeFilter` filters values that are within the value range.

## Syntax
<a name="aws-properties-quicksight-dashboard-numericrangefilter-syntax"></a>

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

### JSON
<a name="aws-properties-quicksight-dashboard-numericrangefilter-syntax.json"></a>

```
{
  "[AggregationFunction](#cfn-quicksight-dashboard-numericrangefilter-aggregationfunction)" : AggregationFunction,
  "[Column](#cfn-quicksight-dashboard-numericrangefilter-column)" : ColumnIdentifier,
  "[DefaultFilterControlConfiguration](#cfn-quicksight-dashboard-numericrangefilter-defaultfiltercontrolconfiguration)" : DefaultFilterControlConfiguration,
  "[FilterId](#cfn-quicksight-dashboard-numericrangefilter-filterid)" : String,
  "[IncludeMaximum](#cfn-quicksight-dashboard-numericrangefilter-includemaximum)" : Boolean,
  "[IncludeMinimum](#cfn-quicksight-dashboard-numericrangefilter-includeminimum)" : Boolean,
  "[NullOption](#cfn-quicksight-dashboard-numericrangefilter-nulloption)" : String,
  "[RangeMaximum](#cfn-quicksight-dashboard-numericrangefilter-rangemaximum)" : NumericRangeFilterValue,
  "[RangeMinimum](#cfn-quicksight-dashboard-numericrangefilter-rangeminimum)" : NumericRangeFilterValue,
  "[SelectAllOptions](#cfn-quicksight-dashboard-numericrangefilter-selectalloptions)" : String
}
```

### YAML
<a name="aws-properties-quicksight-dashboard-numericrangefilter-syntax.yaml"></a>

```
  [AggregationFunction](#cfn-quicksight-dashboard-numericrangefilter-aggregationfunction): 
    AggregationFunction
  [Column](#cfn-quicksight-dashboard-numericrangefilter-column): 
    ColumnIdentifier
  [DefaultFilterControlConfiguration](#cfn-quicksight-dashboard-numericrangefilter-defaultfiltercontrolconfiguration): 
    DefaultFilterControlConfiguration
  [FilterId](#cfn-quicksight-dashboard-numericrangefilter-filterid): String
  [IncludeMaximum](#cfn-quicksight-dashboard-numericrangefilter-includemaximum): Boolean
  [IncludeMinimum](#cfn-quicksight-dashboard-numericrangefilter-includeminimum): Boolean
  [NullOption](#cfn-quicksight-dashboard-numericrangefilter-nulloption): String
  [RangeMaximum](#cfn-quicksight-dashboard-numericrangefilter-rangemaximum): 
    NumericRangeFilterValue
  [RangeMinimum](#cfn-quicksight-dashboard-numericrangefilter-rangeminimum): 
    NumericRangeFilterValue
  [SelectAllOptions](#cfn-quicksight-dashboard-numericrangefilter-selectalloptions): String
```

## Properties
<a name="aws-properties-quicksight-dashboard-numericrangefilter-properties"></a>

`AggregationFunction`  <a name="cfn-quicksight-dashboard-numericrangefilter-aggregationfunction"></a>
The aggregation function of the filter.  
*Required*: No  
*Type*: [AggregationFunction](aws-properties-quicksight-dashboard-aggregationfunction.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Column`  <a name="cfn-quicksight-dashboard-numericrangefilter-column"></a>
The column that the filter is applied to.  
*Required*: Yes  
*Type*: [ColumnIdentifier](aws-properties-quicksight-dashboard-columnidentifier.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DefaultFilterControlConfiguration`  <a name="cfn-quicksight-dashboard-numericrangefilter-defaultfiltercontrolconfiguration"></a>
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.  
*Required*: No  
*Type*: [DefaultFilterControlConfiguration](aws-properties-quicksight-dashboard-defaultfiltercontrolconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FilterId`  <a name="cfn-quicksight-dashboard-numericrangefilter-filterid"></a>
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\w\-]+$`  
*Minimum*: `1`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IncludeMaximum`  <a name="cfn-quicksight-dashboard-numericrangefilter-includemaximum"></a>
Determines whether the maximum value in the filter value range should be included in the filtered results.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IncludeMinimum`  <a name="cfn-quicksight-dashboard-numericrangefilter-includeminimum"></a>
Determines whether the minimum value in the filter value range should be included in the filtered results.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NullOption`  <a name="cfn-quicksight-dashboard-numericrangefilter-nulloption"></a>
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_ONLY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RangeMaximum`  <a name="cfn-quicksight-dashboard-numericrangefilter-rangemaximum"></a>
The maximum value for the filter value range.  
*Required*: No  
*Type*: [NumericRangeFilterValue](aws-properties-quicksight-dashboard-numericrangefiltervalue.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RangeMinimum`  <a name="cfn-quicksight-dashboard-numericrangefilter-rangeminimum"></a>
The minimum value for the filter value range.  
*Required*: No  
*Type*: [NumericRangeFilterValue](aws-properties-quicksight-dashboard-numericrangefiltervalue.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SelectAllOptions`  <a name="cfn-quicksight-dashboard-numericrangefilter-selectalloptions"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)