Struct aws_sdk_internetmonitor::operation::update_monitor::UpdateMonitorInput

#[non_exhaustive]
pub struct UpdateMonitorInput {
    pub monitor_name: Option<String>,
    pub resources_to_add: Option<Vec<String>>,
    pub resources_to_remove: Option<Vec<String>>,
    pub status: Option<MonitorConfigState>,
    pub client_token: Option<String>,
    pub max_city_networks_to_monitor: Option<i32>,
    pub internet_measurements_log_delivery: Option<InternetMeasurementsLogDelivery>,
    pub traffic_percentage_to_monitor: Option<i32>,
    pub health_events_config: Option<HealthEventsConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

monitor_name: Option<String>

The name of the monitor.

resources_to_add: Option<Vec<String>>

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.

resources_to_remove: Option<Vec<String>>

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

status: Option<MonitorConfigState>

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.

client_token: Option<String>

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.

max_city_networks_to_monitor: Option<i32>

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.

internet_measurements_log_delivery: Option<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.

traffic_percentage_to_monitor: Option<i32>

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.

health_events_config: Option<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.

Implementations

impl UpdateMonitorInput

pub fn monitor_name(&self) -> Option<&str>

The name of the monitor.

pub fn resources_to_add(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resources_to_add.is_none().

pub fn resources_to_remove(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resources_to_remove.is_none().

pub fn status(&self) -> Option<&MonitorConfigState>

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.

pub fn client_token(&self) -> Option<&str>

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.

pub fn max_city_networks_to_monitor(&self) -> Option<i32>

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.

pub fn internet_measurements_log_delivery( &self, ) -> Option<&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.

pub fn traffic_percentage_to_monitor(&self) -> Option<i32>

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.

pub fn health_events_config(&self) -> Option<&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.

impl UpdateMonitorInput

pub fn builder() -> UpdateMonitorInputBuilder

Creates a new builder-style object to manufacture UpdateMonitorInput.

Trait Implementations

impl Clone for UpdateMonitorInput

fn clone(&self) -> UpdateMonitorInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateMonitorInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateMonitorInput

fn eq(&self, other: &UpdateMonitorInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateMonitorInput