interface CfnMetricProps

Language	Type name
.NET	`Amazon.CDK.AWS.Connect.CfnMetricProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsconnect#CfnMetricProps`
Java	`software.amazon.awscdk.services.connect.CfnMetricProps`
Python	`aws_cdk.aws_connect.CfnMetricProps`
TypeScript	`aws-cdk-lib` » `aws_connect` » `CfnMetricProps`

Properties for defining a CfnMetric.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-metric.html

Example

// 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',

  // the properties below are optional
  description: 'description',
  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',
  positiveTrendIndicator: 'positiveTrendIndicator',
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  unit: 'unit',
};

Properties

Name	Type	Description
instanceArn	`string`	The identifier of the Amazon Connect instance.
description?	`string`	The description of the custom metric.
metricCalculation?	`IResolvable` `\|` `MetricCalculationProperty`	The calculation configuration for the metric.
name?	`string`	The name of the custom metric.
positiveTrendIndicator?	`string`	Indicates how to classify a positive trend in metric data on the UI.
status?	`string`	The status of the custom metric.
tags?	`CfnTag[]`	One or more tags.
unit?	`string`	Display unit for the metric data.