AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatchRUM.Model.MetricDefinition

Namespace: Amazon.CloudWatchRUM.Model
Assembly: AWSSDK.CloudWatchRUM.dll
Version: 3.x.y.z

Syntax

C# 
public class MetricDefinition

The MetricDefinition type exposes the following members

Constructors

NameDescription
Public Method MetricDefinition()

Properties

NameTypeDescription
Public Property DimensionKeys System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property DimensionKeys.

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.

Public Property EventPattern System.String

Gets and sets the property EventPattern.

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.

Public Property MetricDefinitionId System.String

Gets and sets the property MetricDefinitionId.

The ID of this metric definition.

Public Property Name System.String

Gets and sets the property Name.

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

Public Property Namespace System.String

Gets and sets the property Namespace.

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.

Public Property UnitLabel System.String

Gets and sets the property UnitLabel.

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

Public Property ValueKey System.String

Gets and sets the property ValueKey.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5