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::Analysis TimeRangeFilter
<a name="aws-properties-quicksight-analysis-timerangefilter"></a>

A `TimeRangeFilter` filters values that are between two specified values.

## Syntax
<a name="aws-properties-quicksight-analysis-timerangefilter-syntax"></a>

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

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

```
{
  "[Column](#cfn-quicksight-analysis-timerangefilter-column)" : ColumnIdentifier,
  "[DefaultFilterControlConfiguration](#cfn-quicksight-analysis-timerangefilter-defaultfiltercontrolconfiguration)" : DefaultFilterControlConfiguration,
  "[ExcludePeriodConfiguration](#cfn-quicksight-analysis-timerangefilter-excludeperiodconfiguration)" : ExcludePeriodConfiguration,
  "[FilterId](#cfn-quicksight-analysis-timerangefilter-filterid)" : String,
  "[IncludeMaximum](#cfn-quicksight-analysis-timerangefilter-includemaximum)" : Boolean,
  "[IncludeMinimum](#cfn-quicksight-analysis-timerangefilter-includeminimum)" : Boolean,
  "[NullOption](#cfn-quicksight-analysis-timerangefilter-nulloption)" : String,
  "[RangeMaximumValue](#cfn-quicksight-analysis-timerangefilter-rangemaximumvalue)" : TimeRangeFilterValue,
  "[RangeMinimumValue](#cfn-quicksight-analysis-timerangefilter-rangeminimumvalue)" : TimeRangeFilterValue,
  "[TimeGranularity](#cfn-quicksight-analysis-timerangefilter-timegranularity)" : String
}
```

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

```
  [Column](#cfn-quicksight-analysis-timerangefilter-column): 
    ColumnIdentifier
  [DefaultFilterControlConfiguration](#cfn-quicksight-analysis-timerangefilter-defaultfiltercontrolconfiguration): 
    DefaultFilterControlConfiguration
  [ExcludePeriodConfiguration](#cfn-quicksight-analysis-timerangefilter-excludeperiodconfiguration): 
    ExcludePeriodConfiguration
  [FilterId](#cfn-quicksight-analysis-timerangefilter-filterid): String
  [IncludeMaximum](#cfn-quicksight-analysis-timerangefilter-includemaximum): Boolean
  [IncludeMinimum](#cfn-quicksight-analysis-timerangefilter-includeminimum): Boolean
  [NullOption](#cfn-quicksight-analysis-timerangefilter-nulloption): String
  [RangeMaximumValue](#cfn-quicksight-analysis-timerangefilter-rangemaximumvalue): 
    TimeRangeFilterValue
  [RangeMinimumValue](#cfn-quicksight-analysis-timerangefilter-rangeminimumvalue): 
    TimeRangeFilterValue
  [TimeGranularity](#cfn-quicksight-analysis-timerangefilter-timegranularity): String
```

## Properties
<a name="aws-properties-quicksight-analysis-timerangefilter-properties"></a>

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

`ExcludePeriodConfiguration`  <a name="cfn-quicksight-analysis-timerangefilter-excludeperiodconfiguration"></a>
The exclude period of the time range filter.  
*Required*: No  
*Type*: [ExcludePeriodConfiguration](aws-properties-quicksight-analysis-excludeperiodconfiguration.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-analysis-timerangefilter-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-analysis-timerangefilter-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-analysis-timerangefilter-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-analysis-timerangefilter-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)

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

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

`TimeGranularity`  <a name="cfn-quicksight-analysis-timerangefilter-timegranularity"></a>
The level of time precision that is used to aggregate `DateTime` values.  
*Required*: No  
*Type*: String  
*Allowed values*: `YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECOND`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)