software.amazon.awscdk.services.evidently

Interface CfnLaunch.MetricDefinitionObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunch.MetricDefinitionObjectProperty.Jsii$Proxy

Enclosing class:

CfnLaunch

@Stability(value=Stable)
public static interface CfnLaunch.MetricDefinitionObjectProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.evidently.*;
 MetricDefinitionObjectProperty metricDefinitionObjectProperty = MetricDefinitionObjectProperty.builder()
         .entityIdKey("entityIdKey")
         .eventPattern("eventPattern")
         .metricName("metricName")
         .valueKey("valueKey")
         // the properties below are optional
         .unitLabel("unitLabel")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLaunch.MetricDefinitionObjectProperty.Builder A builder for CfnLaunch.MetricDefinitionObjectProperty
static class	CfnLaunch.MetricDefinitionObjectProperty.Jsii$Proxy An implementation for CfnLaunch.MetricDefinitionObjectProperty

Method Summary

Modifier and Type	Method and Description
static CfnLaunch.MetricDefinitionObjectProperty.Builder	builder()
String	getEntityIdKey() The entity, such as a user or session, that does an action that causes a metric value to be recorded.
String	getEventPattern() The EventBridge event pattern that defines how the metric is recorded.
String	getMetricName() A name for the metric.
default String	getUnitLabel() A label for the units that the metric is measuring.
String	getValueKey() The value that is tracked to produce the metric.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEntityIdKey

@Stability(value=Stable)
 @NotNull
String getEntityIdKey()

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 .

getEventPattern

@Stability(value=Stable)
 @NotNull
String getEventPattern()

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

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

getMetricName

@Stability(value=Stable)
 @NotNull
String getMetricName()

A name for the metric.

It can include up to 255 characters.

getValueKey

@Stability(value=Stable)
 @NotNull
String getValueKey()

The value that is tracked to produce the metric.

getUnitLabel

@Stability(value=Stable)
 @Nullable
default String getUnitLabel()

A label for the units that the metric is measuring.

builder

@Stability(value=Stable)
static CfnLaunch.MetricDefinitionObjectProperty.Builder builder()

Returns:

a CfnLaunch.MetricDefinitionObjectProperty.Builder of CfnLaunch.MetricDefinitionObjectProperty