Class: Aws::InternetMonitor::Types::CreateMonitorInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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. Don't 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) 


292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 292

class CreateMonitorInput < Struct.new(
  :monitor_name,
  :resources,
  :client_token,
  :tags,
  :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

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:



292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 292

class CreateMonitorInput < Struct.new(
  :monitor_name,
  :resources,
  :client_token,
  :tags,
  :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 an Amazon S3 bucket in addition to CloudWatch Logs.

Returns:



292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 292

class CreateMonitorInput < Struct.new(
  :monitor_name,
  :resources,
  :client_token,
  :tags,
  :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 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:

  • (Integer) 


292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 292

class CreateMonitorInput < Struct.new(
  :monitor_name,
  :resources,
  :client_token,
  :tags,
  :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) 


292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 292

class CreateMonitorInput < Struct.new(
  :monitor_name,
  :resources,
  :client_token,
  :tags,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Array<String>) 


292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 292

class CreateMonitorInput < Struct.new(
  :monitor_name,
  :resources,
  :client_token,
  :tags,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 292

class CreateMonitorInput < Struct.new(
  :monitor_name,
  :resources,
  :client_token,
  :tags,
  :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) 


292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 292

class CreateMonitorInput < Struct.new(
  :monitor_name,
  :resources,
  :client_token,
  :tags,
  :max_city_networks_to_monitor,
  :internet_measurements_log_delivery,
  :traffic_percentage_to_monitor,
  :health_events_config)
  SENSITIVE = []
  include Aws::Structure
end