Class CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.rum.CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty>
- Enclosing interface:
CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty
@Stability(Stable)
public static final class CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty>
A builder for
CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallowCookies(Boolean allowCookies) allowCookies(IResolvable allowCookies) build()Builds the configured instance.enableXRay(Boolean enableXRay) Sets the value ofCfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.getEnableXRay()enableXRay(IResolvable enableXRay) Sets the value ofCfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.getEnableXRay()excludedPages(List<String> excludedPages) favoritePages(List<String> favoritePages) guestRoleArn(String guestRoleArn) guestRoleArn(IRoleRef guestRoleArn) identityPoolId(String identityPoolId) identityPoolId(IIdentityPoolRef identityPoolId) includedPages(List<String> includedPages) metricDestinations(List<? extends Object> metricDestinations) metricDestinations(IResolvable metricDestinations) sessionSampleRate(Number sessionSampleRate) telemetries(List<String> telemetries) Sets the value ofCfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.getTelemetries()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowCookies
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder allowCookies(Boolean allowCookies) - Parameters:
allowCookies- 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.- Returns:
this
-
allowCookies
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder allowCookies(IResolvable allowCookies) - Parameters:
allowCookies- 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.- Returns:
this
-
enableXRay
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder enableXRay(Boolean enableXRay) Sets the value ofCfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.getEnableXRay()- Parameters:
enableXRay- 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 ?- Returns:
this
-
enableXRay
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder enableXRay(IResolvable enableXRay) Sets the value ofCfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.getEnableXRay()- Parameters:
enableXRay- 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 ?- Returns:
this
-
excludedPages
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder excludedPages(List<String> excludedPages) - Parameters:
excludedPages- A list of URLs in your website or application to exclude from RUM data collection. You can't include bothExcludedPagesandIncludedPagesin the same app monitor.- Returns:
this
-
favoritePages
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder favoritePages(List<String> favoritePages) - Parameters:
favoritePages- A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.- Returns:
this
-
guestRoleArn
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder guestRoleArn(String guestRoleArn) - Parameters:
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.- Returns:
this
-
guestRoleArn
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder guestRoleArn(IRoleRef guestRoleArn) - Parameters:
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.- Returns:
this
-
identityPoolId
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder identityPoolId(String identityPoolId) - Parameters:
identityPoolId- The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.- Returns:
this
-
identityPoolId
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder identityPoolId(IIdentityPoolRef identityPoolId) - Parameters:
identityPoolId- The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.- Returns:
this
-
includedPages
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder includedPages(List<String> includedPages) - Parameters:
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 bothExcludedPagesandIncludedPagesin the same app monitor.- Returns:
this
-
metricDestinations
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder metricDestinations(IResolvable metricDestinations) - Parameters:
metricDestinations- An array of structures that each define a destination that this app monitor will send extended metrics to.- Returns:
this
-
metricDestinations
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder metricDestinations(List<? extends Object> metricDestinations) - Parameters:
metricDestinations- An array of structures that each define a destination that this app monitor will send extended metrics to.- Returns:
this
-
sessionSampleRate
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder sessionSampleRate(Number sessionSampleRate) - Parameters:
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.
- Returns:
this
-
telemetries
@Stability(Stable) public CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder telemetries(List<String> telemetries) Sets the value ofCfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.getTelemetries()- Parameters:
telemetries- An array that lists the types of telemetry data that this app monitor is to collect.errorsindicates that RUM collects data about unhandled JavaScript errors raised by your application.performanceindicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.httpindicates that RUM collects data about HTTP errors thrown by your application.
- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty>- Returns:
- a new instance of
CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty - Throws:
NullPointerException- if any required attribute was not provided
-