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

Interface PutRumMetricsDestinationRequest.Builder

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

  • Method Details

    • appMonitorName

      PutRumMetricsDestinationRequest.Builder appMonitorName(String appMonitorName)

      The name of the CloudWatch RUM app monitor that will send the metrics.

      Parameters:
      appMonitorName - The name of the CloudWatch RUM app monitor that will send the metrics.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      PutRumMetricsDestinationRequest.Builder destination(String destination)

      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 CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

      Parameters:
      destination - 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 CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • destination

      PutRumMetricsDestinationRequest.Builder destination(MetricDestination destination)

      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 CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

      Parameters:
      destination - 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 CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • destinationArn

      PutRumMetricsDestinationRequest.Builder destinationArn(String destinationArn)

      Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

      Parameters:
      destinationArn - Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRoleArn

      PutRumMetricsDestinationRequest.Builder iamRoleArn(String iamRoleArn)

      This parameter is required if Destination is Evidently. If Destination is CloudWatch, don't 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.

      If you specify this parameter, you must be signed on to a role that has PassRole permissions attached to it, to allow the role to be passed. The CloudWatchAmazonCloudWatchRUMFullAccess policy doesn't include PassRole permissions.

      Parameters:
      iamRoleArn - This parameter is required if Destination is Evidently. If Destination is CloudWatch, don't 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.

      If you specify this parameter, you must be signed on to a role that has PassRole permissions attached to it, to allow the role to be passed. The CloudWatchAmazonCloudWatchRUMFullAccess policy doesn't include PassRole permissions.

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

    • overrideConfiguration

      PutRumMetricsDestinationRequest.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

      PutRumMetricsDestinationRequest.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.