Class: Aws::CloudWatchRUM::Types::MetricDefinition

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

Overview

A structure that displays the definition of one extended metric that RUM sends to CloudWatch or CloudWatch Evidently. For more information, see [ Additional metrics that you can send to CloudWatch and CloudWatch Evidently].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dimension_keys ⇒ Hash<String,String>

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is ‘CloudWatch`. If the metric destination is `Evidently`, the value of `DimensionKeys` is ignored.

Returns:

  • (Hash<String,String>) 


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1184

class MetricDefinition < Struct.new(
  :metric_definition_id,
  :name,
  :value_key,
  :unit_label,
  :dimension_keys,
  :event_pattern,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#event_pattern ⇒ String

The pattern that defines the metric. RUM checks events that happen in a user’s session against the pattern, and events that match the pattern are sent to the metric destination.

If the metrics destination is ‘CloudWatch` and the event also matches a value in `DimensionKeys`, then the metric is published with the specified dimensions.

Returns:

  • (String) 


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1184

class MetricDefinition < Struct.new(
  :metric_definition_id,
  :name,
  :value_key,
  :unit_label,
  :dimension_keys,
  :event_pattern,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#metric_definition_id ⇒ String

The ID of this metric definition.

Returns:

  • (String) 


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1184

class MetricDefinition < Struct.new(
  :metric_definition_id,
  :name,
  :value_key,
  :unit_label,
  :dimension_keys,
  :event_pattern,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the metric that is defined in this structure.

Returns:

  • (String) 


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1184

class MetricDefinition < Struct.new(
  :metric_definition_id,
  :name,
  :value_key,
  :unit_label,
  :dimension_keys,
  :event_pattern,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

Returns:

  • (String) 


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1184

class MetricDefinition < Struct.new(
  :metric_definition_id,
  :name,
  :value_key,
  :unit_label,
  :dimension_keys,
  :event_pattern,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#unit_label ⇒ String

Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

Returns:

  • (String) 


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1184

class MetricDefinition < Struct.new(
  :metric_definition_id,
  :name,
  :value_key,
  :unit_label,
  :dimension_keys,
  :event_pattern,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end

#value_key ⇒ String

The field within the event object that the metric value is sourced from.

Returns:

  • (String) 


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1184

class MetricDefinition < Struct.new(
  :metric_definition_id,
  :name,
  :value_key,
  :unit_label,
  :dimension_keys,
  :event_pattern,
  :namespace)
  SENSITIVE = []
  include Aws::Structure
end