Interface CfnTemplate.DateDimensionFieldProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplate.DateDimensionFieldProperty.Jsii$Proxy
- Enclosing class:
CfnTemplate
@Stability(Stable)
public static interface CfnTemplate.DateDimensionFieldProperty
extends software.amazon.jsii.JsiiSerializable
The dimension type field with date type columns.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.quicksight.*; DateDimensionFieldProperty dateDimensionFieldProperty = DateDimensionFieldProperty.builder() .column(ColumnIdentifierProperty.builder() .columnName("columnName") .dataSetIdentifier("dataSetIdentifier") .build()) .fieldId("fieldId") // the properties below are optional .dateGranularity("dateGranularity") .formatConfiguration(DateTimeFormatConfigurationProperty.builder() .dateTimeFormat("dateTimeFormat") .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder() .nullString("nullString") .build()) .numericFormatConfiguration(NumericFormatConfigurationProperty.builder() .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder() .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder() .decimalPlaces(123) .build()) .negativeValueConfiguration(NegativeValueConfigurationProperty.builder() .displayMode("displayMode") .build()) .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder() .nullString("nullString") .build()) .numberScale("numberScale") .prefix("prefix") .separatorConfiguration(NumericSeparatorConfigurationProperty.builder() .decimalSeparator("decimalSeparator") .thousandsSeparator(ThousandSeparatorOptionsProperty.builder() .symbol("symbol") .visibility("visibility") .build()) .build()) .suffix("suffix") .symbol("symbol") .build()) .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder() .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder() .decimalPlaces(123) .build()) .negativeValueConfiguration(NegativeValueConfigurationProperty.builder() .displayMode("displayMode") .build()) .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder() .nullString("nullString") .build()) .numberScale("numberScale") .prefix("prefix") .separatorConfiguration(NumericSeparatorConfigurationProperty.builder() .decimalSeparator("decimalSeparator") .thousandsSeparator(ThousandSeparatorOptionsProperty.builder() .symbol("symbol") .visibility("visibility") .build()) .build()) .suffix("suffix") .build()) .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder() .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder() .decimalPlaces(123) .build()) .negativeValueConfiguration(NegativeValueConfigurationProperty.builder() .displayMode("displayMode") .build()) .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder() .nullString("nullString") .build()) .prefix("prefix") .separatorConfiguration(NumericSeparatorConfigurationProperty.builder() .decimalSeparator("decimalSeparator") .thousandsSeparator(ThousandSeparatorOptionsProperty.builder() .symbol("symbol") .visibility("visibility") .build()) .build()) .suffix("suffix") .build()) .build()) .build()) .hierarchyId("hierarchyId") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplate.DateDimensionFieldProperty
static final class
An implementation forCfnTemplate.DateDimensionFieldProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getColumn
The column that is used in theDateDimensionField
.- See Also:
-
getFieldId
The custom field ID.- See Also:
-
getDateGranularity
The date granularity of theDateDimensionField
. Choose one of the following options:.YEAR
QUARTER
MONTH
WEEK
DAY
HOUR
MINUTE
SECOND
MILLISECOND
- See Also:
-
getFormatConfiguration
The format configuration of the field.- See Also:
-
getHierarchyId
The custom hierarchy ID.- See Also:
-
builder
-