com.amazonaws.services.cloudwatchrum.model

Class PutRumMetricsDestinationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatchrum.model.PutRumMetricsDestinationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutRumMetricsDestinationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutRumMetricsDestinationRequest()

Method Summary

Modifier and Type	Method and Description
PutRumMetricsDestinationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAppMonitorName() The name of the CloudWatch RUM app monitor that will send the metrics.
String	getDestination() Defines the destination to send the metrics to.
String	getDestinationArn() Use this parameter only if Destination is Evidently.
String	getIamRoleArn() This parameter is required if Destination is Evidently.
int	hashCode()
void	setAppMonitorName(String appMonitorName) The name of the CloudWatch RUM app monitor that will send the metrics.
void	setDestination(String destination) Defines the destination to send the metrics to.
void	setDestinationArn(String destinationArn) Use this parameter only if Destination is Evidently.
void	setIamRoleArn(String iamRoleArn) This parameter is required if Destination is Evidently.
String	toString() Returns a string representation of this object.
PutRumMetricsDestinationRequest	withAppMonitorName(String appMonitorName) The name of the CloudWatch RUM app monitor that will send the metrics.
PutRumMetricsDestinationRequest	withDestination(MetricDestination destination) Defines the destination to send the metrics to.
PutRumMetricsDestinationRequest	withDestination(String destination) Defines the destination to send the metrics to.
PutRumMetricsDestinationRequest	withDestinationArn(String destinationArn) Use this parameter only if Destination is Evidently.
PutRumMetricsDestinationRequest	withIamRoleArn(String iamRoleArn) This parameter is required if Destination is Evidently.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutRumMetricsDestinationRequest

public PutRumMetricsDestinationRequest()

Method Detail

setAppMonitorName

public void setAppMonitorName(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.

getAppMonitorName

public String getAppMonitorName()

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.

withAppMonitorName

public PutRumMetricsDestinationRequest withAppMonitorName(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.

setDestination

public void setDestination(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.

See Also:

MetricDestination

getDestination

public String getDestination()

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:

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

withDestination

public PutRumMetricsDestinationRequest withDestination(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:

MetricDestination

withDestination

public PutRumMetricsDestinationRequest withDestination(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:

MetricDestination

setDestinationArn

public void setDestinationArn(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.

getDestinationArn

public String getDestinationArn()

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.

withDestinationArn

public PutRumMetricsDestinationRequest withDestinationArn(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.

setIamRoleArn

public void setIamRoleArn(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.

getIamRoleArn

public String getIamRoleArn()

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.

withIamRoleArn

public PutRumMetricsDestinationRequest withIamRoleArn(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutRumMetricsDestinationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()