interface DateDimensionFieldProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnAnalysis.DateDimensionFieldProperty
Java	software.amazon.awscdk.services.quicksight.CfnAnalysis.DateDimensionFieldProperty
Python	aws_cdk.aws_quicksight.CfnAnalysis.DateDimensionFieldProperty
TypeScript	@aws-cdk/aws-quicksight » CfnAnalysis » DateDimensionFieldProperty

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 * as quicksight from '@aws-cdk/aws-quicksight';
const dateDimensionFieldProperty: quicksight.CfnAnalysis.DateDimensionFieldProperty = {
  column: {
    columnName: 'columnName',
    dataSetIdentifier: 'dataSetIdentifier',
  },
  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: {
            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: {
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
      percentageDisplayFormatConfiguration: {
        decimalPlacesConfiguration: {
          decimalPlaces: 123,
        },
        negativeValueConfiguration: {
          displayMode: 'displayMode',
        },
        nullValueFormatConfiguration: {
          nullString: 'nullString',
        },
        prefix: 'prefix',
        separatorConfiguration: {
          decimalSeparator: 'decimalSeparator',
          thousandsSeparator: {
            symbol: 'symbol',
            visibility: 'visibility',
          },
        },
        suffix: 'suffix',
      },
    },
  },
  hierarchyId: 'hierarchyId',
};

Properties

Name	Type	Description
column	IResolvable | ColumnIdentifierProperty	The column that is used in the DateDimensionField .
fieldId	string	The custom field ID.
dateGranularity?	string	The date granularity of the DateDimensionField . Choose one of the following options:.
formatConfiguration?	IResolvable | DateTimeFormatConfigurationProperty	The format configuration of the field.
hierarchyId?	string	The custom hierarchy ID.

---

column

Type: IResolvable | ColumnIdentifierProperty

The column that is used in the DateDimensionField .

---

fieldId

Type: string

The custom field ID.

---

dateGranularity?

Type: string (optional)

The date granularity of the DateDimensionField . Choose one of the following options:.

• YEAR
• QUARTER
• MONTH
• WEEK
• DAY
• HOUR
• MINUTE
• SECOND
• MILLISECOND

---

formatConfiguration?

Type: IResolvable | DateTimeFormatConfigurationProperty (optional)

The format configuration of the field.

---

hierarchyId?

Type: string (optional)

The custom hierarchy ID.