com.amazonaws.services.internetmonitor.model

Class CreateMonitorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.internetmonitor.model.CreateMonitorRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateMonitorRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateMonitorRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateMonitorRequest	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() Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event.
InternetMeasurementsLogDelivery	getInternetMeasurementsLogDelivery() Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.
Integer	getMaxCityNetworksToMonitor() The maximum number of city-networks to monitor for your resources.
String	getMonitorName() The name of the monitor.
List<String>	getResources() The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
Map<String,String>	getTags() The tags 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) Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event.
void	setInternetMeasurementsLogDelivery(InternetMeasurementsLogDelivery internetMeasurementsLogDelivery) Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.
void	setMaxCityNetworksToMonitor(Integer maxCityNetworksToMonitor) The maximum number of city-networks to monitor for your resources.
void	setMonitorName(String monitorName) The name of the monitor.
void	setResources(Collection<String> resources) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
void	setTags(Map<String,String> tags) The tags 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.
CreateMonitorRequest	withClientToken(String clientToken) A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.
CreateMonitorRequest	withHealthEventsConfig(HealthEventsConfig healthEventsConfig) Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event.
CreateMonitorRequest	withInternetMeasurementsLogDelivery(InternetMeasurementsLogDelivery internetMeasurementsLogDelivery) Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.
CreateMonitorRequest	withMaxCityNetworksToMonitor(Integer maxCityNetworksToMonitor) The maximum number of city-networks to monitor for your resources.
CreateMonitorRequest	withMonitorName(String monitorName) The name of the monitor.
CreateMonitorRequest	withResources(Collection<String> resources) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
CreateMonitorRequest	withResources(String... resources) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
CreateMonitorRequest	withTags(Map<String,String> tags) The tags for a monitor.
CreateMonitorRequest	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

CreateMonitorRequest

public CreateMonitorRequest()

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

getResources

public List<String> getResources()

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 VPC 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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

setResources

public void setResources(Collection<String> resources)

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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

Parameters:

resources - 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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

withResources

public CreateMonitorRequest withResources(String... resources)

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 VPC 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 setResources(java.util.Collection) or withResources(java.util.Collection) if you want to override the existing values.

Parameters:

resources - 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 VPC 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.

withResources

public CreateMonitorRequest withResources(Collection<String> resources)

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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

Parameters:

resources - 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 VPC 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.

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. Don't 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. Don't 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. Don't 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. Don't reuse the same client token for other API requests.

withClientToken

public CreateMonitorRequest withClientToken(String clientToken)

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't 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. Don't reuse the same client token for other API requests.

Returns:

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

getTags

public Map<String,String> getTags()

The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.

Returns:

The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.

setTags

public void setTags(Map<String,String> tags)

The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.

Parameters:

tags - The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.

withTags

public CreateMonitorRequest withTags(Map<String,String> tags)

The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.

Parameters:

tags - The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.

Returns:

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

addTagsEntry

public CreateMonitorRequest addTagsEntry(String key,
                                         String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateMonitorRequest clearTagsEntries()

Removes all the entries added into Tags.

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

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

Parameters:

maxCityNetworksToMonitor - The maximum number of city-networks to monitor for your resources. 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.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

getMaxCityNetworksToMonitor

public Integer getMaxCityNetworksToMonitor()

The maximum number of city-networks to monitor for your resources. 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.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

Returns:

The maximum number of city-networks to monitor for your resources. 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.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

withMaxCityNetworksToMonitor

public CreateMonitorRequest withMaxCityNetworksToMonitor(Integer maxCityNetworksToMonitor)

The maximum number of city-networks to monitor for your resources. 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.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

Parameters:

maxCityNetworksToMonitor - The maximum number of city-networks to monitor for your resources. 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.

To learn more, see Choosing a city-network maximum value 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.

setInternetMeasurementsLogDelivery

public void setInternetMeasurementsLogDelivery(InternetMeasurementsLogDelivery internetMeasurementsLogDelivery)

Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.

Parameters:

internetMeasurementsLogDelivery - Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.

getInternetMeasurementsLogDelivery

public InternetMeasurementsLogDelivery getInternetMeasurementsLogDelivery()

Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.

Returns:

Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.

withInternetMeasurementsLogDelivery

public CreateMonitorRequest withInternetMeasurementsLogDelivery(InternetMeasurementsLogDelivery internetMeasurementsLogDelivery)

Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.

Parameters:

internetMeasurementsLogDelivery - Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to 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 CreateMonitorRequest 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)

Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

If you don't set a health event threshold, the default value is 95%.

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

Parameters:

healthEventsConfig - Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

If you don't set a health event threshold, the default value is 95%.

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

getHealthEventsConfig

public HealthEventsConfig getHealthEventsConfig()

Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

If you don't set a health event threshold, the default value is 95%.

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

Returns:

Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

If you don't set a health event threshold, the default value is 95%.

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

withHealthEventsConfig

public CreateMonitorRequest withHealthEventsConfig(HealthEventsConfig healthEventsConfig)

Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

If you don't set a health event threshold, the default value is 95%.

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

Parameters:

healthEventsConfig - Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

If you don't set a health event threshold, the default value is 95%.

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