interface KPIConfigurationProperty

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

The configuration of a KPI visual.

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 kPIConfigurationProperty: quicksight.CfnTemplate.KPIConfigurationProperty = {
  fieldWells: {
    targetValues: [{
      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',
            },
          },
        },
      },
    }],
    trendGroups: [{
      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',
            },
          },
        },
      },
    }],
  },
  kpiOptions: {
    comparison: {
      comparisonFormat: {
        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',
        },
      },
      comparisonMethod: 'comparisonMethod',
    },
    primaryValueDisplayType: 'primaryValueDisplayType',
    primaryValueFontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontSize: {
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    progressBar: {
      visibility: 'visibility',
    },
    secondaryValue: {
      visibility: 'visibility',
    },
    secondaryValueFontConfiguration: {
      fontColor: 'fontColor',
      fontDecoration: 'fontDecoration',
      fontSize: {
        relative: 'relative',
      },
      fontStyle: 'fontStyle',
      fontWeight: {
        name: 'name',
      },
    },
    trendArrows: {
      visibility: 'visibility',
    },
  },
  sortConfiguration: {
    trendGroupSort: [{
      columnSort: {
        direction: 'direction',
        sortBy: {
          columnName: 'columnName',
          dataSetIdentifier: 'dataSetIdentifier',
        },

        // the properties below are optional
        aggregationFunction: {
          categoricalAggregationFunction: 'categoricalAggregationFunction',
          dateAggregationFunction: 'dateAggregationFunction',
          numericalAggregationFunction: {
            percentileAggregation: {
              percentileValue: 123,
            },
            simpleNumericalAggregation: 'simpleNumericalAggregation',
          },
        },
      },
      fieldSort: {
        direction: 'direction',
        fieldId: 'fieldId',
      },
    }],
  },
};

Properties

Name	Type	Description
fieldWells?	IResolvable | KPIFieldWellsProperty	The field well configuration of a KPI visual.
kpiOptions?	IResolvable | KPIOptionsProperty	The options that determine the presentation of a KPI visual.
sortConfiguration?	IResolvable | KPISortConfigurationProperty	The sort configuration of a KPI visual.

---

fieldWells?

Type: IResolvable | KPIFieldWellsProperty (optional)

The field well configuration of a KPI visual.

---

kpiOptions?

Type: IResolvable | KPIOptionsProperty (optional)

The options that determine the presentation of a KPI visual.

---

sortConfiguration?

Type: IResolvable | KPISortConfigurationProperty (optional)

The sort configuration of a KPI visual.