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	awscc.rum.app_monitors

Fields

get (all properties)

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. The CreateAppMonitor requires either the domain or the domain list.
domain_list	array	The top-level internet domain names for which your application has administrative authority. The CreateAppMonitor requires either the domain or the domain list.
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
▶resource_policy	object	A structure that defines resource policy attached to your app monitor.
▶deobfuscation_configuration	object	A structure that contains the configuration for how an app monitor can deobfuscate stack traces.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	A name for the app monitor
region	string	AWS region.

For more information, see AWS::RUM::AppMonitor.

Methods

Name	Resource	Accessible by	Required Params
create_resource	app_monitors	INSERT	Name, region
delete_resource	app_monitors	DELETE	Identifier, region
update_resource	app_monitors	UPDATE	Identifier, PatchDocument, region
list_resources	app_monitors_list_only	SELECT	region
get_resource	app_monitors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual app_monitor.

SELECT
  region,
  id,
  name,
  domain,
  domain_list,
  cw_log_enabled,
  tags,
  app_monitor_configuration,
  custom_events,
  resource_policy,
  deobfuscation_configuration
FROM awscc.rum.app_monitors
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all app_monitors in a region.

SELECT
  region,
  name
FROM awscc.rum.app_monitors_list_only
WHERE
  region = '{{ region }}';

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 awscc.rum.app_monitors (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.rum.app_monitors (
  Name,
  Domain,
  DomainList,
  CwLogEnabled,
  Tags,
  AppMonitorConfiguration,
  CustomEvents,
  ResourcePolicy,
  DeobfuscationConfiguration,
  region
)
SELECT
  '{{ name }}',
  '{{ domain }}',
  '{{ domain_list }}',
  '{{ cw_log_enabled }}',
  '{{ tags }}',
  '{{ app_monitor_configuration }}',
  '{{ custom_events }}',
  '{{ resource_policy }}',
  '{{ deobfuscation_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: domain_list
      value:
        - '{{ domain_list[0] }}'
    - name: cw_log_enabled
      value: '{{ cw_log_enabled }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: app_monitor_configuration
      value:
        identity_pool_id: '{{ identity_pool_id }}'
        excluded_pages:
          - '{{ excluded_pages[0] }}'
        included_pages: null
        favorite_pages:
          - '{{ favorite_pages[0] }}'
        session_sample_rate: null
        guest_role_arn: '{{ guest_role_arn }}'
        allow_cookies: '{{ allow_cookies }}'
        telemetries:
          - '{{ telemetries[0] }}'
        enable_xray: '{{ enable_xray }}'
        metric_destinations:
          - destination: '{{ destination }}'
            destination_arn: '{{ destination_arn }}'
            iam_role_arn: '{{ iam_role_arn }}'
            metric_definitions:
              - name: '{{ name }}'
                namespace: '{{ namespace }}'
                value_key: '{{ value_key }}'
                unit_label: '{{ unit_label }}'
                dimension_keys: {}
                event_pattern: '{{ event_pattern }}'
    - name: custom_events
      value:
        status: '{{ status }}'
    - name: resource_policy
      value:
        policy_document: '{{ policy_document }}'
        policy_revision_id: '{{ policy_revision_id }}'
    - name: deobfuscation_configuration
      value:
        java_script_source_maps:
          status: '{{ status }}'
          s3_uri: '{{ s3_uri }}'

UPDATE example

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

/*+ update */
UPDATE awscc.rum.app_monitors
SET PatchDocument = string('{{ {
    "Domain": domain,
    "DomainList": domain_list,
    "CwLogEnabled": cw_log_enabled,
    "Tags": tags,
    "AppMonitorConfiguration": app_monitor_configuration,
    "CustomEvents": custom_events,
    "ResourcePolicy": resource_policy,
    "DeobfuscationConfiguration": deobfuscation_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.rum.app_monitors
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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,
rum:GetResourcePolicy,
rum:PutResourcePolicy

Read

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

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,
rum:GetResourcePolicy,
rum:PutResourcePolicy,
rum:DeleteResourcePolicy

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,
rum:GetResourcePolicy,
rum:PutResourcePolicy,
rum:DeleteResourcePolicy

List

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