Interface CfnAppMonitorProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAppMonitorProps.Jsii$Proxy
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()
.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)
.deobfuscationConfiguration(DeobfuscationConfigurationProperty.builder()
.javaScriptSourceMaps(JavaScriptSourceMapsProperty.builder()
.status("status")
// the properties below are optional
.s3Uri("s3Uri")
.build())
.build())
.domain("domain")
.domainList(List.of("domainList"))
.resourcePolicy(ResourcePolicyProperty.builder()
.policyDocument("policyDocument")
// the properties below are optional
.policyRevisionId("policyRevisionId")
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnAppMonitorPropsstatic final classAn implementation forCfnAppMonitorProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnAppMonitorProps.Builderbuilder()default ObjectA structure that contains much of the configuration data for the app monitor.default ObjectSpecifies whether this app monitor allows the web client to define and send custom events.default ObjectData collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.default ObjectA structure that contains the configuration for how an app monitor can deobfuscate stack traces.default StringThe top-level internet domain name for which your application has administrative authority.List the domain names for which your application has administrative authority.getName()A name for the app monitor.default ObjectUse this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.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
-
getName
A name for the app monitor.This parameter is required.
- See Also:
-
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.
Returns union: either
IResolvableorCfnAppMonitor.AppMonitorConfigurationProperty- See Also:
-
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.Returns union: either
IResolvableorCfnAppMonitor.CustomEventsProperty- See Also:
-
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.Returns union: either
BooleanorIResolvable- See Also:
-
getDeobfuscationConfiguration
A structure that contains the configuration for how an app monitor can deobfuscate stack traces.Returns union: either
IResolvableorCfnAppMonitor.DeobfuscationConfigurationProperty- See Also:
-
getDomain
The top-level internet domain name for which your application has administrative authority.This parameter or the
DomainListparameter is required.- See Also:
-
getDomainList
List the domain names for which your application has administrative authority. This parameter or theDomainparameter is required.You can have a minimum of 1 and a maximum of 5
DomainunderDomainList. EachDomainmust be a minimum length of 1 and a maximum of 253 characters.- See Also:
-
getResourcePolicy
Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see Using resource-based policies with CloudWatch RUM .
Returns union: either
IResolvableorCfnAppMonitor.ResourcePolicyProperty- See Also:
-
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 .
- See Also:
-
builder
- Returns:
- a
CfnAppMonitorProps.BuilderofCfnAppMonitorProps
-