Class CfnExperimentPropsMixin.MetricGoalObjectProperty

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

Inheritance

object

CfnExperimentPropsMixin.MetricGoalObjectProperty

Implements

CfnExperimentPropsMixin.IMetricGoalObjectProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Evidently.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnExperimentPropsMixin.MetricGoalObjectProperty : CfnExperimentPropsMixin.IMetricGoalObjectProperty

Syntax (vb)

Public Class CfnExperimentPropsMixin.MetricGoalObjectProperty Implements CfnExperimentPropsMixin.IMetricGoalObjectProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html

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.Mixins.Preview.AWS.Evidently.Mixins;

             var metricGoalObjectProperty = new MetricGoalObjectProperty {
                 DesiredChange = "desiredChange",
                 EntityIdKey = "entityIdKey",
                 EventPattern = "eventPattern",
                 MetricName = "metricName",
                 UnitLabel = "unitLabel",
                 ValueKey = "valueKey"
             };

Synopsis

Constructors

MetricGoalObjectProperty()

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

Properties

DesiredChange	`INCREASE` means that a variation with a higher 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.
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()

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

public MetricGoalObjectProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html

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.Mixins.Preview.AWS.Evidently.Mixins;

             var metricGoalObjectProperty = new MetricGoalObjectProperty {
                 DesiredChange = "desiredChange",
                 EntityIdKey = "entityIdKey",
                 EventPattern = "eventPattern",
                 MetricName = "metricName",
                 UnitLabel = "unitLabel",
                 ValueKey = "valueKey"
             };

Properties

DesiredChange

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

public string? DesiredChange { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-desiredchange

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

string

Remarks

An example is userDetails.userID .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-entityidkey

EventPattern

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

public string? EventPattern { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-eventpattern

MetricName

A name for the metric.

public string? MetricName { get; set; }

Property Value

string

Remarks

It can include up to 255 characters.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-metricname

UnitLabel

A label for the units that the metric is measuring.

public string? UnitLabel { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-unitlabel

ValueKey

The JSON path to reference the numerical metric value in the event.

public string? ValueKey { get; set; }