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

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutRumMetricsDestinationRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	appMonitorName()	The name of the CloudWatch RUM app monitor that will send the metrics.
static PutRumMetricsDestinationRequest.Builder	builder()
MetricDestination	destination()	Defines the destination to send the metrics to.
String	destinationArn()	Use this parameter only if Destination is Evidently.
String	destinationAsString()	Defines the destination to send the metrics to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iamRoleArn()	This parameter is required if Destination is Evidently.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutRumMetricsDestinationRequest.Builder>	serializableBuilderClass()
PutRumMetricsDestinationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

MetricDestination

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:

MetricDestination

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()

Specified by:

toBuilder in interface ToCopyableBuilder<PutRumMetricsDestinationRequest.Builder,PutRumMetricsDestinationRequest>

Specified by:

toBuilder in class RumRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo