AWS::Evidently::Launch MetricDefinitionObject

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "EntityIdKey" : String,
  "EventPattern" : String,
  "MetricName" : String,
  "UnitLabel" : String,
  "ValueKey" : String
}

YAML

  EntityIdKey: String
  EventPattern: String
  MetricName: String
  UnitLabel: String
  ValueKey: String

Properties

EntityIdKey

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.

Required: Yes

Type: String

Update requires: No interruption

EventPattern

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

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

Required: No

Type: String

Update requires: No interruption

MetricName

A name for the metric. It can include up to 255 characters.

Required: Yes

Type: String

Pattern: ^[\S]+$

Minimum: 1

Maximum: 255

Update requires: No interruption

UnitLabel

A label for the units that the metric is measuring.

Required: No

Type: String

Pattern: .*

Minimum: 1

Maximum: 256

Update requires: No interruption

ValueKey

The value that is tracked to produce the metric.

Required: Yes

Type: String

Update requires: No interruption