Class CfnAppMonitorProps
Properties for defining a CfnAppMonitor.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.RUM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAppMonitorProps : Object, ICfnAppMonitorPropsSyntax (vb)
Public Class CfnAppMonitorProps
Inherits Object
Implements ICfnAppMonitorPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RUM;
var cfnAppMonitorProps = new CfnAppMonitorProps {
Name = "name",
// the properties below are optional
AppMonitorConfiguration = new AppMonitorConfigurationProperty {
AllowCookies = false,
EnableXRay = false,
ExcludedPages = new [] { "excludedPages" },
FavoritePages = new [] { "favoritePages" },
GuestRoleArn = "guestRoleArn",
IdentityPoolId = "identityPoolId",
IncludedPages = new [] { "includedPages" },
MetricDestinations = new [] { new MetricDestinationProperty {
Destination = "destination",
// the properties below are optional
DestinationArn = "destinationArn",
IamRoleArn = "iamRoleArn",
MetricDefinitions = new [] { new MetricDefinitionProperty {
Name = "name",
// the properties below are optional
DimensionKeys = new Dictionary<string, string> {
{ "dimensionKeysKey", "dimensionKeys" }
},
EventPattern = "eventPattern",
Namespace = "namespace",
UnitLabel = "unitLabel",
ValueKey = "valueKey"
} }
} },
SessionSampleRate = 123,
Telemetries = new [] { "telemetries" }
},
CustomEvents = new CustomEventsProperty {
Status = "status"
},
CwLogEnabled = false,
DeobfuscationConfiguration = new DeobfuscationConfigurationProperty {
JavaScriptSourceMaps = new JavaScriptSourceMapsProperty {
Status = "status",
// the properties below are optional
S3Uri = "s3Uri"
}
},
Domain = "domain",
DomainList = new [] { "domainList" },
ResourcePolicy = new ResourcePolicyProperty {
PolicyDocument = "policyDocument",
// the properties below are optional
PolicyRevisionId = "policyRevisionId"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};Synopsis
Constructors
| Cfn |
Properties
| App |
A structure that contains much of the configuration data for the app monitor. |
| Custom |
Specifies whether this app monitor allows the web client to define and send custom events. |
| Cw |
Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. |
| Deobfuscation |
A structure that contains the configuration for how an app monitor can deobfuscate stack traces. |
| Domain | The top-level internet domain name for which your application has administrative authority. |
| Domain |
List the domain names for which your application has administrative authority. This parameter or the |
| Name | A name for the app monitor. |
| Resource |
Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. |
| Tags | Assigns one or more tags (key-value pairs) to the app monitor. |
Constructors
CfnAppMonitorProps()
public CfnAppMonitorProps()Properties
AppMonitorConfiguration
A structure that contains much of the configuration data for the app monitor.
public object AppMonitorConfiguration { get; set; }Property Value
System.
Remarks
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.
CustomEvents
Specifies whether this app monitor allows the web client to define and send custom events.
public object CustomEvents { get; set; }Property Value
System.
Remarks
If you omit this parameter, custom events are DISABLED .
CwLogEnabled
Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
public object CwLogEnabled { get; set; }Property Value
System.
Remarks
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 .
DeobfuscationConfiguration
A structure that contains the configuration for how an app monitor can deobfuscate stack traces.
public object DeobfuscationConfiguration { get; set; }Property Value
System.
Remarks
Domain
The top-level internet domain name for which your application has administrative authority.
public string Domain { get; set; }Property Value
System.
Remarks
This parameter or the DomainList parameter is required.
DomainList
List the domain names for which your application has administrative authority. This parameter or the Domain parameter is required.
public string[] DomainList { get; set; }Property Value
System.
Remarks
You can have a minimum of 1 and a maximum of 5 Domain under DomainList . Each Domain must be a minimum length of 1 and a maximum of 253 characters.
Name
A name for the app monitor.
public string Name { get; set; }Property Value
System.
Remarks
This parameter is required.
ResourcePolicy
Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.
public object ResourcePolicy { get; set; }Property Value
System.
Remarks
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 .
Tags
Assigns one or more tags (key-value pairs) to the app monitor.
public ICfnTag[] Tags { get; set; }Property Value
ICfn
Remarks
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 .