AppMonitorConfiguration

data class AppMonitorConfiguration(val allowCookies: Boolean? = null, val enableXRay: Boolean? = null, val excludedPages: List<String>? = null, val favoritePages: List<String>? = null, val guestRoleArn: String? = null, val identityPoolId: String? = null, val includedPages: List<String>? = null, val metricDestinations: List<AppMonitorMetricDestination>? = null, val sessionSampleRate: Double? = null, val telemetries: List<AppMonitorTelemetry>? = null)

AppMonitor configuration

Constructors

Link copied to clipboard
constructor(allowCookies: Boolean? = null, enableXRay: Boolean? = null, excludedPages: List<String>? = null, favoritePages: List<String>? = null, guestRoleArn: String? = null, identityPoolId: String? = null, includedPages: List<String>? = null, metricDestinations: List<AppMonitorMetricDestination>? = null, sessionSampleRate: Double? = null, telemetries: List<AppMonitorTelemetry>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val allowCookies: Boolean? = null

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.

Link copied to clipboard
val enableXRay: Boolean? = null

If you set this to true, RUM enables xray tracing for the user sessions that RUM samples. RUM adds an xray trace header to allowed HTTP requests. It also records an xray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the xray console and the CW ServiceLens console.

Link copied to clipboard
val excludedPages: List<String>? = null

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.

Link copied to clipboard
val favoritePages: List<String>? = null

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

Link copied to clipboard
val guestRoleArn: String? = null

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

Link copied to clipboard
val identityPoolId: String? = null

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

Link copied to clipboard
val includedPages: List<String>? = null

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.

Link copied to clipboard

An array of structures which define the destinations and the metrics that you want to send.

Link copied to clipboard

Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. If you omit this parameter, the default of 10 is used.

Link copied to clipboard

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