Class CfnAppMonitor
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.rum.CfnAppMonitor
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:50.553Z")
@Stability(Stable)
public class CfnAppMonitor
extends CfnResource
implements IInspectable, ITaggable
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") .namespace("namespace") .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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
This structure contains much of the configuration data for the app monitor.static final class
A fluent builder forCfnAppMonitor
.static interface
This structure specifies whether this app monitor allows the web client to define and send custom events.static interface
Specifies one custom metric or extended metric that you want the CloudWatch RUM app monitor to send to a destination.static interface
Creates or updates a destination to receive extended metrics from CloudWatch RUM.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnAppMonitor
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnAppMonitor
(software.amazon.jsii.JsiiObjectRef objRef) CfnAppMonitor
(software.constructs.Construct scope, String id, CfnAppMonitorProps props) -
Method Summary
Modifier and TypeMethodDescriptionA structure that contains much of the configuration data for the app monitor.The ID of the app monitor, such as123456ab-1234-4ca9-9d2f-a1b2c3456789
.Specifies whether this app monitor allows the web client to define and send custom events.Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.The top-level internet domain name for which your application has administrative authority.getName()
A name for the app monitor.getTags()
Tag Manager which manages the tags for this resource.Assigns one or more tags (key-value pairs) to the app monitor.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
A structure that contains much of the configuration data for the app monitor.void
A structure that contains much of the configuration data for the app monitor.void
setCustomEvents
(IResolvable value) Specifies whether this app monitor allows the web client to define and send custom events.void
Specifies whether this app monitor allows the web client to define and send custom events.void
setCwLogEnabled
(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
The top-level internet domain name for which your application has administrative authority.void
A name for the app monitor.void
setTagsRaw
(List<CfnTag> value) Assigns one or more tags (key-value pairs) to the app monitor.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnAppMonitor
protected CfnAppMonitor(software.amazon.jsii.JsiiObjectRef objRef) -
CfnAppMonitor
protected CfnAppMonitor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnAppMonitor
@Stability(Stable) public CfnAppMonitor(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAppMonitorProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The ID of the app monitor, such as123456ab-1234-4ca9-9d2f-a1b2c3456789
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getDomain
The top-level internet domain name for which your application has administrative authority. -
setDomain
The top-level internet domain name for which your application has administrative authority. -
getName
A name for the app monitor. -
setName
A name for the app monitor. -
getAppMonitorConfiguration
A structure that contains much of the configuration data for the app monitor. -
setAppMonitorConfiguration
A structure that contains much of the configuration data for the app monitor. -
setAppMonitorConfiguration
@Stability(Stable) public void setAppMonitorConfiguration(@Nullable CfnAppMonitor.AppMonitorConfigurationProperty value) A structure that contains much of the configuration data for the app monitor. -
getCustomEvents
Specifies whether this app monitor allows the web client to define and send custom events. -
setCustomEvents
Specifies whether this app monitor allows the web client to define and send custom events. -
setCustomEvents
Specifies whether this app monitor allows the web client to define and send custom events. -
getCwLogEnabled
Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. -
setCwLogEnabled
Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. -
setCwLogEnabled
Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. -
getTagsRaw
Assigns one or more tags (key-value pairs) to the app monitor. -
setTagsRaw
Assigns one or more tags (key-value pairs) to the app monitor.
-