Skip to content
v2.274.0

CfnMetricProps Struct ​

Properties for defining a CfnMetric.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';
const cfnMetricProps: connect.CfnMetricProps = {
  instanceArn: 'instanceArn',
  metricCalculation: {
    calculation: 'calculation',
    calculationComponents: [{
      alias: 'alias',

      // the properties below are optional
      metricFilters: [{
        metricFilterKey: 'metricFilterKey',

        // the properties below are optional
        booleanCondition: {
          comparison: 'comparison',
        },
        negate: false,
        numberCondition: {
          comparison: 'comparison',
          values: [123],
        },
        stringCondition: {
          comparison: 'comparison',
          values: ['values'],
        },
      }],
      metricId: 'metricId',
      metricName: 'metricName',
    }],
  },
  name: 'name',
  status: 'status',
  unit: 'unit',

  // the properties below are optional
  description: 'description',
  positiveTrendIndicator: 'positiveTrendIndicator',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the custom metric.
instanceArnstringinstance_arnstrinstanceArnStringInstanceArnstringInstanceArn*stringrequired#
The identifier of the Amazon Connect instance.
metricCalculationIResolvable | CfnMetric.MetricCalculationPropertymetric_calculationtyping.Union[IResolvable, MetricCalculationProperty]metricCalculationIResolvableMetricCalculationIResolvableMetricCalculationinterface{}required#
The calculation configuration for the metric.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the custom metric.
positiveTrendIndicatoroptionalstringpositive_trend_indicatoroptionalstrpositiveTrendIndicatoroptionalStringPositiveTrendIndicatoroptionalstringPositiveTrendIndicatoroptional*string#
Indicates how to classify a positive trend in metric data on the UI.
statusstringstatusstrstatusStringStatusstringStatus*stringrequired#
The status of the custom metric.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
One or more tags.
unitstringunitstrunitStringUnitstringUnit*stringrequired#
Display unit for the metric data.