aws-cdk-lib.aws_quicksight.CfnTemplate.NumericalDimensionFieldProperty

NumericalDimensionFieldProperty Struct

The dimension type field with numerical type columns.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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 numericalDimensionFieldProperty: quicksight.CfnTemplate.NumericalDimensionFieldProperty = {
  column: {
    columnName: 'columnName',

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

  // the properties below are optional
  formatConfiguration: {
    formatConfiguration: {
      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 `NumericalDimensionField` .

fieldIdstringfield_idstrfieldIdStringFieldIdstringFieldId*stringrequired#

The custom field ID.

formatConfigurationIResolvable | CfnTemplate.NumberFormatConfigurationPropertyformat_configurationtyping.Union[IResolvable, NumberFormatConfigurationProperty]formatConfigurationIResolvableFormatConfigurationIResolvableFormatConfigurationinterface{}#

The format configuration of the field.

hierarchyIdstringhierarchy_idstrhierarchyIdStringHierarchyIdstringHierarchyId*string#

The custom hierarchy ID.