interface DimensionFieldProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnAnalysis.DimensionFieldProperty
Java	software.amazon.awscdk.services.quicksight.CfnAnalysis.DimensionFieldProperty
Python	aws_cdk.aws_quicksight.CfnAnalysis.DimensionFieldProperty
TypeScript	@aws-cdk/aws-quicksight » CfnAnalysis » DimensionFieldProperty

The dimension type field.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
const dimensionFieldProperty: quicksight.CfnAnalysis.DimensionFieldProperty = {
  categoricalDimensionField: {
    column: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
    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: {
              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: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
        percentageDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
      },
    },
    hierarchyId: 'hierarchyId',
  },
  dateDimensionField: {
    column: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
    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: {
              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: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
        percentageDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
      },
    },
    hierarchyId: 'hierarchyId',
  },
  numericalDimensionField: {
    column: {
      columnName: 'columnName',
      dataSetIdentifier: 'dataSetIdentifier',
    },
    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: {
              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: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
        percentageDisplayFormatConfiguration: {
          decimalPlacesConfiguration: {
            decimalPlaces: 123,
          },
          negativeValueConfiguration: {
            displayMode: 'displayMode',
          },
          nullValueFormatConfiguration: {
            nullString: 'nullString',
          },
          prefix: 'prefix',
          separatorConfiguration: {
            decimalSeparator: 'decimalSeparator',
            thousandsSeparator: {
              symbol: 'symbol',
              visibility: 'visibility',
            },
          },
          suffix: 'suffix',
        },
      },
    },
    hierarchyId: 'hierarchyId',
  },
};

Properties

Name	Type	Description
categoricalDimensionField?	IResolvable | CategoricalDimensionFieldProperty	The dimension type field with categorical type columns.
dateDimensionField?	IResolvable | DateDimensionFieldProperty	The dimension type field with date type columns.
numericalDimensionField?	IResolvable | NumericalDimensionFieldProperty	The dimension type field with numerical type columns.

---

categoricalDimensionField?

Type: IResolvable | CategoricalDimensionFieldProperty (optional)

The dimension type field with categorical type columns.

---

dateDimensionField?

Type: IResolvable | DateDimensionFieldProperty (optional)

The dimension type field with date type columns.

---

numericalDimensionField?

Type: IResolvable | NumericalDimensionFieldProperty (optional)

The dimension type field with numerical type columns.