rum/aws.sdk.kotlin.services.rum.model/MetricDefinition

MetricDefinition

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.

Types

Builder

class Builder

Companion

object Companion

Properties

dimensionKeys

val dimensionKeys: Map<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.

eventPattern

val eventPattern: 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.

metricDefinitionId

val metricDefinitionId: String

The ID of this metric definition.

name

val name: String

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

namespace

val 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.

unitLabel

val unitLabel: 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.

valueKey

val valueKey: String?

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

Functions

copy

inline fun copy(block: MetricDefinition.Builder.() -> Unit = {}): MetricDefinition

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String