Interface CfnAppMonitorPropsMixin.IAppMonitorConfigurationProperty
This structure contains much of the configuration data for the app monitor.
Namespace: Amazon.CDK.Mixins.Preview.AWS.RUM.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public interface CfnAppMonitorPropsMixin.IAppMonitorConfigurationPropertySyntax (vb)
Public Interface CfnAppMonitorPropsMixin.IAppMonitorConfigurationPropertyRemarks
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.Mixins.Preview.AWS.RUM.Mixins;
var appMonitorConfigurationProperty = 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",
DestinationArn = "destinationArn",
IamRoleArn = "iamRoleArn",
MetricDefinitions = new [] { new MetricDefinitionProperty {
DimensionKeys = new Dictionary<string, string> {
{ "dimensionKeysKey", "dimensionKeys" }
},
EventPattern = "eventPattern",
Name = "name",
Namespace = "namespace",
UnitLabel = "unitLabel",
ValueKey = "valueKey"
} }
} },
SessionSampleRate = 123,
Telemetries = new [] { "telemetries" }
};Synopsis
Properties
| AllowCookies | If you set this to |
| EnableXRay | If you set this to |
| ExcludedPages | A list of URLs in your website or application to exclude from RUM data collection. |
| FavoritePages | A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console. |
| GuestRoleArn | The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM. |
| IdentityPoolId | The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM. |
| IncludedPages | If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. |
| MetricDestinations | An array of structures that each define a destination that this app monitor will send extended metrics to. |
| SessionSampleRate | Specifies the portion of user sessions to use for CloudWatch RUM data collection. |
| Telemetries | An array that lists the types of telemetry data that this app monitor is to collect. |
Properties
AllowCookies
If you set this to true , the CloudWatch RUM web client sets two cookies, a session cookie and a user cookie.
object? AllowCookies { get; }Property Value
Remarks
The cookies allow the CloudWatch RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.
Type union: either bool or IResolvable
EnableXRay
If you set this to true , CloudWatch RUM sends client-side traces to X-Ray for each sampled session.
object? EnableXRay { get; }Property Value
Remarks
You can then see traces and segments from these user sessions in the RUM dashboard and the CloudWatch ServiceLens console. For more information, see What is AWS X-Ray ?
Type union: either bool or IResolvable
ExcludedPages
A list of URLs in your website or application to exclude from RUM data collection.
string[]? ExcludedPages { get; }Property Value
string[]
Remarks
You can't include both ExcludedPages and IncludedPages in the same app monitor.
FavoritePages
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
string[]? FavoritePages { get; }Property Value
string[]
Remarks
GuestRoleArn
The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.
string? GuestRoleArn { get; }Property Value
Remarks
IdentityPoolId
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to CloudWatch RUM.
string? IdentityPoolId { get; }Property Value
Remarks
IncludedPages
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
string[]? IncludedPages { get; }Property Value
string[]
Remarks
You can't include both ExcludedPages and IncludedPages in the same app monitor.
MetricDestinations
An array of structures that each define a destination that this app monitor will send extended metrics to.
object? MetricDestinations { get; }Property Value
Remarks
SessionSampleRate
Specifies the portion of user sessions to use for CloudWatch RUM data collection.
double? SessionSampleRate { get; }Property Value
Remarks
Choosing a higher portion gives you more data but also incurs more costs.
The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.
If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.
Telemetries
An array that lists the types of telemetry data that this app monitor is to collect.
string[]? Telemetries { get; }Property Value
string[]