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

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

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_id_key ⇒ String

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) 


2041
2042
2043
2044
2045
2046
2047
2048
2049
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2041

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

#event_pattern ⇒ String

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

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

[1]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html

Returns:

  • (String) 


2041
2042
2043
2044
2045
2046
2047
2048
2049
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2041

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

#name ⇒ String

A name for the metric.

Returns:

  • (String) 


2041
2042
2043
2044
2045
2046
2047
2048
2049
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2041

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

#unit_label ⇒ String

A label for the units that the metric is measuring.

Returns:

  • (String) 


2041
2042
2043
2044
2045
2046
2047
2048
2049
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2041

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

#value_key ⇒ String

The value that is tracked to produce the metric.

Returns:

  • (String) 


2041
2042
2043
2044
2045
2046
2047
2048
2049
 
# File 'lib/aws-sdk-cloudwatchevidently/types.rb', line 2041

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