software.amazon.awssdk.services.internetmonitor.model

Class UpdateMonitorRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.internetmonitor.model.InternetMonitorRequest

software.amazon.awssdk.services.internetmonitor.model.UpdateMonitorRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateMonitorRequest.Builder,UpdateMonitorRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateMonitorRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateMonitorRequest.Builder	builder()
String	clientToken() A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourcesToAdd() For responses, this returns true if the service returned a value for the ResourcesToAdd property.
boolean	hasResourcesToRemove() For responses, this returns true if the service returned a value for the ResourcesToRemove property.
HealthEventsConfig	healthEventsConfig() The list of health score thresholds.
InternetMeasurementsLogDelivery	internetMeasurementsLogDelivery() Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.
Integer	maxCityNetworksToMonitor() The maximum number of city-networks to monitor for your application.
String	monitorName() The name of the monitor.
List<String>	resourcesToAdd() The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
List<String>	resourcesToRemove() The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateMonitorRequest.Builder>	serializableBuilderClass()
MonitorConfigState	status() The status for a monitor.
String	statusAsString() The status for a monitor.
UpdateMonitorRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	trafficPercentageToMonitor() The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

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

monitorName

public final String monitorName()

The name of the monitor.

Returns:

The name of the monitor.

hasResourcesToAdd

public final boolean hasResourcesToAdd()

For responses, this returns true if the service returned a value for the ResourcesToAdd 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.

resourcesToAdd

public final List<String> resourcesToAdd()

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.

You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

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 hasResourcesToAdd() method.

Returns:

The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.

You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

hasResourcesToRemove

public final boolean hasResourcesToRemove()

For responses, this returns true if the service returned a value for the ResourcesToRemove 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.

resourcesToRemove

public final List<String> resourcesToRemove()

The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

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 hasResourcesToRemove() method.

Returns:

The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

status

public final MonitorConfigState status()

The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE. The following values are not accepted: PENDING, and ERROR.

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

Returns:

The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE. The following values are not accepted: PENDING, and ERROR.

See Also:

MonitorConfigState

statusAsString

public final String statusAsString()

The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE. The following values are not accepted: PENDING, and ERROR.

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

Returns:

The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and INACTIVE. The following values are not accepted: PENDING, and ERROR.

See Also:

MonitorConfigState

clientToken

public final String clientToken()

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.

Returns:

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.

maxCityNetworksToMonitor

public final Integer maxCityNetworksToMonitor()

The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.

Returns:

The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.

internetMeasurementsLogDelivery

public final InternetMeasurementsLogDelivery internetMeasurementsLogDelivery()

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

Returns:

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

trafficPercentageToMonitor

public final Integer trafficPercentageToMonitor()

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

Returns:

The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

healthEventsConfig

public final HealthEventsConfig healthEventsConfig()

The list of health score thresholds. A threshold percentage for health scores, along with other configuration information, determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

Returns:

The list of health score thresholds. A threshold percentage for health scores, along with other configuration information, determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

toBuilder

public UpdateMonitorRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateMonitorRequest.Builder,UpdateMonitorRequest>

Specified by:

toBuilder in class InternetMonitorRequest

builder

public static UpdateMonitorRequest.Builder builder()

serializableBuilderClass

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