Class CfnExperiment.MetricGoalObjectProperty
Use this structure to tell Evidently whether higher or lower values are desired for a metric that is used in an experiment.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Evidently
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class MetricGoalObjectProperty : Object, CfnExperiment.IMetricGoalObjectProperty
Syntax (vb)
Public Class MetricGoalObjectProperty
Inherits Object
Implements CfnExperiment.IMetricGoalObjectProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Evidently;
var metricGoalObjectProperty = new MetricGoalObjectProperty {
DesiredChange = "desiredChange",
EntityIdKey = "entityIdKey",
MetricName = "metricName",
ValueKey = "valueKey",
// the properties below are optional
EventPattern = "eventPattern",
UnitLabel = "unitLabel"
};
Synopsis
Constructors
MetricGoalObjectProperty() |
Properties
DesiredChange |
|
EntityIdKey | The entity, such as a user or session, that does an action that causes a metric value to be recorded. |
EventPattern | The EventBridge event pattern that defines how the metric is recorded. |
MetricName | A name for the metric. |
UnitLabel | A label for the units that the metric is measuring. |
ValueKey | The JSON path to reference the numerical metric value in the event. |
Constructors
MetricGoalObjectProperty()
public MetricGoalObjectProperty()
Properties
DesiredChange
INCREASE
means that a variation with a higher number for this metric is performing better.
public string DesiredChange { get; set; }
Property Value
System.String
Remarks
DECREASE
means that a variation with a lower number for this metric is performing better.
EntityIdKey
The entity, such as a user or session, that does an action that causes a metric value to be recorded.
public string EntityIdKey { get; set; }
Property Value
System.String
Remarks
EventPattern
The EventBridge event pattern that defines how the metric is recorded.
public string EventPattern { get; set; }
Property Value
System.String
Remarks
For more information about EventBridge event patterns, see Amazon EventBridge event patterns .
MetricName
A name for the metric.
public string MetricName { get; set; }
Property Value
System.String
Remarks
UnitLabel
A label for the units that the metric is measuring.
public string UnitLabel { get; set; }
Property Value
System.String
Remarks
ValueKey
The JSON path to reference the numerical metric value in the event.
public string ValueKey { get; set; }
Property Value
System.String