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:
ColumnIdentifier
DefaultFilterControlConfiguration:DefaultFilterControlConfiguration
FilterId:String
ParameterName:String
RollingDate:RollingDateConfiguration
TimeGranularity:String
Value: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:
1
Maximum:
512
Update requires: No interruption
ParameterName
-
The parameter whose value should be used for the filter value.
This field is mutually exclusive to
Value
andRollingDate
.Required: No
Type: String
Pattern:
^[a-zA-Z0-9]+$
Minimum:
1
Maximum:
2048
Update requires: No interruption
RollingDate
-
The rolling date input for the
TimeEquality
filter.This field is mutually exclusive to
Value
andParameterName
.Required: No
Type: RollingDateConfiguration
Update requires: No interruption
TimeGranularity
-
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
Value
-
The value of a
TimeEquality
filter.This field is mutually exclusive to
RollingDate
andParameterName
.Required: No
Type: String
Update requires: No interruption