Class: Aws::CloudWatchRUM::Types::PutRumMetricsDestinationRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudwatchrum/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_monitor_name ⇒ String

The name of the CloudWatch RUM app monitor that will send the metrics.

Returns:

  • (String) 


1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1392

class PutRumMetricsDestinationRequest < Struct.new(
  :app_monitor_name,
  :destination,
  :destination_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ 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 CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

Returns:

  • (String) 


1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1392

class PutRumMetricsDestinationRequest < Struct.new(
  :app_monitor_name,
  :destination,
  :destination_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#destination_arn ⇒ String

Use this parameter only if ‘Destination` is `Evidently`. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

Returns:

  • (String) 


1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1392

class PutRumMetricsDestinationRequest < Struct.new(
  :app_monitor_name,
  :destination,
  :destination_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ String

This parameter is required if ‘Destination` is `Evidently`. If `Destination` is `CloudWatch`, don’t 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.

If you specify this parameter, you must be signed on to a role that has [PassRole] permissions attached to it, to allow the role to be passed. The [ CloudWatchAmazonCloudWatchRUMFullAccess] policy doesn’t include ‘PassRole` permissions.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html [2]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html#managed-policies-cloudwatch-RUM

Returns:

  • (String) 


1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'lib/aws-sdk-cloudwatchrum/types.rb', line 1392

class PutRumMetricsDestinationRequest < Struct.new(
  :app_monitor_name,
  :destination,
  :destination_arn,
  :iam_role_arn)
  SENSITIVE = []
  include Aws::Structure
end