Skip to content

CreateAppMonitorRequest

Source code in docs_src/capo_rum/types/create_app_monitor_request.py
class CreateAppMonitorRequest(TypedDict, closed=True):
    name: "capo_rum.types.app_monitor_name.AppMonitorName"
    """<p>A name for the app monitor.</p>"""
    domain: NotRequired["capo_rum.types.app_monitor_domain.AppMonitorDomain"]
    """<p>The top-level internet domain name for which your application has administrative authority.</p>"""
    domain_list: NotRequired[
        "capo_rum.types.app_monitor_domain_list.AppMonitorDomainList"
    ]
    """<p> List the domain names for which your application has administrative authority. The <code>CreateAppMonitor</code> requires either the domain or the domain list. </p>"""
    tags: NotRequired["capo_rum.types.tag_map.TagMap"]
    """<p>Assigns one or more tags (key-value pairs) to the app monitor.</p> <p>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.</p> <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p> <p>You can associate as many as 50 tags with an app monitor.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>"""
    app_monitor_configuration: NotRequired[
        "capo_rum.types.app_monitor_configuration.AppMonitorConfiguration"
    ]
    """<p>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 <code>AppMonitorConfiguration</code>, you must set up your own authorization method. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application to send data to Amazon Web Services</a>.</p> <p>If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.</p>"""
    cw_log_enabled: NotRequired["bool"]
    """<p>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 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.</p> <p>If you omit this parameter, the default is <code>false</code>.</p>"""
    custom_events: NotRequired["capo_rum.types.custom_events.CustomEvents"]
    """<p>Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are <code>DISABLED</code>.</p> <p>For more information about custom events, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html">Send custom events</a>.</p>"""
    deobfuscation_configuration: NotRequired[
        "capo_rum.types.deobfuscation_configuration.DeobfuscationConfiguration"
    ]
    """<p> A structure that contains the configuration for how an app monitor can deobfuscate stack traces. </p>"""
    platform: NotRequired["capo_rum.types.app_monitor_platform.AppMonitorPlatform"]
    """<p>The platform type for the app monitor. Valid values are <code>Web</code> for web applications, <code>Android</code> for Android applications, and <code>iOS</code> for IOS applications. If you omit this parameter, the default is <code>Web</code>.</p>"""

app_monitor_configuration instance-attribute

app_monitor_configuration: NotRequired[AppMonitorConfiguration]

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 Amazon Web Services.

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

custom_events instance-attribute

custom_events: NotRequired[CustomEvents]

Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.

For more information about custom events, see Send custom events.

cw_log_enabled instance-attribute

cw_log_enabled: NotRequired[bool]

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 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.

deobfuscation_configuration instance-attribute

deobfuscation_configuration: NotRequired[DeobfuscationConfiguration]

A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

domain instance-attribute

domain: NotRequired[AppMonitorDomain]

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

domain_list instance-attribute

domain_list: NotRequired[AppMonitorDomainList]

List the domain names for which your application has administrative authority. The CreateAppMonitor requires either the domain or the domain list.

name instance-attribute

A name for the app monitor.

platform instance-attribute

platform: NotRequired[AppMonitorPlatform]

The platform type for the app monitor. Valid values are Web for web applications, Android for Android applications, and iOS for IOS applications. If you omit this parameter, the default is Web.

tags instance-attribute

tags: NotRequired[TagMap]

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 Amazon Web Services 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 Amazon Web Services resources.