Class PutRumMetricsDestinationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rum.model.RumRequest
software.amazon.awssdk.services.rum.model.PutRumMetricsDestinationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutRumMetricsDestinationRequest.Builder,PutRumMetricsDestinationRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutRumMetricsDestinationRequest extends RumRequest implements ToCopyableBuilder<PutRumMetricsDestinationRequest.Builder,PutRumMetricsDestinationRequest>

  • Method Details

    • appMonitorName

      public final String appMonitorName()

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

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

    • destination

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, destination will return MetricDestination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationAsString().

      Returns:
      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.
      See Also:

    • destinationAsString

      public final String destinationAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, destination will return MetricDestination.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from destinationAsString().

      Returns:
      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.
      See Also:

    • destinationArn

      public final 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.

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

    • iamRoleArn

      public final 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.

      Returns:
      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.

    • toBuilder

      public PutRumMetricsDestinationRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutRumMetricsDestinationRequest.Builder,PutRumMetricsDestinationRequest>
      Specified by:
      toBuilder in class RumRequest
      Returns:
      a builder for type T

    • builder

      public static PutRumMetricsDestinationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutRumMetricsDestinationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.