AWS::RUM::AppMonitor

Creates a CloudWatch RUM app monitor, which you can use to collect telemetry data from your application and send it to CloudWatch RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?

Syntax

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

JSON

{
  "Type" : "AWS::RUM::AppMonitor",
  "Properties" : {
      "AppMonitorConfiguration" : AppMonitorConfiguration,
      "CustomEvents" : CustomEvents,
      "CwLogEnabled" : Boolean,
      "Domain" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::RUM::AppMonitor
Properties:
  AppMonitorConfiguration: 
    AppMonitorConfiguration
  CustomEvents: 
    CustomEvents
  CwLogEnabled: Boolean
  Domain: String
  Name: String
  Tags: 
    - Tag

Properties

AppMonitorConfiguration

A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to AWS.

If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.

Required: No

Type: AppMonitorConfiguration

Update requires: No interruption

CustomEvents

Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.

Required: No

Type: CustomEvents

Update requires: No interruption

CwLogEnabled

Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether CloudWatch RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

If you omit this parameter, the default is false.

Required: No

Type: Boolean

Update requires: No interruption

Domain

The top-level internet domain name for which your application has administrative authority. This parameter is required.

Required: Yes

Type: String

Pattern: ^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\*\.)(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))

Minimum: 1

Maximum: 253

Update requires: No interruption

Name

A name for the app monitor. This parameter is required.

Required: Yes

Type: String

Pattern: [\.\-_/#A-Za-z0-9]+

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

Assigns one or more tags (key-value pairs) to the app monitor.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an app monitor.

For more information, see Tagging AWS resources.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the app monitor.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Id

The ID of the app monitor, such as 123456ab-1234-4ca9-9d2f-a1b2c3456789.