Class CfnAppMonitor

Creates a CloudWatch RUM app monitor, which you can use to collect telemetry data from your application and send it to CloudWatch RUM.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnAppMonitor

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(Object)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<ResolutionTypeHint>)

CfnResource.GetMetadata(String)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.RUM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAppMonitor : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnAppMonitor
    Inherits CfnResource
    Implements IInspectable, ITaggable

Remarks

The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?

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

CloudformationResource: AWS::RUM::AppMonitor

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 cfnAppMonitor = new CfnAppMonitor(this, "MyCfnAppMonitor", 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

CfnAppMonitor(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnAppMonitor(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnAppMonitor(Construct, String, ICfnAppMonitorProps)

Properties

AppMonitorConfiguration	A structure that contains much of the configuration data for the app monitor.
AttrId	The ID of the app monitor, such as `123456ab-1234-4ca9-9d2f-a1b2c3456789` .
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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.
DeobfuscationConfiguration	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.
DomainList	List the domain names for which your application has administrative authority.
Name	A name for the app monitor.
ResourcePolicy	Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Assigns one or more tags (key-value pairs) to the app monitor.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnAppMonitor(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnAppMonitor(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnAppMonitor(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnAppMonitor(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnAppMonitor(Construct, String, ICfnAppMonitorProps)

public CfnAppMonitor(Construct scope, string id, ICfnAppMonitorProps props)

Parameters

scope Constructs.Construct: Scope in which this resource is defined.
id System.String: Construct identifier for this resource (unique in its scope).
props ICfnAppMonitorProps: Resource properties.

Properties

AppMonitorConfiguration

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

public virtual object AppMonitorConfiguration { get; set; }

Property Value

System.Object

AttrId

The ID of the app monitor, such as 123456ab-1234-4ca9-9d2f-a1b2c3456789 .

public virtual string AttrId { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

CustomEvents

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

public virtual object CustomEvents { get; set; }

Property Value

System.Object

CwLogEnabled

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

public virtual object CwLogEnabled { get; set; }

Property Value

System.Object

DeobfuscationConfiguration

A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

public virtual object DeobfuscationConfiguration { get; set; }

Property Value

System.Object

Domain

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

public virtual string Domain { get; set; }

Property Value

System.String

DomainList

List the domain names for which your application has administrative authority.

public virtual string[] DomainList { get; set; }

Property Value

System.String[]

Remarks

This parameter or the Domain parameter is required.

Name

A name for the app monitor.

public virtual string Name { get; set; }

Property Value

System.String

ResourcePolicy

Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.

public virtual object ResourcePolicy { get; set; }

Property Value

System.Object

TagsRaw

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

public virtual ICfnTag[] TagsRaw { get; set; }

Property Value

ICfnTag[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable

ITaggable