Class: Aws::CloudWatchEvidently::Types::MetricDefinitionConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb

Overview

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
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_id_keyString

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.

Returns:

  • (String)


2355
2356
2357
2358
2359
2360
2361
2362
2363
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 2355

class MetricDefinitionConfig < Struct.new(
  :entity_id_key,
  :event_pattern,
  :name,
  :unit_label,
  :value_key)
  SENSITIVE = []
  include Aws::Structure
end

#event_patternString

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

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

Returns:

  • (String)


2355
2356
2357
2358
2359
2360
2361
2362
2363
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 2355

class MetricDefinitionConfig < Struct.new(
  :entity_id_key,
  :event_pattern,
  :name,
  :unit_label,
  :value_key)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A name for the metric.

Returns:

  • (String)


2355
2356
2357
2358
2359
2360
2361
2362
2363
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 2355

class MetricDefinitionConfig < Struct.new(
  :entity_id_key,
  :event_pattern,
  :name,
  :unit_label,
  :value_key)
  SENSITIVE = []
  include Aws::Structure
end

#unit_labelString

A label for the units that the metric is measuring.

Returns:

  • (String)


2355
2356
2357
2358
2359
2360
2361
2362
2363
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 2355

class MetricDefinitionConfig < Struct.new(
  :entity_id_key,
  :event_pattern,
  :name,
  :unit_label,
  :value_key)
  SENSITIVE = []
  include Aws::Structure
end

#value_keyString

The value that is tracked to produce the metric.

Returns:

  • (String)


2355
2356
2357
2358
2359
2360
2361
2362
2363
# File 'gems/aws-sdk-cloudwatchevidently/lib/aws-sdk-cloudwatchevidently/types.rb', line 2355

class MetricDefinitionConfig < Struct.new(
  :entity_id_key,
  :event_pattern,
  :name,
  :unit_label,
  :value_key)
  SENSITIVE = []
  include Aws::Structure
end