class Aws::CloudWatchEvidently::Types::MetricDefinitionConfig
This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.
@note When making an API call, you may pass MetricDefinitionConfig
data as a hash: { entity_id_key: "JsonPath", # required event_pattern: "MetricDefinitionConfigEventPatternString", name: "CwDimensionSafeName", # required unit_label: "MetricUnitLabel", value_key: "JsonPath", # required }
@!attribute [rw] entity_id_key
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`. @return [String]
@!attribute [rw] event_pattern
The EventBridge event pattern that defines how the metric is recorded. For more information about EventBridge event patterns, see [Amazon EventBridge event patterns][1]. [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html @return [String]
@!attribute [rw] name
A name for the metric. @return [String]
@!attribute [rw] unit_label
A label for the units that the metric is measuring. @return [String]
@!attribute [rw] value_key
The value that is tracked to produce the metric. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/evidently-2021-02-01/MetricDefinitionConfig AWS API Documentation
Constants
- SENSITIVE