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

Interface CreateAppMonitorRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateAppMonitorRequest.Builder,CreateAppMonitorRequest>, RumRequest.Builder, SdkBuilder<CreateAppMonitorRequest.Builder,CreateAppMonitorRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateAppMonitorRequest
public static interface CreateAppMonitorRequest.Builder extends RumRequest.Builder, SdkPojo, CopyableBuilder<CreateAppMonitorRequest.Builder,CreateAppMonitorRequest>

  • Method Details

    • appMonitorConfiguration

      CreateAppMonitorRequest.Builder appMonitorConfiguration(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 Amazon Web Services.

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

      Parameters:
      appMonitorConfiguration - A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

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

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

    • appMonitorConfiguration

      default CreateAppMonitorRequest.Builder appMonitorConfiguration(Consumer<AppMonitorConfiguration.Builder> appMonitorConfiguration)

      A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

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

      This is a convenience method that creates an instance of the AppMonitorConfiguration.Builder avoiding the need to create one manually via AppMonitorConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to appMonitorConfiguration(AppMonitorConfiguration).

      Parameters:
      appMonitorConfiguration - a consumer that will call methods on AppMonitorConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customEvents

      CreateAppMonitorRequest.Builder customEvents(CustomEvents customEvents)

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

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

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

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

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

    • customEvents

      default CreateAppMonitorRequest.Builder customEvents(Consumer<CustomEvents.Builder> customEvents)

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

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

      This is a convenience method that creates an instance of the CustomEvents.Builder avoiding the need to create one manually via CustomEvents.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customEvents(CustomEvents).

      Parameters:
      customEvents - a consumer that will call methods on CustomEvents.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cwLogEnabled

      CreateAppMonitorRequest.Builder cwLogEnabled(Boolean cwLogEnabled)

      Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

      If you omit this parameter, the default is false.

      Parameters:
      cwLogEnabled - Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

      If you omit this parameter, the default is false.

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

    • domain

      CreateAppMonitorRequest.Builder domain(String domain)

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

      Parameters:
      domain - The top-level internet domain name for which your application has administrative authority.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateAppMonitorRequest.Builder name(String name)

      A name for the app monitor.

      Parameters:
      name - A name for the app monitor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateAppMonitorRequest.Builder tags(Map<String,String> tags)

      Assigns one or more tags (key-value pairs) to the app monitor.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

      You can associate as many as 50 tags with an app monitor.

      For more information, see Tagging Amazon Web Services resources.

      Parameters:
      tags - Assigns one or more tags (key-value pairs) to the app monitor.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

      You can associate as many as 50 tags with an app monitor.

      For more information, see Tagging Amazon Web Services resources.

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

    • overrideConfiguration

      CreateAppMonitorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAppMonitorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.