# CfnAppMonitor

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

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?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html)

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnAppMonitor
Implements: IInspectable, ITaggable, IEnvironmentAware, IAppMonitorRef, IConstruct, IDependable

- CloudFormation: [`AWS::RUM::AppMonitor`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-rum-appmonitor.html)
- Source: Generated code
- Type last changed: v2.252.0 · 30 Apr 2026

## Example

```ts
// 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 cfnAppMonitor = new rum.CfnAppMonitor(this, 'MyCfnAppMonitor', {
  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,
  deobfuscationConfiguration: {
    javaScriptSourceMaps: {
      status: 'status',

      // the properties below are optional
      s3Uri: 's3Uri',
    },
  },
  domain: 'domain',
  domainList: ['domainList'],
  platform: 'platform',
  resourcePolicy: {
    policyDocument: 'policyDocument',

    // the properties below are optional
    policyRevisionId: 'policyRevisionId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});
```

## Initializer

```ts
new CfnAppMonitor(scope: Construct, id: string, props: CfnAppMonitorProps)
```

## Construct Props

- `appMonitorConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAppMonitor.AppMonitorConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_rum.CfnAppMonitor.AppMonitorConfigurationProperty.html) — 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html) .

  If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.

- `customEvents`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAppMonitor.CustomEventsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_rum.CfnAppMonitor.CustomEventsProperty.html) — Specifies whether this app monitor allows the web client to define and send custom events.

  If you omit this parameter, custom events are `DISABLED` .

- `cwLogEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — 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` .

- `deobfuscationConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAppMonitor.DeobfuscationConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_rum.CfnAppMonitor.DeobfuscationConfigurationProperty.html) — A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

- `domain`: string — The top-level internet domain name for which your application has administrative authority.

  This parameter or the `DomainList` parameter is required.

- `domainList`: string[] — List the domain names for which your application has administrative authority. This parameter or the `Domain` parameter is required.

  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`: string (required) — A name for the app monitor.

  This parameter is required.

- `platform`: string

- `resourcePolicy`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAppMonitor.ResourcePolicyProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_rum.CfnAppMonitor.ResourcePolicyProperty.html) — Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.

  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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-resource-policies.html) .

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — 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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .

## Properties

- `appMonitorConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAppMonitor.AppMonitorConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_rum.CfnAppMonitor.AppMonitorConfigurationProperty.html) — A structure that contains much of the configuration data for the app monitor.

- `appMonitorRef`: [AppMonitorReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_rum.AppMonitorReference.html) — A reference to a AppMonitor resource.

- `attrId`: string — The ID of the app monitor, such as `123456ab-1234-4ca9-9d2f-a1b2c3456789` .

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `creationStack`: string[]

- `customEvents`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAppMonitor.CustomEventsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_rum.CfnAppMonitor.CustomEventsProperty.html) — Specifies whether this app monitor allows the web client to define and send custom events.

- `cwLogEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

- `deobfuscationConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAppMonitor.DeobfuscationConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_rum.CfnAppMonitor.DeobfuscationConfigurationProperty.html) — A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

- `domain`: string — The top-level internet domain name for which your application has administrative authority.

- `domainList`: string[] — List the domain names for which your application has administrative authority.

  This parameter or the `Domain` parameter is required.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

- `logicalId`: string — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `name`: string — A name for the app monitor.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `platform`: string

- `ref`: string — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `resourcePolicy`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAppMonitor.ResourcePolicyProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_rum.CfnAppMonitor.ResourcePolicyProperty.html) — Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

- `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `tagsRaw`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Assigns one or more tags (key-value pairs) to the app monitor.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForAppMonitor(resource: IAppMonitorRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnAppMonitor(x: any): boolean` (static) — Checks whether the given object is a CfnAppMonitor.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.