interface MetricGoalObjectProperty

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

Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.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 metricGoalObjectProperty: evidently.CfnExperiment.MetricGoalObjectProperty = {
  desiredChange: 'desiredChange',
  entityIdKey: 'entityIdKey',
  metricName: 'metricName',
  valueKey: 'valueKey',

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

Properties

Name	Type	Description
desiredChange	`string`	`INCREASE` means that a variation with a higher number for this metric is performing better.
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 JSON path to reference the numerical metric value in the event.
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.