1. Packages
  2. AWS Native
  3. API Docs
  4. rum
  5. AppMonitor

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi

aws-native.rum.AppMonitor

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi

    Resource Type definition for AWS::RUM::AppMonitor

    Create AppMonitor Resource

    new AppMonitor(name: string, args: AppMonitorArgs, opts?: CustomResourceOptions);
    @overload
    def AppMonitor(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   app_monitor_configuration: Optional[AppMonitorConfigurationArgs] = None,
                   custom_events: Optional[AppMonitorCustomEventsArgs] = None,
                   cw_log_enabled: Optional[bool] = None,
                   domain: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Sequence[AppMonitorTagArgs]] = None)
    @overload
    def AppMonitor(resource_name: str,
                   args: AppMonitorArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewAppMonitor(ctx *Context, name string, args AppMonitorArgs, opts ...ResourceOption) (*AppMonitor, error)
    public AppMonitor(string name, AppMonitorArgs args, CustomResourceOptions? opts = null)
    public AppMonitor(String name, AppMonitorArgs args)
    public AppMonitor(String name, AppMonitorArgs args, CustomResourceOptions options)
    
    type: aws-native:rum:AppMonitor
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppMonitorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    AppMonitor Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AppMonitor resource accepts the following input properties:

    Domain string
    The top-level internet domain name for which your application has administrative authority.
    AppMonitorConfiguration Pulumi.AwsNative.Rum.Inputs.AppMonitorConfiguration
    CustomEvents Pulumi.AwsNative.Rum.Inputs.AppMonitorCustomEvents
    CwLogEnabled 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 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
    Name string
    A name for the app monitor
    Tags List<Pulumi.AwsNative.Rum.Inputs.AppMonitorTag>
    Domain string
    The top-level internet domain name for which your application has administrative authority.
    AppMonitorConfiguration AppMonitorConfigurationArgs
    CustomEvents AppMonitorCustomEventsArgs
    CwLogEnabled 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 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
    Name string
    A name for the app monitor
    Tags []AppMonitorTagArgs
    domain String
    The top-level internet domain name for which your application has administrative authority.
    appMonitorConfiguration AppMonitorConfiguration
    customEvents AppMonitorCustomEvents
    cwLogEnabled 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
    name String
    A name for the app monitor
    tags List<AppMonitorTag>
    domain string
    The top-level internet domain name for which your application has administrative authority.
    appMonitorConfiguration AppMonitorConfiguration
    customEvents AppMonitorCustomEvents
    cwLogEnabled 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
    name string
    A name for the app monitor
    tags AppMonitorTag[]
    domain str
    The top-level internet domain name for which your application has administrative authority.
    app_monitor_configuration AppMonitorConfigurationArgs
    custom_events AppMonitorCustomEventsArgs
    cw_log_enabled 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 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
    name str
    A name for the app monitor
    tags Sequence[AppMonitorTagArgs]
    domain String
    The top-level internet domain name for which your application has administrative authority.
    appMonitorConfiguration Property Map
    customEvents Property Map
    cwLogEnabled 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
    name String
    A name for the app monitor
    tags List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AppMonitor resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AppMonitorConfiguration, AppMonitorConfigurationArgs

    AllowCookies bool
    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.
    EnableXRay bool
    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.
    ExcludedPages List<string>
    A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation.
    FavoritePages List<string>
    A list of pages in the RUM console that are to be displayed with a favorite icon.
    GuestRoleArn string
    The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM.
    IdentityPoolId string
    The ID of the identity pool that is used to authorize the sending of data to RUM.
    IncludedPages List<string>
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation.
    MetricDestinations List<Pulumi.AwsNative.Rum.Inputs.AppMonitorMetricDestination>
    An array of structures which define the destinations and the metrics that you want to send.
    SessionSampleRate double
    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.
    Telemetries List<Pulumi.AwsNative.Rum.AppMonitorTelemetry>
    An array that lists the types of telemetry data that this app monitor is to collect.
    AllowCookies bool
    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.
    EnableXRay bool
    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.
    ExcludedPages []string
    A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation.
    FavoritePages []string
    A list of pages in the RUM console that are to be displayed with a favorite icon.
    GuestRoleArn string
    The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM.
    IdentityPoolId string
    The ID of the identity pool that is used to authorize the sending of data to RUM.
    IncludedPages []string
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation.
    MetricDestinations []AppMonitorMetricDestination
    An array of structures which define the destinations and the metrics that you want to send.
    SessionSampleRate float64
    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.
    Telemetries []AppMonitorTelemetry
    An array that lists the types of telemetry data that this app monitor is to collect.
    allowCookies Boolean
    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.
    enableXRay Boolean
    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.
    excludedPages List<String>
    A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation.
    favoritePages List<String>
    A list of pages in the RUM console that are to be displayed with a favorite icon.
    guestRoleArn String
    The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM.
    identityPoolId String
    The ID of the identity pool that is used to authorize the sending of data to RUM.
    includedPages List<String>
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation.
    metricDestinations List<AppMonitorMetricDestination>
    An array of structures which define the destinations and the metrics that you want to send.
    sessionSampleRate Double
    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.
    telemetries List<AppMonitorTelemetry>
    An array that lists the types of telemetry data that this app monitor is to collect.
    allowCookies boolean
    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.
    enableXRay boolean
    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.
    excludedPages string[]
    A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation.
    favoritePages string[]
    A list of pages in the RUM console that are to be displayed with a favorite icon.
    guestRoleArn string
    The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM.
    identityPoolId string
    The ID of the identity pool that is used to authorize the sending of data to RUM.
    includedPages string[]
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation.
    metricDestinations AppMonitorMetricDestination[]
    An array of structures which define the destinations and the metrics that you want to send.
    sessionSampleRate number
    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.
    telemetries AppMonitorTelemetry[]
    An array that lists the types of telemetry data that this app monitor is to collect.
    allow_cookies bool
    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.
    enable_x_ray bool
    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.
    excluded_pages Sequence[str]
    A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation.
    favorite_pages Sequence[str]
    A list of pages in the RUM console that are to be displayed with a favorite icon.
    guest_role_arn str
    The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM.
    identity_pool_id str
    The ID of the identity pool that is used to authorize the sending of data to RUM.
    included_pages Sequence[str]
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation.
    metric_destinations Sequence[AppMonitorMetricDestination]
    An array of structures which define the destinations and the metrics that you want to send.
    session_sample_rate float
    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.
    telemetries Sequence[AppMonitorTelemetry]
    An array that lists the types of telemetry data that this app monitor is to collect.
    allowCookies Boolean
    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.
    enableXRay Boolean
    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.
    excludedPages List<String>
    A list of URLs in your website or application to exclude from RUM data collection. You can't include both ExcludedPages and IncludedPages in the same operation.
    favoritePages List<String>
    A list of pages in the RUM console that are to be displayed with a favorite icon.
    guestRoleArn String
    The ARN of the guest IAM role that is attached to the identity pool that is used to authorize the sending of data to RUM.
    identityPoolId String
    The ID of the identity pool that is used to authorize the sending of data to RUM.
    includedPages List<String>
    If this app monitor is to collect data from only certain pages in your application, this structure lists those pages. You can't include both ExcludedPages and IncludedPages in the same operation.
    metricDestinations List<Property Map>
    An array of structures which define the destinations and the metrics that you want to send.
    sessionSampleRate Number
    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.
    telemetries List<"errors" | "performance" | "http">
    An array that lists the types of telemetry data that this app monitor is to collect.

    AppMonitorCustomEvents, AppMonitorCustomEventsArgs

    Status Pulumi.AwsNative.Rum.AppMonitorCustomEventsStatus
    Indicates whether AppMonitor accepts custom events.
    Status AppMonitorCustomEventsStatus
    Indicates whether AppMonitor accepts custom events.
    status AppMonitorCustomEventsStatus
    Indicates whether AppMonitor accepts custom events.
    status AppMonitorCustomEventsStatus
    Indicates whether AppMonitor accepts custom events.
    status AppMonitorCustomEventsStatus
    Indicates whether AppMonitor accepts custom events.
    status "ENABLED" | "DISABLED"
    Indicates whether AppMonitor accepts custom events.

    AppMonitorCustomEventsStatus, AppMonitorCustomEventsStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    AppMonitorCustomEventsStatusEnabled
    ENABLED
    AppMonitorCustomEventsStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    AppMonitorMetricDefinition, AppMonitorMetricDefinitionArgs

    Name string

    The name for the metric that is defined in this structure. For extended metrics, valid values are the following:

    PerformanceNavigationDuration

    PerformanceResourceDuration

    NavigationSatisfiedTransaction

    NavigationToleratedTransaction

    NavigationFrustratedTransaction

    WebVitalsCumulativeLayoutShift

    WebVitalsFirstInputDelay

    WebVitalsLargestContentfulPaint

    JsErrorCount

    HttpErrorCount

    SessionCount

    DimensionKeys object

    Use this field only if you are sending the metric to CloudWatch.

    This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:

    "metadata.pageId": "PageId"

    "metadata.browserName": "BrowserName"

    "metadata.deviceType": "DeviceType"

    "metadata.osName": "OSName"

    "metadata.countryCode": "CountryCode"

    "event_details.fileType": "FileType"

    All dimensions listed in this field must also be included in EventPattern.

    EventPattern string

    The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

    When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

    Example event patterns:

    '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

    If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

    Namespace string
    The namespace used by CloudWatch Metrics for the metric that is defined in this structure
    UnitLabel string
    The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
    ValueKey string

    The field within the event object that the metric value is sourced from.

    If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

    If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

    Name string

    The name for the metric that is defined in this structure. For extended metrics, valid values are the following:

    PerformanceNavigationDuration

    PerformanceResourceDuration

    NavigationSatisfiedTransaction

    NavigationToleratedTransaction

    NavigationFrustratedTransaction

    WebVitalsCumulativeLayoutShift

    WebVitalsFirstInputDelay

    WebVitalsLargestContentfulPaint

    JsErrorCount

    HttpErrorCount

    SessionCount

    DimensionKeys interface{}

    Use this field only if you are sending the metric to CloudWatch.

    This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:

    "metadata.pageId": "PageId"

    "metadata.browserName": "BrowserName"

    "metadata.deviceType": "DeviceType"

    "metadata.osName": "OSName"

    "metadata.countryCode": "CountryCode"

    "event_details.fileType": "FileType"

    All dimensions listed in this field must also be included in EventPattern.

    EventPattern string

    The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

    When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

    Example event patterns:

    '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

    If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

    Namespace string
    The namespace used by CloudWatch Metrics for the metric that is defined in this structure
    UnitLabel string
    The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
    ValueKey string

    The field within the event object that the metric value is sourced from.

    If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

    If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

    name String

    The name for the metric that is defined in this structure. For extended metrics, valid values are the following:

    PerformanceNavigationDuration

    PerformanceResourceDuration

    NavigationSatisfiedTransaction

    NavigationToleratedTransaction

    NavigationFrustratedTransaction

    WebVitalsCumulativeLayoutShift

    WebVitalsFirstInputDelay

    WebVitalsLargestContentfulPaint

    JsErrorCount

    HttpErrorCount

    SessionCount

    dimensionKeys Object

    Use this field only if you are sending the metric to CloudWatch.

    This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:

    "metadata.pageId": "PageId"

    "metadata.browserName": "BrowserName"

    "metadata.deviceType": "DeviceType"

    "metadata.osName": "OSName"

    "metadata.countryCode": "CountryCode"

    "event_details.fileType": "FileType"

    All dimensions listed in this field must also be included in EventPattern.

    eventPattern String

    The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

    When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

    Example event patterns:

    '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

    If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

    namespace String
    The namespace used by CloudWatch Metrics for the metric that is defined in this structure
    unitLabel String
    The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
    valueKey String

    The field within the event object that the metric value is sourced from.

    If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

    If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

    name string

    The name for the metric that is defined in this structure. For extended metrics, valid values are the following:

    PerformanceNavigationDuration

    PerformanceResourceDuration

    NavigationSatisfiedTransaction

    NavigationToleratedTransaction

    NavigationFrustratedTransaction

    WebVitalsCumulativeLayoutShift

    WebVitalsFirstInputDelay

    WebVitalsLargestContentfulPaint

    JsErrorCount

    HttpErrorCount

    SessionCount

    dimensionKeys any

    Use this field only if you are sending the metric to CloudWatch.

    This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:

    "metadata.pageId": "PageId"

    "metadata.browserName": "BrowserName"

    "metadata.deviceType": "DeviceType"

    "metadata.osName": "OSName"

    "metadata.countryCode": "CountryCode"

    "event_details.fileType": "FileType"

    All dimensions listed in this field must also be included in EventPattern.

    eventPattern string

    The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

    When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

    Example event patterns:

    '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

    If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

    namespace string
    The namespace used by CloudWatch Metrics for the metric that is defined in this structure
    unitLabel string
    The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
    valueKey string

    The field within the event object that the metric value is sourced from.

    If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

    If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

    name str

    The name for the metric that is defined in this structure. For extended metrics, valid values are the following:

    PerformanceNavigationDuration

    PerformanceResourceDuration

    NavigationSatisfiedTransaction

    NavigationToleratedTransaction

    NavigationFrustratedTransaction

    WebVitalsCumulativeLayoutShift

    WebVitalsFirstInputDelay

    WebVitalsLargestContentfulPaint

    JsErrorCount

    HttpErrorCount

    SessionCount

    dimension_keys Any

    Use this field only if you are sending the metric to CloudWatch.

    This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:

    "metadata.pageId": "PageId"

    "metadata.browserName": "BrowserName"

    "metadata.deviceType": "DeviceType"

    "metadata.osName": "OSName"

    "metadata.countryCode": "CountryCode"

    "event_details.fileType": "FileType"

    All dimensions listed in this field must also be included in EventPattern.

    event_pattern str

    The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

    When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

    Example event patterns:

    '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

    If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

    namespace str
    The namespace used by CloudWatch Metrics for the metric that is defined in this structure
    unit_label str
    The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
    value_key str

    The field within the event object that the metric value is sourced from.

    If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

    If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

    name String

    The name for the metric that is defined in this structure. For extended metrics, valid values are the following:

    PerformanceNavigationDuration

    PerformanceResourceDuration

    NavigationSatisfiedTransaction

    NavigationToleratedTransaction

    NavigationFrustratedTransaction

    WebVitalsCumulativeLayoutShift

    WebVitalsFirstInputDelay

    WebVitalsLargestContentfulPaint

    JsErrorCount

    HttpErrorCount

    SessionCount

    dimensionKeys Any

    Use this field only if you are sending the metric to CloudWatch.

    This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:

    "metadata.pageId": "PageId"

    "metadata.browserName": "BrowserName"

    "metadata.deviceType": "DeviceType"

    "metadata.osName": "OSName"

    "metadata.countryCode": "CountryCode"

    "event_details.fileType": "FileType"

    All dimensions listed in this field must also be included in EventPattern.

    eventPattern String

    The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

    When you define extended metrics, the metric definition is not valid if EventPattern is omitted.

    Example event patterns:

    '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'

    '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'

    If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

    namespace String
    The namespace used by CloudWatch Metrics for the metric that is defined in this structure
    unitLabel String
    The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
    valueKey String

    The field within the event object that the metric value is sourced from.

    If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches.

    If this metric is sent to Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.

    AppMonitorMetricDestination, AppMonitorMetricDestinationArgs

    Destination Pulumi.AwsNative.Rum.AppMonitorMetricDestinationDestination
    Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
    DestinationArn string
    Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
    IamRoleArn string

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

    MetricDefinitions List<Pulumi.AwsNative.Rum.Inputs.AppMonitorMetricDefinition>
    An array of structures which define the metrics that you want to send.
    Destination AppMonitorMetricDestinationDestination
    Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
    DestinationArn string
    Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
    IamRoleArn string

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

    MetricDefinitions []AppMonitorMetricDefinition
    An array of structures which define the metrics that you want to send.
    destination AppMonitorMetricDestinationDestination
    Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
    destinationArn String
    Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
    iamRoleArn String

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

    metricDefinitions List<AppMonitorMetricDefinition>
    An array of structures which define the metrics that you want to send.
    destination AppMonitorMetricDestinationDestination
    Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
    destinationArn string
    Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
    iamRoleArn string

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

    metricDefinitions AppMonitorMetricDefinition[]
    An array of structures which define the metrics that you want to send.
    destination AppMonitorMetricDestinationDestination
    Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
    destination_arn str
    Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
    iam_role_arn str

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

    metric_definitions Sequence[AppMonitorMetricDefinition]
    An array of structures which define the metrics that you want to send.
    destination "CloudWatch" | "Evidently"
    Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the Evidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
    destinationArn String
    Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
    iamRoleArn String

    This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

    This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

    metricDefinitions List<Property Map>
    An array of structures which define the metrics that you want to send.

    AppMonitorMetricDestinationDestination, AppMonitorMetricDestinationDestinationArgs

    CloudWatch
    CloudWatch
    Evidently
    Evidently
    AppMonitorMetricDestinationDestinationCloudWatch
    CloudWatch
    AppMonitorMetricDestinationDestinationEvidently
    Evidently
    CloudWatch
    CloudWatch
    Evidently
    Evidently
    CloudWatch
    CloudWatch
    Evidently
    Evidently
    CLOUD_WATCH
    CloudWatch
    EVIDENTLY
    Evidently
    "CloudWatch"
    CloudWatch
    "Evidently"
    Evidently

    AppMonitorTag, AppMonitorTagArgs

    Key string
    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 -.
    Value string
    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 -.
    Key string
    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 -.
    Value string
    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 -.
    key String
    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 -.
    value String
    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 -.
    key string
    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 -.
    value string
    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 -.
    key str
    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 -.
    value str
    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 -.
    key String
    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 -.
    value String
    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 -.

    AppMonitorTelemetry, AppMonitorTelemetryArgs

    Errors
    errors
    Performance
    performance
    Http
    http
    AppMonitorTelemetryErrors
    errors
    AppMonitorTelemetryPerformance
    performance
    AppMonitorTelemetryHttp
    http
    Errors
    errors
    Performance
    performance
    Http
    http
    Errors
    errors
    Performance
    performance
    Http
    http
    ERRORS
    errors
    PERFORMANCE
    performance
    HTTP
    http
    "errors"
    errors
    "performance"
    performance
    "http"
    http

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi