Class: Aws::InternetMonitor::Types::UpdateMonitorInput

Inherits:

Struct

• Object
• Struct
• Aws::InternetMonitor::Types::UpdateMonitorInput

Defined in:

gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.

• #health_events_config ⇒ Types::HealthEventsConfig

  The list of health score thresholds.

• #internet_measurements_log_delivery ⇒ Types::InternetMeasurementsLogDelivery

  Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket.

• #max_city_networks_to_monitor ⇒ Integer

  The maximum number of city-networks to monitor for your application.

• #monitor_name ⇒ String

  The name of the monitor.

• #resources_to_add ⇒ Array<String>

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

• #resources_to_remove ⇒ Array<String>

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

• #status ⇒ String

  The status for a monitor.

• #traffic_percentage_to_monitor ⇒ Integer

  The percentage of the internet-facing traffic for your application that you want to monitor with this monitor.

Instance Attribute Details

#client_token ⇒ 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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#health_events_config ⇒ Types::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:

• (Types::HealthEventsConfig)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#internet_measurements_log_delivery ⇒ Types::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:

• (Types::InternetMeasurementsLogDelivery)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#max_city_networks_to_monitor ⇒ Integer

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:

• (Integer)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_name ⇒ String

The name of the monitor.

Returns:

• (String)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#resources_to_add ⇒ Array<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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#resources_to_remove ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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:

• (String)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_percentage_to_monitor ⇒ Integer

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:

• (Integer)

# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 2019

class UpdateMonitorInput < Struct.new(
  :monitor_name,
  :resources_to_add,
  :resources_to_remove,
  :status,
  :client_token,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end