aws_rum_app_monitor

account_id

Type: STRING

app_monitor_configuration

Type: STRUCT
Provider name: AppMonitorConfiguration
Description: A structure that contains much of the configuration data for the app monitor.

• allow_cookies
  Type: BOOLEAN
  Provider name: AllowCookies
  Description: If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the 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.
  
• enable_x_ray
  Type: BOOLEAN
  Provider name: EnableXRay
  Description: If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?
  
• excluded_pages
  Type: UNORDERED_LIST_STRING
  Provider name: ExcludedPages
  Description: 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 operation.
  
• favorite_pages
  Type: UNORDERED_LIST_STRING
  Provider name: FavoritePages
  Description: A list of pages in your application that are to be displayed with a “favorite” icon in the CloudWatch RUM console.
  
• guest_role_arn
  Type: STRING
  Provider name: GuestRoleArn
  Description: 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 RUM. It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service. If this issue affects you, you can take one of the following steps:
  • Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.
  • Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.
  
  
• identity_pool_id
  Type: STRING
  Provider name: IdentityPoolId
  Description: The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
  
• included_pages
  Type: UNORDERED_LIST_STRING
  Provider name: IncludedPages
  Description: 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 operation.
  
• session_sample_rate
  Type: DOUBLE
  Provider name: SessionSampleRate
  Description: Specifies the portion of user sessions to use for 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.
  
• telemetries
  Type: UNORDERED_LIST_STRING
  Provider name: Telemetries
  Description: 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.

created

Type: STRING
Provider name: Created
Description: The date and time that this app monitor was created.

custom_events

Type: STRUCT
Provider name: CustomEvents
Description: Specifies whether this app monitor allows the web client to define and send custom events. For more information about custom events, see Send custom events.

• status
  Type: STRING
  Provider name: Status
  Description: Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.
  

data_storage

Type: STRUCT
Provider name: DataStorage
Description: A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.

• cw_log
  Type: STRUCT
  Provider name: CwLog
  Description: A structure that contains the information about whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.
  
  • cw_log_enabled
    Type: BOOLEAN
    Provider name: CwLogEnabled
    Description: Indicated whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs.
    
  • cw_log_group
    Type: STRING
    Provider name: CwLogGroup
    Description: The name of the log group where the copies are stored.
    

deobfuscation_configuration

Type: STRUCT
Provider name: DeobfuscationConfiguration
Description: A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

• java_script_source_maps
  Type: STRUCT
  Provider name: JavaScriptSourceMaps
  Description: A structure that contains the configuration for how an app monitor can unminify JavaScript error stack traces using source maps.
  
  • s3_uri
    Type: STRING
    Provider name: S3Uri
    Description: The S3Uri of the bucket or folder that stores the source map files. It is required if status is ENABLED.
    
  • status
    Type: STRING
    Provider name: Status
    Description: Specifies whether JavaScript error stack traces should be unminified for this app monitor. The default is for JavaScript error stack trace unminification to be DISABLED.
    

domain

Type: STRING
Provider name: Domain
Description: The top-level internet domain name for which your application has administrative authority.

domain_list

Type: UNORDERED_LIST_STRING
Provider name: DomainList
Description: List the domain names for which your application has administrative authority.

id

Type: STRING
Provider name: Id
Description: The unique ID of this app monitor.

last_modified

Type: STRING
Provider name: LastModified
Description: The date and time of the most recent changes to this app monitor’s configuration.

name

Type: STRING
Provider name: Name
Description: The name of the app monitor.

state

Type: STRING
Provider name: State
Description: The current state of the app monitor.

tags

Type: UNORDERED_LIST_STRING