rum_metrics_destinations

Creates, updates, deletes, gets or lists a rum_metrics_destinations resource.

Overview

Name	rum_metrics_destinations
Type	Resource
Id	aws.rum.rum_metrics_destinations

Fields

The following fields are returned by SELECT queries:

list_rum_metrics_destinations

Name	Datatype	Description
destination	string	Specifies whether the destination is CloudWatch or Evidently. (CloudWatch, Evidently)
destination_arn	string	If the destination is Evidently, this specifies the ARN of the Evidently experiment that receives the metrics. (pattern: <code>.arn:[^:]:[^:]:[^:]:[^:]:.</code>)
iam_role_arn	string	This field appears only when the destination is Evidently. It specifies the ARN of the IAM role that is used to write to the Evidently experiment that receives the metrics. (pattern: <code>.arn:[^:]:[^:]:[^:]:[^:]:.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_rum_metrics_destinations	select	app_monitor_name, region	maxResults, nextToken	Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. For more information about extended metrics, see AddRumMetrics.
put_rum_metrics_destination	replace	app_monitor_name, region		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 BatchCreateRumMetricDefinitions.
delete_rum_metrics_destination	delete	app_monitor_name, destination, region	destinationArn	Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
app_monitor_name	string	The name of the app monitor that is sending metrics to the destination that you want to delete.
destination	string	The type of destination to delete. Valid values are CloudWatch and Evidently.
region	string	AWS region (default: us-east-1)
destinationArn	string	This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that corresponds to the destination to delete.
maxResults	integer	The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100. To retrieve the remaining results, make another call with the returned NextToken value.
nextToken	string	Use the token returned by the previous operation to request the next page of results.

SELECT examples

list_rum_metrics_destinations

Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. For more information about extended metrics, see AddRumMetrics.

SELECT
destination,
destination_arn,
iam_role_arn
FROM aws.rum.rum_metrics_destinations
WHERE app_monitor_name = '{{ app_monitor_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

REPLACE examples

put_rum_metrics_destination

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

REPLACE aws.rum.rum_metrics_destinations
SET 
Destination = '{{ Destination }}',
DestinationArn = '{{ DestinationArn }}',
IamRoleArn = '{{ IamRoleArn }}'
WHERE 
app_monitor_name = '{{ app_monitor_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_rum_metrics_destination

Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.

DELETE FROM aws.rum.rum_metrics_destinations
WHERE app_monitor_name = '{{ app_monitor_name }}' --required
AND destination = '{{ destination }}' --required
AND region = '{{ region }}' --required
AND destinationArn = '{{ destinationArn }}'
;