awscc.rum_appmonitor¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - rum:DeleteAppMonitor, dynamodb:DeleteItem, dynamodb:Query, logs:DeleteLogDelivery, s3:DeleteObject, s3:DoesObjectExist, rum:UntagResource
update¶
Parent base class for filters and actions.
definitions:
AppMonitorConfiguration:
additionalProperties: false
description: AppMonitor configuration
properties:
AllowCookies:
description: If you set this to true, the RUM web client sets two cookies,
a session cookie and a user cookie. The cookies allow the RUM web client
to collect data relating to the number of users an application has and the
behavior of the application across a sequence of events. Cookies are stored
in the top-level domain of the current page.
type: boolean
EnableXRay:
description: If you set this to true, RUM enables xray tracing for the user
sessions that RUM samples. RUM adds an xray trace header to allowed HTTP
requests. It also records an xray segment for allowed HTTP requests. You
can see traces and segments from these user sessions in the xray console
and the CW ServiceLens console.
type: boolean
ExcludedPages:
description: List of url pages
insertionOrder: false
items:
description: Page Url
maxLength: 1260
minLength: 1
pattern: https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
type: string
maxItems: 50
minItems: 0
type: array
FavoritePages:
description: List of favorite pages
insertionOrder: false
items:
type: string
maxItems: 50
minItems: 0
type: array
GuestRoleArn:
description: Resource ARN
pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*
type: string
IdentityPoolId:
description: The ID of the identity pool that is used to authorize the sending
of data to RUM.
maxLength: 55
minLength: 1
pattern: '[\w-]+:[0-9a-f-]+'
type: string
IncludedPages:
description: List of url pages
insertionOrder: false
items:
description: Page Url
maxLength: 1260
minLength: 1
pattern: https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
type: string
maxItems: 50
minItems: 0
type: array
SessionSampleRate:
description: Specifies the percentage of user sessions to use for RUM data
collection. Choosing a higher percentage gives you more data but also incurs
more costs. The number you specify is the percentage of user sessions that
will be used. If you omit this parameter, the default of 10 is used.
maximum: 1
minimum: 0
type: number
Telemetries:
description: An array that lists the types of telemetry data that this app
monitor is to collect.
insertionOrder: false
items:
enum:
- errors
- performance
- http
type: string
type: array
type: object
Arn:
description: Resource ARN
pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*
type: string
FavoritePages:
description: List of favorite pages
insertionOrder: false
items:
type: string
maxItems: 50
minItems: 0
type: array
Pages:
description: List of url pages
insertionOrder: false
items:
description: Page Url
maxLength: 1260
minLength: 1
pattern: https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
type: string
maxItems: 50
minItems: 0
type: array
Tag:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1 to
128 Unicode characters in length and cannot be prefixed with aws:. You can
use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
type: string
Value:
description: 'The value for the tag. You can specify a value that is 0 to
256 Unicode characters in length and cannot be prefixed with aws:. You can
use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 256
minLength: 0
type: string
required:
- Value
- Key
type: object
TagDef:
description: 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.
insertionOrder: false
items:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1
to 128 Unicode characters in length and cannot be prefixed with aws:.
You can use any of the following characters: the set of Unicode letters,
digits, whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
type: string
Value:
description: 'The value for the tag. You can specify a value that is 0 to
256 Unicode characters in length and cannot be prefixed with aws:. You
can use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 256
minLength: 0
type: string
required:
- Value
- Key
type: object
type: array
uniqueItems: true
Telemetry:
enum:
- errors
- performance
- http
type: string
Url:
description: Page Url
maxLength: 1260
minLength: 1
pattern: https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
type: string
properties:
AppMonitorConfiguration:
additionalProperties: false
description: AppMonitor configuration
properties:
AllowCookies:
description: If you set this to true, the RUM web client sets two cookies,
a session cookie and a user cookie. The cookies allow the RUM web client
to collect data relating to the number of users an application has and the
behavior of the application across a sequence of events. Cookies are stored
in the top-level domain of the current page.
type: boolean
EnableXRay:
description: If you set this to true, RUM enables xray tracing for the user
sessions that RUM samples. RUM adds an xray trace header to allowed HTTP
requests. It also records an xray segment for allowed HTTP requests. You
can see traces and segments from these user sessions in the xray console
and the CW ServiceLens console.
type: boolean
ExcludedPages:
description: List of url pages
insertionOrder: false
items:
description: Page Url
maxLength: 1260
minLength: 1
pattern: https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
type: string
maxItems: 50
minItems: 0
type: array
FavoritePages:
description: List of favorite pages
insertionOrder: false
items:
type: string
maxItems: 50
minItems: 0
type: array
GuestRoleArn:
description: Resource ARN
pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*
type: string
IdentityPoolId:
description: The ID of the identity pool that is used to authorize the sending
of data to RUM.
maxLength: 55
minLength: 1
pattern: '[\w-]+:[0-9a-f-]+'
type: string
IncludedPages:
description: List of url pages
insertionOrder: false
items:
description: Page Url
maxLength: 1260
minLength: 1
pattern: https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
type: string
maxItems: 50
minItems: 0
type: array
SessionSampleRate:
description: Specifies the percentage of user sessions to use for RUM data
collection. Choosing a higher percentage gives you more data but also incurs
more costs. The number you specify is the percentage of user sessions that
will be used. If you omit this parameter, the default of 10 is used.
maximum: 1
minimum: 0
type: number
Telemetries:
description: An array that lists the types of telemetry data that this app
monitor is to collect.
insertionOrder: false
items:
enum:
- errors
- performance
- http
type: string
type: array
type: object
CwLogEnabled:
description: 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
type: boolean
Domain:
description: The top-level internet domain name for which your application has
administrative authority.
maxLength: 253
minLength: 1
pattern: ^(localhost)|^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))|^(\*\.)(?![-.])([A-Za-z0-9-\.\-]{0,63})((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))\.(?![-])[A-Za-z-0-9]{1,63}((?![-])([a-zA-Z0-9]{1}|^[a-zA-Z0-9]{0,1}))
type: string
Tags:
description: 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.
insertionOrder: false
items:
additionalProperties: false
description: A key-value pair to associate with a resource.
properties:
Key:
description: 'The key name of the tag. You can specify a value that is 1
to 128 Unicode characters in length and cannot be prefixed with aws:.
You can use any of the following characters: the set of Unicode letters,
digits, whitespace, _, ., /, =, +, and -. '
maxLength: 128
minLength: 1
pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$
type: string
Value:
description: 'The value for the tag. You can specify a value that is 0 to
256 Unicode characters in length and cannot be prefixed with aws:. You
can use any of the following characters: the set of Unicode letters, digits,
whitespace, _, ., /, =, +, and -. '
maxLength: 256
minLength: 0
type: string
required:
- Value
- Key
type: object
type: array
uniqueItems: true
type:
enum:
- update
Permissions - 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