AWS::Evidently::Experiment MetricGoalObject - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Evidently::Experiment MetricGoalObject

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

Syntax

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

JSON

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

YAML

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

Properties

DesiredChange

INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

Required: Yes

Type: String

Allowed values: INCREASE | DECREASE

Update requires: No interruption

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 JSON path to reference the numerical metric value in the event.

Required: Yes

Type: String

Update requires: No interruption