CfnAppMonitorProps

class aws_cdk.aws_rum.CfnAppMonitorProps(*, domain, name, app_monitor_configuration=None, custom_events=None, cw_log_enabled=None, tags=None)

Bases: object

Properties for defining a CfnAppMonitor.

Parameters
  • domain (str) – The top-level internet domain name for which your application has administrative authority. This parameter is required.

  • name (str) – A name for the app monitor. This parameter is required.

  • app_monitor_configuration (Union[AppMonitorConfigurationProperty, Dict[str, Any], IResolvable, None]) – 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 . If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.

  • custom_events (Union[CustomEventsProperty, Dict[str, Any], IResolvable, None]) – Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED .

  • cw_log_enabled (Union[bool, IResolvable, None]) – 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 .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_rum as rum

cfn_app_monitor_props = rum.CfnAppMonitorProps(
    domain="domain",
    name="name",

    # the properties below are optional
    app_monitor_configuration=rum.CfnAppMonitor.AppMonitorConfigurationProperty(
        allow_cookies=False,
        enable_xRay=False,
        excluded_pages=["excludedPages"],
        favorite_pages=["favoritePages"],
        guest_role_arn="guestRoleArn",
        identity_pool_id="identityPoolId",
        included_pages=["includedPages"],
        metric_destinations=[rum.CfnAppMonitor.MetricDestinationProperty(
            destination="destination",

            # the properties below are optional
            destination_arn="destinationArn",
            iam_role_arn="iamRoleArn",
            metric_definitions=[rum.CfnAppMonitor.MetricDefinitionProperty(
                name="name",

                # the properties below are optional
                dimension_keys={
                    "dimension_keys_key": "dimensionKeys"
                },
                event_pattern="eventPattern",
                unit_label="unitLabel",
                value_key="valueKey"
            )]
        )],
        session_sample_rate=123,
        telemetries=["telemetries"]
    ),
    custom_events=rum.CfnAppMonitor.CustomEventsProperty(
        status="status"
    ),
    cw_log_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

app_monitor_configuration

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 .

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-appmonitorconfiguration

custom_events

Specifies whether this app monitor allows the web client to define and send custom events.

If you omit this parameter, custom events are DISABLED .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-customevents

cw_log_enabled

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-cwlogenabled

domain

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

This parameter is required.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-domain

name

A name for the app monitor.

This parameter is required.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-name

tags

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-tags