Package software.amazon.awscdk.cfnpropertymixins.services.rum

Class CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.rum.CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

An implementation for CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.rum.CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder, CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAllowCookies()	If you set this to true , the CloudWatch RUM web client sets two cookies, a session cookie and a user cookie.
final Object	getEnableXRay()	If you set this to true , CloudWatch RUM sends client-side traces to X-Ray for each sampled session.
final List<String>	getExcludedPages()	A list of URLs in your website or application to exclude from RUM data collection.
final List<String>	getFavoritePages()	A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
final Object	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.
final Object	getIdentityPoolId()	The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.
final List<String>	getIncludedPages()	If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
final Object	getMetricDestinations()	An array of structures that each define a destination that this app monitor will send extended metrics to.
final Number	getSessionSampleRate()	Specifies the portion of user sessions to use for CloudWatch RUM data collection.
final List<String>	getTelemetries()	An array that lists the types of telemetry data that this app monitor is to collect.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty.Builder.

Method Details

getAllowCookies

public final Object getAllowCookies()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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 union: either Boolean or IResolvable

Specified by:

getAllowCookies in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-allowcookies

getEnableXRay

public final Object getEnableXRay()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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 union: either Boolean or IResolvable

Specified by:

getEnableXRay in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-enablexray

getExcludedPages

public final List<String> getExcludedPages()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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.

Specified by:

getExcludedPages in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-excludedpages

getFavoritePages

public final List<String> getFavoritePages()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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

Specified by:

getFavoritePages in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-favoritepages

getGuestRoleArn

public final Object getGuestRoleArn()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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 union: either String or IRoleRef

Specified by:

getGuestRoleArn in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-guestrolearn

getIdentityPoolId

public final Object getIdentityPoolId()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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

Returns union: either String or IIdentityPoolRef

Specified by:

getIdentityPoolId in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-identitypoolid

getIncludedPages

public final List<String> getIncludedPages()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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.

Specified by:

getIncludedPages in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-includedpages

getMetricDestinations

public final Object getMetricDestinations()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

An array of structures that each define a destination that this app monitor will send extended metrics to.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAppMonitorPropsMixin.MetricDestinationProperty>

Specified by:

getMetricDestinations in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-metricdestinations

getSessionSampleRate

public final Number getSessionSampleRate()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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.

Specified by:

getSessionSampleRate in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-sessionsamplerate

getTelemetries

public final List<String> getTelemetries()

Description copied from interface: CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

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.

Specified by:

getTelemetries in interface CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rum-appmonitor-appmonitorconfiguration.html#cfn-rum-appmonitor-appmonitorconfiguration-telemetries

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object