aws-cdk-lib.aws_quicksight.CfnAnalysis.MeasureFieldProperty

MeasureFieldProperty Struct

The measure (metric) type field.

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 measureFieldProperty: quicksight.CfnAnalysis.MeasureFieldProperty = {
  calculatedMeasureField: {
    expression: 'expression',
    fieldId: 'fieldId',
  },
  categoricalMeasureField: {
    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',
        },
      },
    },
  },
  dateMeasureField: {
    column: {
      columnName: 'columnName',

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

    // the properties below are optional
    aggregationFunction: 'aggregationFunction',
    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: {
              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',
        },
      },
    },
  },
  numericalMeasureField: {
    column: {
      columnName: 'columnName',

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

    // the properties below are optional
    aggregationFunction: {
      percentileAggregation: {
        percentileValue: 123,
      },
      simpleNumericalAggregation: 'simpleNumericalAggregation',
    },
    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',
        },
      },
    },
  },
};

Properties

calculatedMeasureField?optionalIResolvable | CfnAnalysis.CalculatedMeasureFieldPropertycalculated_measure_field?optionaltyping.Union[IResolvable, CalculatedMeasureFieldProperty]calculatedMeasureField?optionalIResolvableCalculatedMeasureField?optionalIResolvableCalculatedMeasureField?optionalinterface{}#

The calculated measure field only used in pivot tables.

categoricalMeasureField?optionalIResolvable | CfnAnalysis.CategoricalMeasureFieldPropertycategorical_measure_field?optionaltyping.Union[IResolvable, CategoricalMeasureFieldProperty]categoricalMeasureField?optionalIResolvableCategoricalMeasureField?optionalIResolvableCategoricalMeasureField?optionalinterface{}#

The measure type field with categorical type columns.

dateMeasureField?optionalIResolvable | CfnAnalysis.DateMeasureFieldPropertydate_measure_field?optionaltyping.Union[IResolvable, DateMeasureFieldProperty]dateMeasureField?optionalIResolvableDateMeasureField?optionalIResolvableDateMeasureField?optionalinterface{}#

The measure type field with date type columns.

numericalMeasureField?optionalIResolvable | CfnAnalysis.NumericalMeasureFieldPropertynumerical_measure_field?optionaltyping.Union[IResolvable, NumericalMeasureFieldProperty]numericalMeasureField?optionalIResolvableNumericalMeasureField?optionalIResolvableNumericalMeasureField?optionalinterface{}#

The measure type field with numerical type columns.