software.amazon.awssdk.services.rum.model

Class CreateAppMonitorRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAppMonitorRequest.Builder,CreateAppMonitorRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAppMonitorRequest
extends RumRequest
implements ToCopyableBuilder<CreateAppMonitorRequest.Builder,CreateAppMonitorRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAppMonitorRequest.Builder

Method Summary

Modifier and Type	Method and Description
AppMonitorConfiguration	appMonitorConfiguration() A structure that contains much of the configuration data for the app monitor.
static CreateAppMonitorRequest.Builder	builder()
CustomEvents	customEvents() Specifies whether this app monitor allows the web client to define and send custom events.
Boolean	cwLogEnabled() Data collected by RUM is kept by RUM for 30 days and then deleted.
String	domain() The top-level internet domain name for which your application has administrative authority.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() A name for the app monitor.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAppMonitorRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Assigns one or more tags (key-value pairs) to the app monitor.
CreateAppMonitorRequest.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

appMonitorConfiguration

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

Returns:

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.

customEvents

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

Returns:

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.

cwLogEnabled

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

Returns:

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.

domain

public final String domain()

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

Returns:

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

name

public final String name()

A name for the app monitor.

Returns:

A name for the app monitor.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

toBuilder

public CreateAppMonitorRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAppMonitorRequest.Builder,CreateAppMonitorRequest>

Specified by:

toBuilder in class RumRequest

builder

public static CreateAppMonitorRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAppMonitorRequest.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