2.233.0

interface MetricGoalObjectProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Evidently.Mixins.CfnExperimentPropsMixin.MetricGoalObjectProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsevidently/mixins#CfnExperimentPropsMixin_MetricGoalObjectProperty
Javasoftware.amazon.awscdk.mixins.preview.services.evidently.mixins.CfnExperimentPropsMixin.MetricGoalObjectProperty
Pythonaws_cdk.mixins_preview.aws_evidently.mixins.CfnExperimentPropsMixin.MetricGoalObjectProperty
TypeScript @aws-cdk/mixins-preview » aws_evidently » mixins » CfnExperimentPropsMixin » MetricGoalObjectProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-experiment-metricgoalobject.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 metricGoalObjectProperty: evidently_mixins.CfnExperimentPropsMixin.MetricGoalObjectProperty = {
  desiredChange: 'desiredChange',
  entityIdKey: 'entityIdKey',
  eventPattern: 'eventPattern',
  metricName: 'metricName',
  unitLabel: 'unitLabel',
  valueKey: 'valueKey',
};

Properties

NameTypeDescription
desiredChange?stringINCREASE means that a variation with a higher number for this metric is performing better.
entityIdKey?stringThe entity, such as a user or session, that does an action that causes a metric value to be recorded.
eventPattern?stringThe EventBridge event pattern that defines how the metric is recorded.
metricName?stringA name for the metric.
unitLabel?stringA label for the units that the metric is measuring.
valueKey?stringThe JSON path to reference the numerical metric value in the event.

desiredChange?

Type: string (optional)

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.

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

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-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-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-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-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-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-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-experiment-metricgoalobject.html#cfn-evidently-experiment-metricgoalobject-unitlabel

valueKey?

Type: string (optional)

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

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

← PreviousNext →