AWS CDK Reference

Appearance

v2.274.0

StringFormatConfigurationProperty Struct ​

Formatting configuration for string fields.

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 stringFormatConfigurationProperty: quicksight.CfnTemplate.StringFormatConfigurationProperty = {
  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',
    },
  },
};

Properties ​

nullValueFormatConfigurationoptionalIResolvable | CfnTemplate.NullValueFormatConfigurationPropertynull_value_format_configurationoptionaltyping.Union[IResolvable, NullValueFormatConfigurationProperty]nullValueFormatConfigurationoptionalIResolvableNullValueFormatConfigurationoptionalIResolvableNullValueFormatConfigurationoptionalinterface{}#
The options that determine the null value format configuration.
numericFormatConfigurationoptionalIResolvable | CfnTemplate.NumericFormatConfigurationPropertynumeric_format_configurationoptionaltyping.Union[IResolvable, NumericFormatConfigurationProperty]numericFormatConfigurationoptionalIResolvableNumericFormatConfigurationoptionalIResolvableNumericFormatConfigurationoptionalinterface{}#
The formatting configuration for numeric strings.