AWS CDK Reference

Appearance

v2.275.0

DateDimensionFieldProperty Struct ​

The dimension type field with date type columns.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const dateDimensionFieldProperty: quicksight.CfnTemplate.DateDimensionFieldProperty = {
  column: {
    columnName: 'columnName',

    // the properties below are optional
    dataSetIdentifier: 'dataSetIdentifier',
    topicIdentifier: 'topicIdentifier',
  },
  fieldId: 'fieldId',

  // the properties below are optional
  dateGranularity: 'dateGranularity',
  formatConfiguration: {
    dateTimeFormat: 'dateTimeFormat',
    nullValueFormatConfiguration: {
      nullString: 'nullString',
    },
    numericFormatConfiguration: {
      currencyDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
        symbol: 'symbol',
      },
      numberDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        numberScale: 'numberScale',
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
      percentageDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            groupingStyle: 'groupingStyle',
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
    },
  },
  hierarchyId: 'hierarchyId',
};

Properties ​

columnIResolvable | CfnTemplate.ColumnIdentifierPropertycolumntyping.Union[IResolvable, ColumnIdentifierProperty]columnIResolvableColumnIResolvableColumninterface{}required#
The column that is used in the `DateDimensionField` .
dateGranularityoptionalstringdate_granularityoptionalstrdateGranularityoptionalStringDateGranularityoptionalstringDateGranularityoptional*string#
The date granularity of the `DateDimensionField` . Choose one of the following options:.
  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • SECOND
  • MILLISECOND
fieldIdstringfield_idstrfieldIdStringFieldIdstringFieldId*stringrequired#
The custom field ID.
formatConfigurationoptionalIResolvable | CfnTemplate.DateTimeFormatConfigurationPropertyformat_configurationoptionaltyping.Union[IResolvable, DateTimeFormatConfigurationProperty]formatConfigurationoptionalIResolvableFormatConfigurationoptionalIResolvableFormatConfigurationoptionalinterface{}#
The format configuration of the field.
hierarchyIdoptionalstringhierarchy_idoptionalstrhierarchyIdoptionalStringHierarchyIdoptionalstringHierarchyIdoptional*string#
The custom hierarchy ID.