interface CfnAppMonitorProps

Language	Type name
.NET	Amazon.CDK.AWS.RUM.CfnAppMonitorProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrum#CfnAppMonitorProps
Java	software.amazon.awscdk.services.rum.CfnAppMonitorProps
Python	aws_cdk.aws_rum.CfnAppMonitorProps
TypeScript	aws-cdk-lib » aws_rum » CfnAppMonitorProps

Properties for defining a CfnAppMonitor.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rum as rum } from 'aws-cdk-lib';
const cfnAppMonitorProps: rum.CfnAppMonitorProps = {
  domain: 'domain',
  name: 'name',

  // the properties below are optional
  appMonitorConfiguration: {
    allowCookies: false,
    enableXRay: false,
    excludedPages: ['excludedPages'],
    favoritePages: ['favoritePages'],
    guestRoleArn: 'guestRoleArn',
    identityPoolId: 'identityPoolId',
    includedPages: ['includedPages'],
    metricDestinations: [{
      destination: 'destination',

      // the properties below are optional
      destinationArn: 'destinationArn',
      iamRoleArn: 'iamRoleArn',
      metricDefinitions: [{
        name: 'name',

        // the properties below are optional
        dimensionKeys: {
          dimensionKeysKey: 'dimensionKeys',
        },
        eventPattern: 'eventPattern',
        namespace: 'namespace',
        unitLabel: 'unitLabel',
        valueKey: 'valueKey',
      }],
    }],
    sessionSampleRate: 123,
    telemetries: ['telemetries'],
  },
  customEvents: {
    status: 'status',
  },
  cwLogEnabled: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
domain	string	The top-level internet domain name for which your application has administrative authority.
name	string	A name for the app monitor.
appMonitorConfiguration?	IResolvable | AppMonitorConfigurationProperty	A structure that contains much of the configuration data for the app monitor.
customEvents?	IResolvable | CustomEventsProperty	Specifies whether this app monitor allows the web client to define and send custom events.
cwLogEnabled?	boolean | IResolvable	Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
tags?	CfnTag[]	Assigns one or more tags (key-value pairs) to the app monitor.

---

domain

Type: string

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

This parameter is required.

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

---

name

Type: string

A name for the app monitor.

This parameter is required.

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

---

appMonitorConfiguration?

Type: IResolvable | AppMonitorConfigurationProperty (optional)

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.

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

---

customEvents?

Type: IResolvable | CustomEventsProperty (optional)

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

If you omit this parameter, custom events are DISABLED .

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

---

cwLogEnabled?

Type: boolean | IResolvable (optional)

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 .

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

---

tags?

Type: CfnTag[] (optional)

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-tags