aws-cdk-lib.aws_quicksight.CfnTemplate.DateDimensionFieldProperty

interface DateDimensionFieldProperty

LanguageType name
.NETAmazon.CDK.AWS.QuickSight.CfnTemplate.DateDimensionFieldProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_DateDimensionFieldProperty
Javasoftware.amazon.awscdk.services.quicksight.CfnTemplate.DateDimensionFieldProperty
Pythonaws_cdk.aws_quicksight.CfnTemplate.DateDimensionFieldProperty
TypeScript aws-cdk-lib » aws_quicksight » CfnTemplate » 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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const dateDimensionFieldProperty: quicksight.CfnTemplate.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

NameTypeDescription
columnIResolvable | ColumnIdentifierPropertyThe column that is used in the DateDimensionField .
fieldIdstringThe custom field ID.
dateGranularity?stringThe date granularity of the DateDimensionField . Choose one of the following options:.
formatConfiguration?IResolvable | DateTimeFormatConfigurationPropertyThe format configuration of the field.
hierarchyId?stringThe 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.