software.amazon.awscdk.services.rum

Interface CfnAppMonitor.MetricDestinationProperty

All Known Implementing Classes:

CfnAppMonitor.MetricDestinationProperty.Jsii$Proxy

Enclosing class:

CfnAppMonitor

public static interface CfnAppMonitor.MetricDestinationProperty

Creates or updates a destination to receive extended metrics from CloudWatch RUM.

You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.

For more information about extended metrics, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rum.*;
 MetricDestinationProperty metricDestinationProperty = MetricDestinationProperty.builder()
         .destination("destination")
         // the properties below are optional
         .destinationArn("destinationArn")
         .iamRoleArn("iamRoleArn")
         .metricDefinitions(List.of(MetricDefinitionProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .dimensionKeys(Map.of(
                         "dimensionKeysKey", "dimensionKeys"))
                 .eventPattern("eventPattern")
                 .unitLabel("unitLabel")
                 .valueKey("valueKey")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAppMonitor.MetricDestinationProperty.Builder A builder for CfnAppMonitor.MetricDestinationProperty
static class	CfnAppMonitor.MetricDestinationProperty.Jsii$Proxy An implementation for CfnAppMonitor.MetricDestinationProperty

Method Summary

Modifier and Type	Method and Description
static CfnAppMonitor.MetricDestinationProperty.Builder	builder()
java.lang.String	getDestination() Defines the destination to send the metrics to.
default java.lang.String	getDestinationArn() Use this parameter only if `Destination` is `Evidently` .
default java.lang.String	getIamRoleArn() This parameter is required if `Destination` is `Evidently` .
default java.lang.Object	getMetricDefinitions() An array of structures which define the metrics that you want to send.

Method Detail

getDestination

java.lang.String getDestination()

Defines the destination to send the metrics to.

Valid values are CloudWatch and Evidently . If you specify Evidently , you must also specify the ARN of the CloudWatch Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

getDestinationArn

default java.lang.String getDestinationArn()

Use this parameter only if `Destination` is `Evidently` .

This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

getIamRoleArn

default java.lang.String getIamRoleArn()

This parameter is required if `Destination` is `Evidently` . If `Destination` is `CloudWatch` , do not use this parameter.

This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

getMetricDefinitions

default java.lang.Object getMetricDefinitions()

An array of structures which define the metrics that you want to send.

builder

static CfnAppMonitor.MetricDestinationProperty.Builder builder()

Returns:

a CfnAppMonitor.MetricDestinationProperty.Builder of CfnAppMonitor.MetricDestinationProperty