AWS::QuickSight::Template DateDimensionField
The dimension type field with date type columns.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Column" :
ColumnIdentifier
, "DateGranularity" :String
, "FieldId" :String
, "FormatConfiguration" :DateTimeFormatConfiguration
, "HierarchyId" :String
}
YAML
Column:
ColumnIdentifier
DateGranularity:String
FieldId:String
FormatConfiguration:DateTimeFormatConfiguration
HierarchyId:String
Properties
Column
-
The column that is used in the
DateDimensionField
.Required: Yes
Type: ColumnIdentifier
Update requires: No interruption
DateGranularity
-
The date granularity of the
DateDimensionField
. Choose one of the following options:-
YEAR
-
QUARTER
-
MONTH
-
WEEK
-
DAY
-
HOUR
-
MINUTE
-
SECOND
-
MILLISECOND
Required: No
Type: String
Allowed values:
YEAR | QUARTER | MONTH | WEEK | DAY | HOUR | MINUTE | SECOND | MILLISECOND
Update requires: No interruption
-
FieldId
-
The custom field ID.
Required: Yes
Type: String
Minimum:
1
Maximum:
512
Update requires: No interruption
FormatConfiguration
-
The format configuration of the field.
Required: No
Type: DateTimeFormatConfiguration
Update requires: No interruption
HierarchyId
-
The custom hierarchy ID.
Required: No
Type: String
Minimum:
1
Maximum:
512
Update requires: No interruption