com.amazonaws.services.internetmonitor.model

Class UpdateMonitorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.internetmonitor.model.UpdateMonitorRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateMonitorRequest
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
UpdateMonitorRequest()

Method Summary

Modifier and Type	Method and Description
UpdateMonitorRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.
HealthEventsConfig	getHealthEventsConfig() The list of health score thresholds.
InternetMeasurementsLogDelivery	getInternetMeasurementsLogDelivery() Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.
Integer	getMaxCityNetworksToMonitor() The maximum number of city-networks to monitor for your application.
String	getMonitorName() The name of the monitor.
List<String>	getResourcesToAdd() The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
List<String>	getResourcesToRemove() The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
String	getStatus() The status for a monitor.
Integer	getTrafficPercentageToMonitor() The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.
int	hashCode()
void	setClientToken(String clientToken) A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.
void	setHealthEventsConfig(HealthEventsConfig healthEventsConfig) The list of health score thresholds.
void	setInternetMeasurementsLogDelivery(InternetMeasurementsLogDelivery internetMeasurementsLogDelivery) Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.
void	setMaxCityNetworksToMonitor(Integer maxCityNetworksToMonitor) The maximum number of city-networks to monitor for your application.
void	setMonitorName(String monitorName) The name of the monitor.
void	setResourcesToAdd(Collection<String> resourcesToAdd) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
void	setResourcesToRemove(Collection<String> resourcesToRemove) The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
void	setStatus(String status) The status for a monitor.
void	setTrafficPercentageToMonitor(Integer trafficPercentageToMonitor) The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.
String	toString() Returns a string representation of this object.
UpdateMonitorRequest	withClientToken(String clientToken) A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.
UpdateMonitorRequest	withHealthEventsConfig(HealthEventsConfig healthEventsConfig) The list of health score thresholds.
UpdateMonitorRequest	withInternetMeasurementsLogDelivery(InternetMeasurementsLogDelivery internetMeasurementsLogDelivery) Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.
UpdateMonitorRequest	withMaxCityNetworksToMonitor(Integer maxCityNetworksToMonitor) The maximum number of city-networks to monitor for your application.
UpdateMonitorRequest	withMonitorName(String monitorName) The name of the monitor.
UpdateMonitorRequest	withResourcesToAdd(Collection<String> resourcesToAdd) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
UpdateMonitorRequest	withResourcesToAdd(String... resourcesToAdd) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
UpdateMonitorRequest	withResourcesToRemove(Collection<String> resourcesToRemove) The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
UpdateMonitorRequest	withResourcesToRemove(String... resourcesToRemove) The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
UpdateMonitorRequest	withStatus(MonitorConfigState status) The status for a monitor.
UpdateMonitorRequest	withStatus(String status) The status for a monitor.
UpdateMonitorRequest	withTrafficPercentageToMonitor(Integer trafficPercentageToMonitor) The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

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

UpdateMonitorRequest

public UpdateMonitorRequest()

Method Detail

setMonitorName

public void setMonitorName(String monitorName)

The name of the monitor.

Parameters:

monitorName - The name of the monitor.

getMonitorName

public String getMonitorName()

The name of the monitor.

Returns:

The name of the monitor.

withMonitorName

public UpdateMonitorRequest withMonitorName(String monitorName)

The name of the monitor.

Parameters:

monitorName - The name of the monitor.

Returns:

Returns a reference to this object so that method calls can be chained together.

getResourcesToAdd

public List<String> getResourcesToAdd()

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.

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.

setResourcesToAdd

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

Parameters:

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.

withResourcesToAdd

public UpdateMonitorRequest withResourcesToAdd(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.

NOTE: This method appends the values to the existing list (if any). Use setResourcesToAdd(java.util.Collection) or withResourcesToAdd(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withResourcesToAdd

public UpdateMonitorRequest withResourcesToAdd(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getResourcesToRemove

public List<String> getResourcesToRemove()

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

Returns:

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

setResourcesToRemove

public void setResourcesToRemove(Collection<String> resourcesToRemove)

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

Parameters:

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

withResourcesToRemove

public UpdateMonitorRequest withResourcesToRemove(String... resourcesToRemove)

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

NOTE: This method appends the values to the existing list (if any). Use setResourcesToRemove(java.util.Collection) or withResourcesToRemove(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withResourcesToRemove

public UpdateMonitorRequest withResourcesToRemove(Collection<String> resourcesToRemove)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

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

Parameters:

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.

See Also:

MonitorConfigState

getStatus

public String getStatus()

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.

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

withStatus

public UpdateMonitorRequest withStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MonitorConfigState

withStatus

public UpdateMonitorRequest withStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MonitorConfigState

setClientToken

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

Parameters:

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.

getClientToken

public String getClientToken()

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.

withClientToken

public UpdateMonitorRequest withClientToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMaxCityNetworksToMonitor

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

Parameters:

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.

getMaxCityNetworksToMonitor

public Integer getMaxCityNetworksToMonitor()

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.

withMaxCityNetworksToMonitor

public UpdateMonitorRequest withMaxCityNetworksToMonitor(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setInternetMeasurementsLogDelivery

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

Parameters:

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.

getInternetMeasurementsLogDelivery

public InternetMeasurementsLogDelivery getInternetMeasurementsLogDelivery()

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.

withInternetMeasurementsLogDelivery

public UpdateMonitorRequest withInternetMeasurementsLogDelivery(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTrafficPercentageToMonitor

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

Parameters:

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.

getTrafficPercentageToMonitor

public Integer getTrafficPercentageToMonitor()

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.

withTrafficPercentageToMonitor

public UpdateMonitorRequest withTrafficPercentageToMonitor(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setHealthEventsConfig

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

Parameters:

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.

getHealthEventsConfig

public HealthEventsConfig getHealthEventsConfig()

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.

withHealthEventsConfig

public UpdateMonitorRequest withHealthEventsConfig(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.

Parameters:

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:

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