Package software.amazon.awscdk.services.rum

Interface CfnAppMonitorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAppMonitorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:35.060Z")
@Stability(Stable)
public interface CfnAppMonitorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAppMonitor.

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.*;
 CfnAppMonitorProps cfnAppMonitorProps = CfnAppMonitorProps.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAppMonitorProps.Builder	A builder for CfnAppMonitorProps
static final class	CfnAppMonitorProps.Jsii$Proxy	An implementation for CfnAppMonitorProps

Method Summary

Modifier and Type	Method	Description
static CfnAppMonitorProps.Builder	builder()
default Object	getAppMonitorConfiguration()	A structure that contains much of the configuration data for the app monitor.
default Object	getCustomEvents()	Specifies whether this app monitor allows the web client to define and send custom events.
default Object	getCwLogEnabled()	Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
String	getDomain()	The top-level internet domain name for which your application has administrative authority.
String	getName()	A name for the app monitor.
default List<CfnTag>	getTags()	Assigns one or more tags (key-value pairs) to the app monitor.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomain

@Stability(Stable)
@NotNull
String getDomain()

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

This parameter is required.

getName

@Stability(Stable)
@NotNull
String getName()

A name for the app monitor.

This parameter is required.

getAppMonitorConfiguration

@Stability(Stable)
@Nullable
default 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.

getCustomEvents

@Stability(Stable)
@Nullable
default 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 .

getCwLogEnabled

@Stability(Stable)
@Nullable
default 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 .

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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 .

builder

@Stability(Stable)
static CfnAppMonitorProps.Builder builder()

Returns:

a CfnAppMonitorProps.Builder of CfnAppMonitorProps