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::Template TimeEqualityFilter
A TimeEqualityFilter filters values that are equal to a given value.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Column" :ColumnIdentifier, "DefaultFilterControlConfiguration" :DefaultFilterControlConfiguration, "FilterId" :String, "ParameterName" :String, "RollingDate" :RollingDateConfiguration, "TimeGranularity" :String, "Value" :String}
YAML
Column:ColumnIdentifierDefaultFilterControlConfiguration:DefaultFilterControlConfigurationFilterId:StringParameterName:StringRollingDate:RollingDateConfigurationTimeGranularity:StringValue:String
Properties
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
ParameterName-
The parameter whose value should be used for the filter value.
This field is mutually exclusive to
ValueandRollingDate.Required: No
Type: String
Pattern:
^[a-zA-Z0-9]+$Minimum:
1Maximum:
2048Update requires: No interruption
RollingDate-
The rolling date input for the
TimeEqualityfilter.This field is mutually exclusive to
ValueandParameterName.Required: No
Type: RollingDateConfiguration
Update requires: No interruption
TimeGranularity-
The level of time precision that is used to aggregate
DateTimevalues.Required: No
Type: String
Allowed values:
YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECONDUpdate requires: No interruption
Value-
The value of a
TimeEqualityfilter.This field is mutually exclusive to
RollingDateandParameterName.Required: No
Type: String
Update requires: No interruption
