AWS::RUM::AppMonitor AppMonitorConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::RUM::AppMonitor AppMonitorConfiguration

This structure contains much of the configuration data for the app monitor.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AllowCookies" : Boolean,
  "EnableXRay" : Boolean,
  "ExcludedPages" : [ String, ... ],
  "FavoritePages" : [ String, ... ],
  "GuestRoleArn" : String,
  "IdentityPoolId" : String,
  "IncludedPages" : [ String, ... ],
  "MetricDestinations" : [ MetricDestination, ... ],
  "SessionSampleRate" : Number,
  "Telemetries" : [ String, ... ]
}

YAML

  AllowCookies: Boolean
  EnableXRay: Boolean
  ExcludedPages: 
    - String
  FavoritePages: 
    - String
  GuestRoleArn: String
  IdentityPoolId: String
  IncludedPages: 
    - String
  MetricDestinations: 
    - MetricDestination
  SessionSampleRate: Number
  Telemetries: 
    - String

Properties

AllowCookies

If you set this to true, the CloudWatch RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the CloudWatch RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.

Required: No

Type: Boolean

Update requires: No interruption

EnableXRay

If you set this to true, CloudWatch RUM sends client-side traces to X-Ray for each sampled session. You can then see traces and segments from these user sessions in the RUM dashboard and the CloudWatch ServiceLens console. For more information, see What is Amazon X-Ray?

Required: No

Type: Boolean

Update requires: No interruption

ExcludedPages

A list of URLs in your website or application to exclude from RUM data collection.

You can't include both ExcludedPages and IncludedPages in the same app monitor.

Required: No

Type: Array of String

Minimum: 0

Maximum: 50

Update requires: No interruption

FavoritePages

A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

Required: No

Type: Array of String

Minimum: 0

Maximum: 50

Update requires: No interruption

GuestRoleArn

The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.

Required: No

Type: String

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*

Update requires: No interruption

IdentityPoolId

The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.

Required: No

Type: String

Pattern: [\w-]+:[0-9a-f-]+

Minimum: 1

Maximum: 55

Update requires: No interruption

IncludedPages

If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.

You can't include both ExcludedPages and IncludedPages in the same app monitor.

Required: No

Type: Array of String

Minimum: 0

Maximum: 50

Update requires: No interruption

MetricDestinations

An array of structures that each define a destination that this app monitor will send extended metrics to.

Required: No

Type: Array of MetricDestination

Minimum: 0

Maximum: 20

Update requires: No interruption

SessionSampleRate

Specifies the portion of user sessions to use for CloudWatch RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.

The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.

If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.

Required: No

Type: Number

Minimum: 0

Maximum: 1

Update requires: No interruption

Telemetries

An array that lists the types of telemetry data that this app monitor is to collect.

  • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

  • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

  • http indicates that RUM collects data about HTTP errors thrown by your application.

Required: No

Type: Array of String

Update requires: No interruption