interface MetricDefinitionObjectProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Evidently.CfnLaunch.MetricDefinitionObjectProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsevidently#CfnLaunch_MetricDefinitionObjectProperty`
Java	`software.amazon.awscdk.services.evidently.CfnLaunch.MetricDefinitionObjectProperty`
Python	`aws_cdk.aws_evidently.CfnLaunch.MetricDefinitionObjectProperty`
TypeScript	`aws-cdk-lib` » `aws_evidently` » `CfnLaunch` » `MetricDefinitionObjectProperty`

This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-launch-metricdefinitionobject.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_evidently as evidently } from 'aws-cdk-lib';
const metricDefinitionObjectProperty: evidently.CfnLaunch.MetricDefinitionObjectProperty = {
  entityIdKey: 'entityIdKey',
  metricName: 'metricName',
  valueKey: 'valueKey',

  // the properties below are optional
  eventPattern: 'eventPattern',
  unitLabel: 'unitLabel',
};

Properties

Name	Type	Description
entityIdKey	`string`	The entity, such as a user or session, that does an action that causes a metric value to be recorded.
metricName	`string`	A name for the metric.
valueKey	`string`	The value that is tracked to produce the metric.
eventPattern?	`string`	The EventBridge event pattern that defines how the metric is recorded.
unitLabel?	`string`	A label for the units that the metric is measuring.