software.amazon.awscdk.services.evidently

Interface CfnLaunch.MetricDefinitionObjectProperty

All Known Implementing Classes:

CfnLaunch.MetricDefinitionObjectProperty.Jsii$Proxy

Enclosing class:

CfnLaunch

public static interface CfnLaunch.MetricDefinitionObjectProperty

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")
         .metricName("metricName")
         .valueKey("valueKey")
         // the properties below are optional
         .eventPattern("eventPattern")
         .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()
java.lang.String	getEntityIdKey() The entity, such as a user or session, that does an action that causes a metric value to be recorded.
default java.lang.String	getEventPattern() The EventBridge event pattern that defines how the metric is recorded.
java.lang.String	getMetricName() A name for the metric.
default java.lang.String	getUnitLabel() A label for the units that the metric is measuring.
java.lang.String	getValueKey() The value that is tracked to produce the metric.

Method Detail

getEntityIdKey

java.lang.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 .

getMetricName

java.lang.String getMetricName()

A name for the metric.

It can include up to 255 characters.

getValueKey

java.lang.String getValueKey()

The value that is tracked to produce the metric.

getEventPattern

default java.lang.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 .

getUnitLabel

default java.lang.String getUnitLabel()

A label for the units that the metric is measuring.

builder

static CfnLaunch.MetricDefinitionObjectProperty.Builder builder()

Returns:

a CfnLaunch.MetricDefinitionObjectProperty.Builder of CfnLaunch.MetricDefinitionObjectProperty