Interface CfnAppMonitor.AppMonitorConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAppMonitor.AppMonitorConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnAppMonitor
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.rum.*; AppMonitorConfigurationProperty appMonitorConfigurationProperty = AppMonitorConfigurationProperty.builder() .allowCookies(false) .enableXRay(false) .excludedPages(List.of("excludedPages")) .favoritePages(List.of("favoritePages")) .guestRoleArn("guestRoleArn") .identityPoolId("identityPoolId") .includedPages(List.of("includedPages")) .metricDestinations(List.of(MetricDestinationProperty.builder() .destination("destination") // the properties below are optional .destinationArn("destinationArn") .iamRoleArn("iamRoleArn") .metricDefinitions(List.of(MetricDefinitionProperty.builder() .name("name") // the properties below are optional .dimensionKeys(Map.of( "dimensionKeysKey", "dimensionKeys")) .eventPattern("eventPattern") .namespace("namespace") .unitLabel("unitLabel") .valueKey("valueKey") .build())) .build())) .sessionSampleRate(123) .telemetries(List.of("telemetries")) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnAppMonitor.AppMonitorConfigurationProperty
static final class
An implementation forCfnAppMonitor.AppMonitorConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
If you set this totrue
, the CloudWatch RUM web client sets two cookies, a session cookie and a user cookie.default Object
If you set this totrue
, CloudWatch RUM sends client-side traces to X-Ray for each sampled session.A list of URLs in your website or application to exclude from RUM data collection.A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.default String
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.default String
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.default Object
An array of structures that each define a destination that this app monitor will send extended metrics to.default Number
Specifies the portion of user sessions to use for CloudWatch RUM data collection.An array that lists the types of telemetry data that this app monitor is to collect.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAllowCookies
If you set this totrue
, 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.
- See Also:
-
getEnableXRay
If you set this totrue
, 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 AWS X-Ray ?
- See Also:
-
getExcludedPages
A list of URLs in your website or application to exclude from RUM data collection.You can't include both
ExcludedPages
andIncludedPages
in the same app monitor.- See Also:
-
getFavoritePages
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.- See Also:
-
getGuestRoleArn
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.- See Also:
-
getIdentityPoolId
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.- See Also:
-
getIncludedPages
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
andIncludedPages
in the same app monitor.- See Also:
-
getMetricDestinations
An array of structures that each define a destination that this app monitor will send extended metrics to.- See Also:
-
getSessionSampleRate
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.
- See Also:
-
getTelemetries
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.
- See Also:
-
builder
-