Package software.amazon.awssdk.services.rum.model

Interface AppMonitorConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AppMonitorConfiguration.Builder,AppMonitorConfiguration>, SdkBuilder<AppMonitorConfiguration.Builder,AppMonitorConfiguration>, SdkPojo
Enclosing class:
AppMonitorConfiguration
public static interface AppMonitorConfiguration.Builder extends SdkPojo, CopyableBuilder<AppMonitorConfiguration.Builder,AppMonitorConfiguration>

  • Method Details

    • allowCookies

      AppMonitorConfiguration.Builder allowCookies(Boolean allowCookies)

      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.

      Parameters:
      allowCookies - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableXRay

      AppMonitorConfiguration.Builder enableXRay(Boolean enableXRay)

      If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?

      Parameters:
      enableXRay - If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludedPages

      AppMonitorConfiguration.Builder excludedPages(Collection<String> excludedPages)

      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.

      Parameters:
      excludedPages - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludedPages

      AppMonitorConfiguration.Builder excludedPages(String... excludedPages)

      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.

      Parameters:
      excludedPages - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • favoritePages

      AppMonitorConfiguration.Builder favoritePages(Collection<String> favoritePages)

      A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

      Parameters:
      favoritePages - A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • favoritePages

      AppMonitorConfiguration.Builder favoritePages(String... favoritePages)

      A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

      Parameters:
      favoritePages - A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • guestRoleArn

      AppMonitorConfiguration.Builder guestRoleArn(String guestRoleArn)

      The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

      It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service.

      If this issue affects you, you can take one of the following steps:

      • Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.

      • Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.

      Parameters:
      guestRoleArn - The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

      It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service.

      If this issue affects you, you can take one of the following steps:

      • Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.

      • Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityPoolId

      AppMonitorConfiguration.Builder identityPoolId(String identityPoolId)

      The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

      Parameters:
      identityPoolId - The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includedPages

      AppMonitorConfiguration.Builder includedPages(Collection<String> includedPages)

      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.

      Parameters:
      includedPages - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includedPages

      AppMonitorConfiguration.Builder includedPages(String... includedPages)

      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.

      Parameters:
      includedPages - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionSampleRate

      AppMonitorConfiguration.Builder sessionSampleRate(Double sessionSampleRate)

      Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.

      The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.

      If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.

      Parameters:
      sessionSampleRate - Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.

      The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.

      If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • telemetriesWithStrings

      AppMonitorConfiguration.Builder telemetriesWithStrings(Collection<String> telemetries)

      An array that lists the types of telemetry data that this app monitor is to collect.

      • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

      • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

      • http indicates that RUM collects data about HTTP errors thrown by your application.

      Parameters:
      telemetries - An array that lists the types of telemetry data that this app monitor is to collect.

      • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

      • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

      • http indicates that RUM collects data about HTTP errors thrown by your application.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • telemetriesWithStrings

      AppMonitorConfiguration.Builder telemetriesWithStrings(String... telemetries)

      An array that lists the types of telemetry data that this app monitor is to collect.

      • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

      • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

      • http indicates that RUM collects data about HTTP errors thrown by your application.

      Parameters:
      telemetries - An array that lists the types of telemetry data that this app monitor is to collect.

      • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

      • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

      • http indicates that RUM collects data about HTTP errors thrown by your application.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • telemetries

      AppMonitorConfiguration.Builder telemetries(Collection<Telemetry> telemetries)

      An array that lists the types of telemetry data that this app monitor is to collect.

      • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

      • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

      • http indicates that RUM collects data about HTTP errors thrown by your application.

      Parameters:
      telemetries - An array that lists the types of telemetry data that this app monitor is to collect.

      • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

      • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

      • http indicates that RUM collects data about HTTP errors thrown by your application.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • telemetries

      AppMonitorConfiguration.Builder telemetries(Telemetry... telemetries)

      An array that lists the types of telemetry data that this app monitor is to collect.

      • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

      • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

      • http indicates that RUM collects data about HTTP errors thrown by your application.

      Parameters:
      telemetries - An array that lists the types of telemetry data that this app monitor is to collect.

      • errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

      • performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

      • http indicates that RUM collects data about HTTP errors thrown by your application.

      Returns:
      Returns a reference to this object so that method calls can be chained together.