Skip to content
v2.277.0

CategoricalMeasureFieldProperty Struct ​

The measure type field with categorical type columns.

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 categoricalMeasureFieldProperty: quicksight.CfnAnalysis.CategoricalMeasureFieldProperty = {
  column: {
    columnName: 'columnName',

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

  // the properties below are optional
  aggregationFunction: 'aggregationFunction',
  formatConfiguration: {
    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

categorical_measure_field_property = quicksight.CfnAnalysis.CategoricalMeasureFieldProperty(
    column=quicksight.CfnAnalysis.ColumnIdentifierProperty(
        column_name="columnName",

        # the properties below are optional
        data_set_identifier="dataSetIdentifier",
        topic_identifier="topicIdentifier"
    ),
    field_id="fieldId",

    # the properties below are optional
    aggregation_function="aggregationFunction",
    format_configuration=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.*;

CategoricalMeasureFieldProperty categoricalMeasureFieldProperty = CategoricalMeasureFieldProperty.builder()
        .column(ColumnIdentifierProperty.builder()
                .columnName("columnName")

                // the properties below are optional
                .dataSetIdentifier("dataSetIdentifier")
                .topicIdentifier("topicIdentifier")
                .build())
        .fieldId("fieldId")

        // the properties below are optional
        .aggregationFunction("aggregationFunction")
        .formatConfiguration(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())
        .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 categoricalMeasureFieldProperty = new CategoricalMeasureFieldProperty {
    Column = new ColumnIdentifierProperty {
        ColumnName = "columnName",

        // the properties below are optional
        DataSetIdentifier = "dataSetIdentifier",
        TopicIdentifier = "topicIdentifier"
    },
    FieldId = "fieldId",

    // the properties below are optional
    AggregationFunction = "aggregationFunction",
    FormatConfiguration = 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"

categoricalMeasureFieldProperty := &CategoricalMeasureFieldProperty{
	Column: &ColumnIdentifierProperty{
		ColumnName: jsii.String("columnName"),

		// the properties below are optional
		DataSetIdentifier: jsii.String("dataSetIdentifier"),
		TopicIdentifier: jsii.String("topicIdentifier"),
	},
	FieldId: jsii.String("fieldId"),

	// the properties below are optional
	AggregationFunction: jsii.String("aggregationFunction"),
	FormatConfiguration: &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 ​

aggregationFunctionoptionalstringaggregation_functionoptionalstraggregationFunctionoptionalStringAggregationFunctionoptionalstringAggregationFunctionoptional*string#
The aggregation function of the measure field.
The column that is used in the `CategoricalMeasureField` .
fieldIdstringfield_idstrfieldIdStringFieldIdstringFieldId*stringrequired#
The custom field ID.
formatConfigurationoptionalIResolvable | CfnAnalysis.StringFormatConfigurationPropertyformat_configurationoptionaltyping.Union[IResolvable, StringFormatConfigurationProperty]formatConfigurationoptionalIResolvableFormatConfigurationoptionalIResolvableFormatConfigurationoptionalinterface{}#
The format configuration of the field.