interface MetricDestinationProperty

Language	Type name
.NET	Amazon.CDK.AWS.RUM.CfnAppMonitor.MetricDestinationProperty
Java	software.amazon.awscdk.services.rum.CfnAppMonitor.MetricDestinationProperty
Python	aws_cdk.aws_rum.CfnAppMonitor.MetricDestinationProperty
TypeScript	@aws-cdk/aws-rum » 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 * as rum from '@aws-cdk/aws-rum';
const metricDestinationProperty: rum.CfnAppMonitor.MetricDestinationProperty = {
  destination: 'destination',

  // the properties below are optional
  destinationArn: 'destinationArn',
  iamRoleArn: 'iamRoleArn',
  metricDefinitions: [{
    name: 'name',

    // the properties below are optional
    dimensionKeys: {
      dimensionKeysKey: 'dimensionKeys',
    },
    eventPattern: 'eventPattern',
    namespace: 'namespace',
    unitLabel: 'unitLabel',
    valueKey: 'valueKey',
  }],
};

Properties

Name	Type	Description
destination	string	Defines the destination to send the metrics to.
destinationArn?	string	Use this parameter only if Destination is Evidently .
iamRoleArn?	string	This parameter is required if Destination is Evidently . If Destination is CloudWatch , do not use this parameter.
metricDefinitions?	IResolvable | IResolvable | MetricDefinitionProperty[]	An array of structures which define the metrics that you want to send.

---

destination

Type: string

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.

---

destinationArn?

Type: string (optional)

Use this parameter only if Destination is Evidently .

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

---

iamRoleArn?

Type: string (optional)

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.

---

metricDefinitions?

Type: IResolvable | IResolvable | MetricDefinitionProperty[] (optional)

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