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 RelativeDatesFilter
<a name="aws-properties-quicksight-analysis-relativedatesfilter"></a>

A `RelativeDatesFilter` filters relative dates values.

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

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

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

```
{
  "[AnchorDateConfiguration](#cfn-quicksight-analysis-relativedatesfilter-anchordateconfiguration)" : AnchorDateConfiguration,
  "[Column](#cfn-quicksight-analysis-relativedatesfilter-column)" : ColumnIdentifier,
  "[DefaultFilterControlConfiguration](#cfn-quicksight-analysis-relativedatesfilter-defaultfiltercontrolconfiguration)" : DefaultFilterControlConfiguration,
  "[ExcludePeriodConfiguration](#cfn-quicksight-analysis-relativedatesfilter-excludeperiodconfiguration)" : ExcludePeriodConfiguration,
  "[FilterId](#cfn-quicksight-analysis-relativedatesfilter-filterid)" : String,
  "[MinimumGranularity](#cfn-quicksight-analysis-relativedatesfilter-minimumgranularity)" : String,
  "[NullOption](#cfn-quicksight-analysis-relativedatesfilter-nulloption)" : String,
  "[ParameterName](#cfn-quicksight-analysis-relativedatesfilter-parametername)" : String,
  "[RelativeDateType](#cfn-quicksight-analysis-relativedatesfilter-relativedatetype)" : String,
  "[RelativeDateValue](#cfn-quicksight-analysis-relativedatesfilter-relativedatevalue)" : Number,
  "[TimeGranularity](#cfn-quicksight-analysis-relativedatesfilter-timegranularity)" : String
}
```

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

```
  [AnchorDateConfiguration](#cfn-quicksight-analysis-relativedatesfilter-anchordateconfiguration): 
    AnchorDateConfiguration
  [Column](#cfn-quicksight-analysis-relativedatesfilter-column): 
    ColumnIdentifier
  [DefaultFilterControlConfiguration](#cfn-quicksight-analysis-relativedatesfilter-defaultfiltercontrolconfiguration): 
    DefaultFilterControlConfiguration
  [ExcludePeriodConfiguration](#cfn-quicksight-analysis-relativedatesfilter-excludeperiodconfiguration): 
    ExcludePeriodConfiguration
  [FilterId](#cfn-quicksight-analysis-relativedatesfilter-filterid): String
  [MinimumGranularity](#cfn-quicksight-analysis-relativedatesfilter-minimumgranularity): String
  [NullOption](#cfn-quicksight-analysis-relativedatesfilter-nulloption): String
  [ParameterName](#cfn-quicksight-analysis-relativedatesfilter-parametername): String
  [RelativeDateType](#cfn-quicksight-analysis-relativedatesfilter-relativedatetype): String
  [RelativeDateValue](#cfn-quicksight-analysis-relativedatesfilter-relativedatevalue): Number
  [TimeGranularity](#cfn-quicksight-analysis-relativedatesfilter-timegranularity): String
```

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

`AnchorDateConfiguration`  <a name="cfn-quicksight-analysis-relativedatesfilter-anchordateconfiguration"></a>
The date configuration of the filter.  
*Required*: Yes  
*Type*: [AnchorDateConfiguration](aws-properties-quicksight-analysis-anchordateconfiguration.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-analysis-relativedatesfilter-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-relativedatesfilter-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-relativedatesfilter-excludeperiodconfiguration"></a>
The configuration for the exclude period of the 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-relativedatesfilter-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)

`MinimumGranularity`  <a name="cfn-quicksight-analysis-relativedatesfilter-minimumgranularity"></a>
The minimum granularity (period granularity) of the relative dates filter.  
*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)

`NullOption`  <a name="cfn-quicksight-analysis-relativedatesfilter-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)

`ParameterName`  <a name="cfn-quicksight-analysis-relativedatesfilter-parametername"></a>
The parameter whose value should be used for the filter value.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]+$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RelativeDateType`  <a name="cfn-quicksight-analysis-relativedatesfilter-relativedatetype"></a>
The range date type of the filter. Choose one of the options below:  
+  `PREVIOUS` 
+  `THIS` 
+  `LAST` 
+  `NOW` 
+  `NEXT` 
*Required*: Yes  
*Type*: String  
*Allowed values*: `PREVIOUS | THIS | LAST | NOW | NEXT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RelativeDateValue`  <a name="cfn-quicksight-analysis-relativedatesfilter-relativedatevalue"></a>
The date value of the filter.  
*Required*: No  
*Type*: Number  
*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-relativedatesfilter-timegranularity"></a>
The level of time precision that is used to aggregate `DateTime` values.  
*Required*: Yes  
*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)