AWS CDK Reference

Appearance

v2.277.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.CfnAnalysis.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',
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

string_format_configuration_property = quicksight.CfnAnalysis.StringFormatConfigurationProperty(
    null_value_format_configuration=quicksight.CfnAnalysis.NullValueFormatConfigurationProperty(
        null_string="nullString"
    ),
    numeric_format_configuration=quicksight.CfnAnalysis.NumericFormatConfigurationProperty(
        currency_display_format_configuration=quicksight.CfnAnalysis.CurrencyDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnAnalysis.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnAnalysis.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnAnalysis.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnAnalysis.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnAnalysis.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix",
            symbol="symbol"
        ),
        number_display_format_configuration=quicksight.CfnAnalysis.NumberDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnAnalysis.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnAnalysis.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnAnalysis.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            number_scale="numberScale",
            prefix="prefix",
            separator_configuration=quicksight.CfnAnalysis.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnAnalysis.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        ),
        percentage_display_format_configuration=quicksight.CfnAnalysis.PercentageDisplayFormatConfigurationProperty(
            decimal_places_configuration=quicksight.CfnAnalysis.DecimalPlacesConfigurationProperty(
                decimal_places=123
            ),
            negative_value_configuration=quicksight.CfnAnalysis.NegativeValueConfigurationProperty(
                display_mode="displayMode"
            ),
            null_value_format_configuration=quicksight.CfnAnalysis.NullValueFormatConfigurationProperty(
                null_string="nullString"
            ),
            prefix="prefix",
            separator_configuration=quicksight.CfnAnalysis.NumericSeparatorConfigurationProperty(
                decimal_separator="decimalSeparator",
                thousands_separator=quicksight.CfnAnalysis.ThousandSeparatorOptionsProperty(
                    grouping_style="groupingStyle",
                    symbol="symbol",
                    visibility="visibility"
                )
            ),
            suffix="suffix"
        )
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

StringFormatConfigurationProperty stringFormatConfigurationProperty = StringFormatConfigurationProperty.builder()
        .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
                .nullString("nullString")
                .build())
        .numericFormatConfiguration(NumericFormatConfigurationProperty.builder()
                .currencyDisplayFormatConfiguration(CurrencyDisplayFormatConfigurationProperty.builder()
                        .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
                                .decimalPlaces(123)
                                .build())
                        .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
                                .displayMode("displayMode")
                                .build())
                        .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
                                .nullString("nullString")
                                .build())
                        .numberScale("numberScale")
                        .prefix("prefix")
                        .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
                                .decimalSeparator("decimalSeparator")
                                .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
                                        .groupingStyle("groupingStyle")
                                        .symbol("symbol")
                                        .visibility("visibility")
                                        .build())
                                .build())
                        .suffix("suffix")
                        .symbol("symbol")
                        .build())
                .numberDisplayFormatConfiguration(NumberDisplayFormatConfigurationProperty.builder()
                        .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
                                .decimalPlaces(123)
                                .build())
                        .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
                                .displayMode("displayMode")
                                .build())
                        .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
                                .nullString("nullString")
                                .build())
                        .numberScale("numberScale")
                        .prefix("prefix")
                        .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
                                .decimalSeparator("decimalSeparator")
                                .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
                                        .groupingStyle("groupingStyle")
                                        .symbol("symbol")
                                        .visibility("visibility")
                                        .build())
                                .build())
                        .suffix("suffix")
                        .build())
                .percentageDisplayFormatConfiguration(PercentageDisplayFormatConfigurationProperty.builder()
                        .decimalPlacesConfiguration(DecimalPlacesConfigurationProperty.builder()
                                .decimalPlaces(123)
                                .build())
                        .negativeValueConfiguration(NegativeValueConfigurationProperty.builder()
                                .displayMode("displayMode")
                                .build())
                        .nullValueFormatConfiguration(NullValueFormatConfigurationProperty.builder()
                                .nullString("nullString")
                                .build())
                        .prefix("prefix")
                        .separatorConfiguration(NumericSeparatorConfigurationProperty.builder()
                                .decimalSeparator("decimalSeparator")
                                .thousandsSeparator(ThousandSeparatorOptionsProperty.builder()
                                        .groupingStyle("groupingStyle")
                                        .symbol("symbol")
                                        .visibility("visibility")
                                        .build())
                                .build())
                        .suffix("suffix")
                        .build())
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var stringFormatConfigurationProperty = new StringFormatConfigurationProperty {
    NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
        NullString = "nullString"
    },
    NumericFormatConfiguration = new NumericFormatConfigurationProperty {
        CurrencyDisplayFormatConfiguration = new CurrencyDisplayFormatConfigurationProperty {
            DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                DecimalPlaces = 123
            },
            NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                DisplayMode = "displayMode"
            },
            NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                NullString = "nullString"
            },
            NumberScale = "numberScale",
            Prefix = "prefix",
            SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                DecimalSeparator = "decimalSeparator",
                ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                    GroupingStyle = "groupingStyle",
                    Symbol = "symbol",
                    Visibility = "visibility"
                }
            },
            Suffix = "suffix",
            Symbol = "symbol"
        },
        NumberDisplayFormatConfiguration = new NumberDisplayFormatConfigurationProperty {
            DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                DecimalPlaces = 123
            },
            NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                DisplayMode = "displayMode"
            },
            NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                NullString = "nullString"
            },
            NumberScale = "numberScale",
            Prefix = "prefix",
            SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                DecimalSeparator = "decimalSeparator",
                ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                    GroupingStyle = "groupingStyle",
                    Symbol = "symbol",
                    Visibility = "visibility"
                }
            },
            Suffix = "suffix"
        },
        PercentageDisplayFormatConfiguration = new PercentageDisplayFormatConfigurationProperty {
            DecimalPlacesConfiguration = new DecimalPlacesConfigurationProperty {
                DecimalPlaces = 123
            },
            NegativeValueConfiguration = new NegativeValueConfigurationProperty {
                DisplayMode = "displayMode"
            },
            NullValueFormatConfiguration = new NullValueFormatConfigurationProperty {
                NullString = "nullString"
            },
            Prefix = "prefix",
            SeparatorConfiguration = new NumericSeparatorConfigurationProperty {
                DecimalSeparator = "decimalSeparator",
                ThousandsSeparator = new ThousandSeparatorOptionsProperty {
                    GroupingStyle = "groupingStyle",
                    Symbol = "symbol",
                    Visibility = "visibility"
                }
            },
            Suffix = "suffix"
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

stringFormatConfigurationProperty := &StringFormatConfigurationProperty{
	NullValueFormatConfiguration: &NullValueFormatConfigurationProperty{
		NullString: jsii.String("nullString"),
	},
	NumericFormatConfiguration: &NumericFormatConfigurationProperty{
		CurrencyDisplayFormatConfiguration: &CurrencyDisplayFormatConfigurationProperty{
			DecimalPlacesConfiguration: &DecimalPlacesConfigurationProperty{
				DecimalPlaces: jsii.Number(123),
			},
			NegativeValueConfiguration: &NegativeValueConfigurationProperty{
				DisplayMode: jsii.String("displayMode"),
			},
			NullValueFormatConfiguration: &NullValueFormatConfigurationProperty{
				NullString: jsii.String("nullString"),
			},
			NumberScale: jsii.String("numberScale"),
			Prefix: jsii.String("prefix"),
			SeparatorConfiguration: &NumericSeparatorConfigurationProperty{
				DecimalSeparator: jsii.String("decimalSeparator"),
				ThousandsSeparator: &ThousandSeparatorOptionsProperty{
					GroupingStyle: jsii.String("groupingStyle"),
					Symbol: jsii.String("symbol"),
					Visibility: jsii.String("visibility"),
				},
			},
			Suffix: jsii.String("suffix"),
			Symbol: jsii.String("symbol"),
		},
		NumberDisplayFormatConfiguration: &NumberDisplayFormatConfigurationProperty{
			DecimalPlacesConfiguration: &DecimalPlacesConfigurationProperty{
				DecimalPlaces: jsii.Number(123),
			},
			NegativeValueConfiguration: &NegativeValueConfigurationProperty{
				DisplayMode: jsii.String("displayMode"),
			},
			NullValueFormatConfiguration: &NullValueFormatConfigurationProperty{
				NullString: jsii.String("nullString"),
			},
			NumberScale: jsii.String("numberScale"),
			Prefix: jsii.String("prefix"),
			SeparatorConfiguration: &NumericSeparatorConfigurationProperty{
				DecimalSeparator: jsii.String("decimalSeparator"),
				ThousandsSeparator: &ThousandSeparatorOptionsProperty{
					GroupingStyle: jsii.String("groupingStyle"),
					Symbol: jsii.String("symbol"),
					Visibility: jsii.String("visibility"),
				},
			},
			Suffix: jsii.String("suffix"),
		},
		PercentageDisplayFormatConfiguration: &PercentageDisplayFormatConfigurationProperty{
			DecimalPlacesConfiguration: &DecimalPlacesConfigurationProperty{
				DecimalPlaces: jsii.Number(123),
			},
			NegativeValueConfiguration: &NegativeValueConfigurationProperty{
				DisplayMode: jsii.String("displayMode"),
			},
			NullValueFormatConfiguration: &NullValueFormatConfigurationProperty{
				NullString: jsii.String("nullString"),
			},
			Prefix: jsii.String("prefix"),
			SeparatorConfiguration: &NumericSeparatorConfigurationProperty{
				DecimalSeparator: jsii.String("decimalSeparator"),
				ThousandsSeparator: &ThousandSeparatorOptionsProperty{
					GroupingStyle: jsii.String("groupingStyle"),
					Symbol: jsii.String("symbol"),
					Visibility: jsii.String("visibility"),
				},
			},
			Suffix: jsii.String("suffix"),
		},
	},
}

Properties ​

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