Package software.amazon.awscdk.services.rum

Class CfnAppMonitor.AppMonitorConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.rum.CfnAppMonitor.AppMonitorConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAppMonitor.AppMonitorConfigurationProperty>

Enclosing interface:

CfnAppMonitor.AppMonitorConfigurationProperty

@Stability(Stable)
public static final class CfnAppMonitor.AppMonitorConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAppMonitor.AppMonitorConfigurationProperty>

A builder for CfnAppMonitor.AppMonitorConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	allowCookies(Boolean allowCookies)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getAllowCookies()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	allowCookies(IResolvable allowCookies)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getAllowCookies()
CfnAppMonitor.AppMonitorConfigurationProperty	build()	Builds the configured instance.
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	enableXRay(Boolean enableXRay)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getEnableXRay()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	enableXRay(IResolvable enableXRay)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getEnableXRay()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	excludedPages(List<String> excludedPages)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getExcludedPages()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	favoritePages(List<String> favoritePages)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getFavoritePages()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	guestRoleArn(String guestRoleArn)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getGuestRoleArn()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	identityPoolId(String identityPoolId)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getIdentityPoolId()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	includedPages(List<String> includedPages)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getIncludedPages()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	metricDestinations(List<? extends Object> metricDestinations)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getMetricDestinations()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	metricDestinations(IResolvable metricDestinations)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getMetricDestinations()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	sessionSampleRate(Number sessionSampleRate)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getSessionSampleRate()
CfnAppMonitor.AppMonitorConfigurationProperty.Builder	telemetries(List<String> telemetries)	Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getTelemetries()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

allowCookies

@Stability(Stable)
public CfnAppMonitor.AppMonitorConfigurationProperty.Builder allowCookies(Boolean allowCookies)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getAllowCookies()

Parameters:

allowCookies - If you set this to true , 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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder allowCookies(IResolvable allowCookies)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getAllowCookies()

Parameters:

allowCookies - If you set this to true , 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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder enableXRay(Boolean enableXRay)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getEnableXRay()

Parameters:

enableXRay - If you set this to true , 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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder enableXRay(IResolvable enableXRay)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getEnableXRay()

Parameters:

enableXRay - If you set this to true , 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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder excludedPages(List<String> excludedPages)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getExcludedPages()

Parameters:

excludedPages - 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 app monitor.

Returns:

this

favoritePages

@Stability(Stable)
public CfnAppMonitor.AppMonitorConfigurationProperty.Builder favoritePages(List<String> favoritePages)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getFavoritePages()

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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder guestRoleArn(String guestRoleArn)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getGuestRoleArn()

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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder identityPoolId(String identityPoolId)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getIdentityPoolId()

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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder includedPages(List<String> includedPages)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getIncludedPages()

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 both ExcludedPages and IncludedPages in the same app monitor.

Returns:

this

metricDestinations

@Stability(Stable)
public CfnAppMonitor.AppMonitorConfigurationProperty.Builder metricDestinations(IResolvable metricDestinations)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getMetricDestinations()

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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder metricDestinations(List<? extends Object> metricDestinations)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getMetricDestinations()

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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder sessionSampleRate(Number sessionSampleRate)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getSessionSampleRate()

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 CfnAppMonitor.AppMonitorConfigurationProperty.Builder telemetries(List<String> telemetries)

Sets the value of CfnAppMonitor.AppMonitorConfigurationProperty.getTelemetries()

Parameters:

telemetries - 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.

Returns:

this

build

@Stability(Stable)
public CfnAppMonitor.AppMonitorConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAppMonitor.AppMonitorConfigurationProperty>

Returns:

a new instance of CfnAppMonitor.AppMonitorConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided