Class CfnAppMonitorProps

Properties for defining a CfnAppMonitor.

Inheritance
System.Object
CfnAppMonitorProps
Implements
Namespace: Amazon.CDK.AWS.RUM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAppMonitorProps : Object, ICfnAppMonitorProps
Syntax (vb)
Public Class CfnAppMonitorProps
    Inherits Object
    Implements ICfnAppMonitorProps
Remarks

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 {
    Domain = "domain",
    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,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Constructors

CfnAppMonitorProps()

Properties

AppMonitorConfiguration

A structure that contains much of the configuration data for the app monitor.
CustomEvents

Specifies whether this app monitor allows the web client to define and send custom events.
CwLogEnabled

Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
Domain

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

A name for the app monitor.
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.Object

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-appmonitorconfiguration

CustomEvents

Specifies whether this app monitor allows the web client to define and send custom events.

public object CustomEvents { get; set; }
Property Value

System.Object

Remarks

If you omit this parameter, custom events are DISABLED .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-customevents

CwLogEnabled

Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

public object CwLogEnabled { get; set; }
Property Value

System.Object

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-cwlogenabled

Domain

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

public string Domain { get; set; }
Property Value

System.String

Remarks

This parameter is required.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-domain

Name

A name for the app monitor.

public string Name { get; set; }
Property Value

System.String

Remarks

This parameter is required.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-name

Tags

Assigns one or more tags (key-value pairs) to the app monitor.

public ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-tags

Implements