interface TableAggregatedFieldWellsProperty

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

The aggregated field well for the table.

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 tableAggregatedFieldWellsProperty: quicksight.CfnTemplate.TableAggregatedFieldWellsProperty = {
  groupBy: [{
    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',
    },
  }],
  values: [{
    calculatedMeasureField: {
      expression: 'expression',
      fieldId: 'fieldId',
    },
    categoricalMeasureField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      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: {
                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',
          },
        },
      },
    },
    dateMeasureField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      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: {
                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',
          },
        },
      },
    },
    numericalMeasureField: {
      column: {
        columnName: 'columnName',
        dataSetIdentifier: 'dataSetIdentifier',
      },
      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: {
                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',
          },
        },
      },
    },
  }],
};

Properties

Name	Type	Description
groupBy?	IResolvable | IResolvable | DimensionFieldProperty[]	The group by field well for a pivot table.
values?	IResolvable | IResolvable | MeasureFieldProperty[]	The values field well for a pivot table.

---

groupBy?

Type: IResolvable | IResolvable | DimensionFieldProperty[] (optional)

The group by field well for a pivot table.

Values are grouped by group by fields.

---

values?

Type: IResolvable | IResolvable | MeasureFieldProperty[] (optional)

The values field well for a pivot table.

Values are aggregated based on group by fields.