aws-cdk-lib.aws_quicksight.CfnAnalysis.DimensionFieldProperty

DimensionFieldProperty Struct

The dimension 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 dimensionFieldProperty: quicksight.CfnAnalysis.DimensionFieldProperty = {
  categoricalDimensionField: {
    column: {
      columnName: 'columnName',

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

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

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

    // the properties below are optional
    dateGranularity: 'dateGranularity',
    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',
        },
      },
    },
    hierarchyId: 'hierarchyId',
  },
  numericalDimensionField: {
    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

categoricalDimensionField?optionalIResolvable | CfnAnalysis.CategoricalDimensionFieldPropertycategorical_dimension_field?optionaltyping.Union[IResolvable, CategoricalDimensionFieldProperty]categoricalDimensionField?optionalIResolvableCategoricalDimensionField?optionalIResolvableCategoricalDimensionField?optionalinterface{}#

The dimension type field with categorical type columns.

dateDimensionField?optionalIResolvable | CfnAnalysis.DateDimensionFieldPropertydate_dimension_field?optionaltyping.Union[IResolvable, DateDimensionFieldProperty]dateDimensionField?optionalIResolvableDateDimensionField?optionalIResolvableDateDimensionField?optionalinterface{}#

The dimension type field with date type columns.

numericalDimensionField?optionalIResolvable | CfnAnalysis.NumericalDimensionFieldPropertynumerical_dimension_field?optionaltyping.Union[IResolvable, NumericalDimensionFieldProperty]numericalDimensionField?optionalIResolvableNumericalDimensionField?optionalIResolvableNumericalDimensionField?optionalinterface{}#

The dimension type field with numerical type columns.