Interface CfnLaunch.MetricDefinitionObjectProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnLaunch.MetricDefinitionObjectProperty extends
This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 MetricDefinitionObjectProperty metricDefinitionObjectProperty = MetricDefinitionObjectProperty.builder()
         // the properties below are optional
  • Method Details

    • getEntityIdKey

      @Stability(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 .

    • getMetricName

      @Stability(Stable) @NotNull String getMetricName()
      A name for the metric.

      It can include up to 255 characters.

    • getValueKey

      @Stability(Stable) @NotNull String getValueKey()
      The value that is tracked to produce the metric.
    • getEventPattern

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default String getUnitLabel()
      A label for the units that the metric is measuring.
    • builder

      @Stability(Stable) static CfnLaunch.MetricDefinitionObjectProperty.Builder builder()
      a CfnLaunch.MetricDefinitionObjectProperty.Builder of CfnLaunch.MetricDefinitionObjectProperty