software.amazon.awssdk.services.internetmonitor.model

Interface UpdateMonitorRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateMonitorRequest.Builder,UpdateMonitorRequest>, InternetMonitorRequest.Builder, SdkBuilder<UpdateMonitorRequest.Builder,UpdateMonitorRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateMonitorRequest

public static interface UpdateMonitorRequest.Builder
extends InternetMonitorRequest.Builder, SdkPojo, CopyableBuilder<UpdateMonitorRequest.Builder,UpdateMonitorRequest>

Method Summary

Modifier and Type	Method and Description
UpdateMonitorRequest.Builder	clientToken(String clientToken) A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.
default UpdateMonitorRequest.Builder	healthEventsConfig(Consumer<HealthEventsConfig.Builder> healthEventsConfig) The list of health score thresholds.
UpdateMonitorRequest.Builder	healthEventsConfig(HealthEventsConfig healthEventsConfig) The list of health score thresholds.
default UpdateMonitorRequest.Builder	internetMeasurementsLogDelivery(Consumer<InternetMeasurementsLogDelivery.Builder> internetMeasurementsLogDelivery) Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.
UpdateMonitorRequest.Builder	internetMeasurementsLogDelivery(InternetMeasurementsLogDelivery internetMeasurementsLogDelivery) Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.
UpdateMonitorRequest.Builder	maxCityNetworksToMonitor(Integer maxCityNetworksToMonitor) The maximum number of city-networks to monitor for your application.
UpdateMonitorRequest.Builder	monitorName(String monitorName) The name of the monitor.
UpdateMonitorRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateMonitorRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateMonitorRequest.Builder	resourcesToAdd(Collection<String> resourcesToAdd) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
UpdateMonitorRequest.Builder	resourcesToAdd(String... resourcesToAdd) The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
UpdateMonitorRequest.Builder	resourcesToRemove(Collection<String> resourcesToRemove) The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
UpdateMonitorRequest.Builder	resourcesToRemove(String... resourcesToRemove) The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
UpdateMonitorRequest.Builder	status(MonitorConfigState status) The status for a monitor.
UpdateMonitorRequest.Builder	status(String status) The status for a monitor.
UpdateMonitorRequest.Builder	trafficPercentageToMonitor(Integer trafficPercentageToMonitor) The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

Methods inherited from interface software.amazon.awssdk.services.internetmonitor.model.InternetMonitorRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

monitorName

UpdateMonitorRequest.Builder monitorName(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.

resourcesToAdd

UpdateMonitorRequest.Builder resourcesToAdd(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.

resourcesToAdd

UpdateMonitorRequest.Builder resourcesToAdd(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.

resourcesToRemove

UpdateMonitorRequest.Builder resourcesToRemove(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.

resourcesToRemove

UpdateMonitorRequest.Builder resourcesToRemove(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.

status

UpdateMonitorRequest.Builder status(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, MonitorConfigState

status

UpdateMonitorRequest.Builder status(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, MonitorConfigState

clientToken

UpdateMonitorRequest.Builder clientToken(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.

maxCityNetworksToMonitor

UpdateMonitorRequest.Builder maxCityNetworksToMonitor(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.

internetMeasurementsLogDelivery

UpdateMonitorRequest.Builder internetMeasurementsLogDelivery(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.

internetMeasurementsLogDelivery

default UpdateMonitorRequest.Builder internetMeasurementsLogDelivery(Consumer<InternetMeasurementsLogDelivery.Builder> 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.

This is a convenience method that creates an instance of the InternetMeasurementsLogDelivery.Builder avoiding the need to create one manually via InternetMeasurementsLogDelivery.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to internetMeasurementsLogDelivery(InternetMeasurementsLogDelivery).

Parameters:

internetMeasurementsLogDelivery - a consumer that will call methods on InternetMeasurementsLogDelivery.Builder

Returns:

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

See Also:

internetMeasurementsLogDelivery(InternetMeasurementsLogDelivery)

trafficPercentageToMonitor

UpdateMonitorRequest.Builder trafficPercentageToMonitor(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.

healthEventsConfig

UpdateMonitorRequest.Builder healthEventsConfig(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.

healthEventsConfig

default UpdateMonitorRequest.Builder healthEventsConfig(Consumer<HealthEventsConfig.Builder> 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.

This is a convenience method that creates an instance of the HealthEventsConfig.Builder avoiding the need to create one manually via HealthEventsConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthEventsConfig(HealthEventsConfig).

Parameters:

healthEventsConfig - a consumer that will call methods on HealthEventsConfig.Builder

Returns:

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

See Also:

healthEventsConfig(HealthEventsConfig)

overrideConfiguration

UpdateMonitorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateMonitorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder