software.amazon.awscdk.services.rum

Class CfnAppMonitor

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.rum.CfnAppMonitor

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:49.954Z")
public class CfnAppMonitor
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RUM::AppMonitor`.

Creates a CloudWatch RUM app monitor, which you can use to collect telemetry data from your application and send it to CloudWatch RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?

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.*;
 CfnAppMonitor cfnAppMonitor = CfnAppMonitor.Builder.create(this, "MyCfnAppMonitor")
         .domain("domain")
         .name("name")
         // the properties below are optional
         .appMonitorConfiguration(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")
                                 .unitLabel("unitLabel")
                                 .valueKey("valueKey")
                                 .build()))
                         .build()))
                 .sessionSampleRate(123)
                 .telemetries(List.of("telemetries"))
                 .build())
         .customEvents(CustomEventsProperty.builder()
                 .status("status")
                 .build())
         .cwLogEnabled(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAppMonitor.AppMonitorConfigurationProperty This structure contains much of the configuration data for the app monitor.
static class	CfnAppMonitor.Builder A fluent builder for CfnAppMonitor.
static interface	CfnAppMonitor.CustomEventsProperty This structure specifies whether this app monitor allows the web client to define and send custom events.
static interface	CfnAppMonitor.MetricDefinitionProperty Specifies the extended metrics that you want the CloudWatch RUM app monitor to send to a destination.
static interface	CfnAppMonitor.MetricDestinationProperty Creates or updates a destination to receive extended metrics from CloudWatch RUM.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAppMonitor(Construct scope, java.lang.String id, CfnAppMonitorProps props) Create a new `AWS::RUM::AppMonitor`.
protected	CfnAppMonitor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAppMonitor(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAppMonitorConfiguration() A structure that contains much of the configuration data for the app monitor.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getCustomEvents() Specifies whether this app monitor allows the web client to define and send custom events.
java.lang.Object	getCwLogEnabled() Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
java.lang.String	getDomain() The top-level internet domain name for which your application has administrative authority.
java.lang.String	getName() A name for the app monitor.
TagManager	getTags() Assigns one or more tags (key-value pairs) to the app monitor.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAppMonitorConfiguration(CfnAppMonitor.AppMonitorConfigurationProperty value) A structure that contains much of the configuration data for the app monitor.
void	setAppMonitorConfiguration(IResolvable value) A structure that contains much of the configuration data for the app monitor.
void	setCustomEvents(CfnAppMonitor.CustomEventsProperty value) Specifies whether this app monitor allows the web client to define and send custom events.
void	setCustomEvents(IResolvable value) Specifies whether this app monitor allows the web client to define and send custom events.
void	setCwLogEnabled(java.lang.Boolean value) Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
void	setCwLogEnabled(IResolvable value) Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
void	setDomain(java.lang.String value) The top-level internet domain name for which your application has administrative authority.
void	setName(java.lang.String value) A name for the app monitor.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAppMonitor

protected CfnAppMonitor(software.amazon.jsii.JsiiObjectRef objRef)

CfnAppMonitor

protected CfnAppMonitor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAppMonitor

public CfnAppMonitor(Construct scope,
                     java.lang.String id,
                     CfnAppMonitorProps props)

Create a new `AWS::RUM::AppMonitor`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

Assigns one or more tags (key-value pairs) to the app monitor.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an app monitor.

For more information, see Tagging AWS resources .

getDomain

public java.lang.String getDomain()

The top-level internet domain name for which your application has administrative authority.

This parameter is required.

setDomain

public void setDomain(java.lang.String value)

The top-level internet domain name for which your application has administrative authority.

This parameter is required.

getName

public java.lang.String getName()

A name for the app monitor.

This parameter is required.

setName

public void setName(java.lang.String value)

A name for the app monitor.

This parameter is required.

getAppMonitorConfiguration

public java.lang.Object getAppMonitorConfiguration()

A structure that contains much of the configuration data for the app monitor.

If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration , you must set up your own authorization method. For more information, see Authorize your application to send data to AWS .

If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.

setAppMonitorConfiguration

public void setAppMonitorConfiguration(CfnAppMonitor.AppMonitorConfigurationProperty value)

A structure that contains much of the configuration data for the app monitor.

If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration , you must set up your own authorization method. For more information, see Authorize your application to send data to AWS .

If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.

setAppMonitorConfiguration

public void setAppMonitorConfiguration(IResolvable value)

A structure that contains much of the configuration data for the app monitor.

If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration , you must set up your own authorization method. For more information, see Authorize your application to send data to AWS .

If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.

getCustomEvents

public java.lang.Object getCustomEvents()

Specifies whether this app monitor allows the web client to define and send custom events.

If you omit this parameter, custom events are DISABLED .

setCustomEvents

public void setCustomEvents(IResolvable value)

Specifies whether this app monitor allows the web client to define and send custom events.

If you omit this parameter, custom events are DISABLED .

setCustomEvents

public void setCustomEvents(CfnAppMonitor.CustomEventsProperty value)

Specifies whether this app monitor allows the web client to define and send custom events.

If you omit this parameter, custom events are DISABLED .

getCwLogEnabled

public java.lang.Object getCwLogEnabled()

Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

This parameter specifies whether CloudWatch RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

If you omit this parameter, the default is false .

setCwLogEnabled

public void setCwLogEnabled(java.lang.Boolean value)

Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

This parameter specifies whether CloudWatch RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

If you omit this parameter, the default is false .

setCwLogEnabled

public void setCwLogEnabled(IResolvable value)

Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

This parameter specifies whether CloudWatch RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

If you omit this parameter, the default is false .