interface MetricDefinitionObjectProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Evidently.Mixins.CfnLaunchPropsMixin.MetricDefinitionObjectProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsevidently/mixins#CfnLaunchPropsMixin_MetricDefinitionObjectProperty
Java	software.amazon.awscdk.mixins.preview.services.evidently.mixins.CfnLaunchPropsMixin.MetricDefinitionObjectProperty
Python	aws_cdk.mixins_preview.aws_evidently.mixins.CfnLaunchPropsMixin.MetricDefinitionObjectProperty
TypeScript	@aws-cdk/mixins-preview » aws_evidently » mixins » CfnLaunchPropsMixin » 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 { mixins as evidently_mixins } from '@aws-cdk/mixins-preview/aws-evidently';
const metricDefinitionObjectProperty: evidently_mixins.CfnLaunchPropsMixin.MetricDefinitionObjectProperty = {
  entityIdKey: 'entityIdKey',
  eventPattern: 'eventPattern',
  metricName: 'metricName',
  unitLabel: 'unitLabel',
  valueKey: 'valueKey',
};

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.
eventPattern?	string	The EventBridge event pattern that defines how the metric is recorded.
metricName?	string	A name for the metric.
unitLabel?	string	A label for the units that the metric is measuring.
valueKey?	string	The value that is tracked to produce the metric.

---

entityIdKey?

Type: string (optional)

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

An example is userDetails.userID .

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

---

eventPattern?

Type: string (optional)

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns .

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

---

metricName?

Type: string (optional)

A name for the metric.

It can include up to 255 characters.

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

---

unitLabel?

Type: string (optional)

A label for the units that the metric is measuring.

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

---

valueKey?

Type: string (optional)

The value that is tracked to produce the metric.

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