Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rum
  5. getAppMonitor

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.rum.getAppMonitor

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::RUM::AppMonitor

    Using getAppMonitor

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAppMonitor(args: GetAppMonitorArgs, opts?: InvokeOptions): Promise<GetAppMonitorResult>
function getAppMonitorOutput(args: GetAppMonitorOutputArgs, opts?: InvokeOptions): Output<GetAppMonitorResult>
    def get_app_monitor(name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAppMonitorResult
def get_app_monitor_output(name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAppMonitorResult]
    func LookupAppMonitor(ctx *Context, args *LookupAppMonitorArgs, opts ...InvokeOption) (*LookupAppMonitorResult, error)
func LookupAppMonitorOutput(ctx *Context, args *LookupAppMonitorOutputArgs, opts ...InvokeOption) LookupAppMonitorResultOutput

    > Note: This function is named LookupAppMonitor in the Go SDK.

    public static class GetAppMonitor 
{
    public static Task<GetAppMonitorResult> InvokeAsync(GetAppMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetAppMonitorResult> Invoke(GetAppMonitorInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAppMonitorResult> getAppMonitor(GetAppMonitorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:rum:getAppMonitor
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    A name for the app monitor
    Name string
    A name for the app monitor
    name String
    A name for the app monitor
    name string
    A name for the app monitor
    name str
    A name for the app monitor
    name String
    A name for the app monitor

    getAppMonitor Result

    The following output properties are available:

    AppMonitorConfiguration Pulumi.AwsNative.Rum.Outputs.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 AWS .

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

    CustomEvents Pulumi.AwsNative.Rum.Outputs.AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED .
    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
    Domain string
    The top-level internet domain name for which your application has administrative authority.
    Id string
    The unique ID of the new app monitor.
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    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 .

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

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

    CustomEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED .
    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
    Domain string
    The top-level internet domain name for which your application has administrative authority.
    Id string
    The unique ID of the new app monitor.
    Tags Tag

    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 .

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

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

    customEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED .
    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
    domain String
    The top-level internet domain name for which your application has administrative authority.
    id String
    The unique ID of the new app monitor.
    tags List<Tag>

    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 .

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

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

    customEvents AppMonitorCustomEvents
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED .
    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
    domain string
    The top-level internet domain name for which your application has administrative authority.
    id string
    The unique ID of the new app monitor.
    tags Tag[]

    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 .

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

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

    custom_events AppMonitorCustomEvents
    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 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
    domain str
    The top-level internet domain name for which your application has administrative authority.
    id str
    The unique ID of the new app monitor.
    tags Sequence[root_Tag]

    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 .

    appMonitorConfiguration Property Map

    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.

    customEvents Property Map
    Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED .
    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
    domain String
    The top-level internet domain name for which your application has administrative authority.
    id String
    The unique ID of the new app monitor.
    tags List<Property Map>

    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 .

    Supporting Types

    AppMonitorConfiguration

    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

    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

    AppMonitorMetricDefinition

    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 Dictionary<string, string>

    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 map[string]string

    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 Map<String,String>

    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 {[key: string]: string}

    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 Mapping[str, str]

    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 Map<String>

    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

    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

    AppMonitorTelemetry

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native