app_monitors

Creates, updates, deletes or gets an app_monitor resource or lists app_monitors in a region

Overview

Name	app_monitors
Type	Resource
Description	Resource Type definition for AWS::RUM::AppMonitor
Id	aws.rum.app_monitors

Fields

Name	Datatype	Description
id	string	The unique ID of the new app monitor.
name	string	A name for the app monitor
domain	string	The top-level internet domain name for which your application has administrative authority.
cw_log_enabled	boolean	Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to CWLlong in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur CWLlong charges. If you omit this parameter, the default is false
tags	array	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.
app_monitor_configuration	object	AppMonitor configuration
custom_events	object	AppMonitor custom events configuration
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Domain, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all app_monitors in a region.

SELECT
region,
id,
name,
domain,
cw_log_enabled,
tags,
app_monitor_configuration,
custom_events
FROM aws.rum.app_monitors
WHERE region = 'us-east-1';

Gets all properties from an individual app_monitor.

SELECT
region,
id,
name,
domain,
cw_log_enabled,
tags,
app_monitor_configuration,
custom_events
FROM aws.rum.app_monitors
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new app_monitor resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.rum.app_monitors (
 Name,
 Domain,
 region
)
SELECT 
'{{ Name }}',
 '{{ Domain }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.rum.app_monitors (
 Name,
 Domain,
 CwLogEnabled,
 Tags,
 AppMonitorConfiguration,
 CustomEvents,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Domain }}',
 '{{ CwLogEnabled }}',
 '{{ Tags }}',
 '{{ AppMonitorConfiguration }}',
 '{{ CustomEvents }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: app_monitor
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Domain
        value: '{{ Domain }}'
      - name: CwLogEnabled
        value: '{{ CwLogEnabled }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: AppMonitorConfiguration
        value:
          IdentityPoolId: '{{ IdentityPoolId }}'
          ExcludedPages:
            - '{{ ExcludedPages[0] }}'
          IncludedPages: null
          FavoritePages:
            - '{{ FavoritePages[0] }}'
          SessionSampleRate: null
          GuestRoleArn: '{{ GuestRoleArn }}'
          AllowCookies: '{{ AllowCookies }}'
          Telemetries:
            - '{{ Telemetries[0] }}'
          EnableXRay: '{{ EnableXRay }}'
          MetricDestinations:
            - Destination: '{{ Destination }}'
              DestinationArn: '{{ DestinationArn }}'
              IamRoleArn: '{{ IamRoleArn }}'
              MetricDefinitions:
                - Name: '{{ Name }}'
                  Namespace: '{{ Namespace }}'
                  ValueKey: '{{ ValueKey }}'
                  UnitLabel: '{{ UnitLabel }}'
                  DimensionKeys: {}
                  EventPattern: '{{ EventPattern }}'
      - name: CustomEvents
        value:
          Status: '{{ Status }}'

DELETE example

/*+ delete */
DELETE FROM aws.rum.app_monitors
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the app_monitors resource, the following permissions are required:

Create

rum:GetAppMonitor,
rum:CreateAppMonitor,
dynamodb:GetItem,
dynamodb:PutItem,
s3:GetObject,
s3:PutObject,
s3:GetObjectAcl,
s3:DoesObjectExist,
logs:CreateLogDelivery,
logs:CreateLogGroup,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
logs:PutRetentionPolicy,
rum:TagResource,
rum:ListTagsForResource,
cognito-identity:DescribeIdentityPool,
iam:GetRole,
iam:CreateServiceLinkedRole,
iam:PassRole,
rum:PutRumMetricsDestination,
rum:BatchCreateRumMetricDefinitions,
rum:ListRumMetricsDestinations,
rum:BatchGetRumMetricDefinitions

Read

rum:GetAppMonitor,
dynamodb:GetItem,
s3:GetObject,
s3:DoesObjectExist,
s3:GetObjectAcl,
rum:ListTagsForResource,
rum:ListRumMetricsDestinations,
rum:BatchGetRumMetricDefinitions

Update

rum:GetAppMonitor,
rum:UpdateAppMonitor,
dynamodb:GetItem,
dynamodb:PutItem,
dynamodb:UpdateItem,
dynamodb:Query,
s3:GetObject,
s3:PutObject,
s3:GetObjectAcl,
s3:DoesObjectExist,
logs:CreateLogDelivery,
logs:CreateLogGroup,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:PutResourcePolicy,
logs:DescribeResourcePolicies,
logs:DescribeLogGroups,
logs:PutRetentionPolicy,
rum:TagResource,
rum:UntagResource,
rum:ListTagsForResource,
iam:GetRole,
iam:CreateServiceLinkedRole,
iam:PassRole,
rum:PutRumMetricsDestination,
rum:DeleteRumMetricsDestination,
rum:ListRumMetricsDestinations,
rum:BatchCreateRumMetricDefinitions,
rum:BatchDeleteRumMetricDefinitions,
rum:BatchGetRumMetricDefinitions,
rum:UpdateRumMetricDefinition

Delete

rum:GetAppMonitor,
rum:DeleteAppMonitor,
dynamodb:DeleteItem,
dynamodb:Query,
logs:DeleteLogDelivery,
s3:DeleteObject,
s3:DoesObjectExist,
rum:UntagResource,
rum:ListTagsForResource,
rum:DeleteRumMetricsDestination,
rum:BatchDeleteRumMetricDefinitions,
rum:ListRumMetricsDestinations,
rum:BatchGetRumMetricDefinitions

List

rum:ListAppMonitors,
dynamodb:DescribeTable,
rum:GetAppMonitor,
dynamodb:GetItem,
dynamodb:BatchGetItem,
dynamodb:Query,
s3:GetObject,
s3:DoesObjectExist,
s3:GetObjectAcl,
logs:DescribeLogGroups,
rum:ListTagsForResource