aws-sdk-internetmonitor 1.6.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c3e7bae5364e9e99eb554c7211d7adbcfcfc6492c11b7074f137734111f93275
4
- data.tar.gz: cef56ffc729c0777edf1f6e1db2f04d00d8dce9a8b79a04e6b09913ad166e1c9
3
+ metadata.gz: e8844a9f6145cfe082619fe22135fdb02a15714a4e1b9910c90197cc29c4e3d1
4
+ data.tar.gz: f99b5d76c49cd1d603bd5c4f7b3eafb33de832d2017d64d697b2161878052500
5
5
  SHA512:
6
- metadata.gz: 8f4cf47a8678878864c5e0f1c06d3d36844991e98e3892cd9e25091da431c8b4120a97cb7c75742b8a69de9f46d9a616c6b2c426c7bb713e6c60f61e82c03e25
7
- data.tar.gz: 77092392af7cd8cc633a598c4a823200a88817768329fe5f3ac3f8c722055dba2f3100d7ce70fc93bdd47aa14404f2e339d7cd9e6c714a0483c2094b7e897145
6
+ metadata.gz: bdd74612ef437146fa14768ffab3ef2a023f0fc5afa8ecd253dbc0f326f060fa2b6d178e47a551fd545dab0fcc29f83235815862415bba4f2f92efb993c15eaf
7
+ data.tar.gz: 920075267d6495a3dc71787889e01c3bc212ec02f2cf2f8495f94d1f8d37be272c5fe68008d814e87f0c4185e9351628de4716269420385531750d3c99f2f59a
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.8.0 (2023-08-01)
5
+ ------------------
6
+
7
+ * Feature - This release adds a new feature for Amazon CloudWatch Internet Monitor that enables customers to set custom thresholds, for performance and availability drops, for impact limited to a single city-network to trigger creation of a health event.
8
+
9
+ 1.7.0 (2023-07-11)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.6.0 (2023-07-06)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.6.0
1
+ 1.8.0
@@ -216,6 +216,10 @@ module Aws::InternetMonitor
216
216
  # @option options [Boolean] :endpoint_discovery (false)
217
217
  # When set to `true`, endpoint discovery will be enabled for operations when available.
218
218
  #
219
+ # @option options [Boolean] :ignore_configured_endpoint_urls
220
+ # Setting to true disables use of endpoint URLs provided via environment
221
+ # variables and the shared configuration file.
222
+ #
219
223
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
220
224
  # The log formatter.
221
225
  #
@@ -386,21 +390,23 @@ module Aws::InternetMonitor
386
390
 
387
391
  # Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is
388
392
  # built based on information from the application resources that you
389
- # add: Amazon Virtual Private Clouds (VPCs), Amazon CloudFront
390
- # distributions, and WorkSpaces directories. Internet Monitor then
391
- # publishes internet measurements from Amazon Web Services that are
392
- # specific to the *city-networks*, that is, the locations and ASNs
393
+ # add: VPCs, Network Load Balancers (NLBs), Amazon CloudFront
394
+ # distributions, and Amazon WorkSpaces directories. Internet Monitor
395
+ # then publishes internet measurements from Amazon Web Services that are
396
+ # specific to the *city-networks*. That is, the locations and ASNs
393
397
  # (typically internet service providers or ISPs), where clients access
394
398
  # your application. For more information, see [Using Amazon CloudWatch
395
399
  # Internet Monitor][1] in the *Amazon CloudWatch User Guide*.
396
400
  #
397
- # When you create a monitor, you set a maximum limit for the number of
398
- # city-networks where client traffic is monitored. The city-network
399
- # maximum that you choose is the limit, but you only pay for the number
400
- # of city-networks that are actually monitored. You can change the
401
- # maximum at any time by updating your monitor. For more information,
402
- # see [Choosing a city-network maximum value][2] in the *Amazon
403
- # CloudWatch User Guide*.
401
+ # When you create a monitor, you choose the percentage of traffic that
402
+ # you want to monitor. You can also set a maximum limit for the number
403
+ # of city-networks where client traffic is monitored, that caps the
404
+ # total traffic that Internet Monitor monitors. A city-network maximum
405
+ # is the limit of city-networks, but you only pay for the number of
406
+ # city-networks that are actually monitored. You can update your monitor
407
+ # at any time to change the percentage of traffic to monitor or the
408
+ # city-networks maximum. For more information, see [Choosing a
409
+ # city-network maximum value][2] in the *Amazon CloudWatch User Guide*.
404
410
  #
405
411
  #
406
412
  #
@@ -412,14 +418,15 @@ module Aws::InternetMonitor
412
418
  #
413
419
  # @option params [Array<String>] :resources
414
420
  # The resources to include in a monitor, which you provide as a set of
415
- # Amazon Resource Names (ARNs).
421
+ # Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon
422
+ # CloudFront distributions, or Amazon WorkSpaces directories.
416
423
  #
417
- # You can add a combination of Amazon Virtual Private Clouds (VPCs) and
418
- # Amazon CloudFront distributions, or you can add Amazon WorkSpaces
419
- # directories. You can't add all three types of resources.
424
+ # You can add a combination of VPCs and CloudFront distributions, or you
425
+ # can add WorkSpaces directories, or you can add NLBs. You can't add
426
+ # NLBs or WorkSpaces directories together with any other resources.
420
427
  #
421
- # <note markdown="1"> If you add only VPC resources, at least one VPC must have an Internet
422
- # Gateway attached to it, to make sure that it has internet
428
+ # <note markdown="1"> If you add only Amazon VPC resources, at least one VPC must have an
429
+ # Internet Gateway attached to it, to make sure that it has internet
423
430
  # connectivity.
424
431
  #
425
432
  # </note>
@@ -439,9 +446,9 @@ module Aws::InternetMonitor
439
446
  # @option params [Integer] :max_city_networks_to_monitor
440
447
  # The maximum number of city-networks to monitor for your resources. A
441
448
  # city-network is the location (city) where clients access your
442
- # application resources from and the network or ASN, such as an internet
443
- # service provider (ISP), that clients access the resources through.
444
- # This limit helps control billing costs.
449
+ # application resources from and the ASN or network provider, such as an
450
+ # internet service provider (ISP), that clients access the resources
451
+ # through. Setting this limit can help control billing costs.
445
452
  #
446
453
  # To learn more, see [Choosing a city-network maximum value ][1] in the
447
454
  # Amazon CloudWatch Internet Monitor section of the *CloudWatch User
@@ -457,14 +464,33 @@ module Aws::InternetMonitor
457
464
  #
458
465
  # @option params [Integer] :traffic_percentage_to_monitor
459
466
  # The percentage of the internet-facing traffic for your application
460
- # that you want to monitor with this monitor.
467
+ # that you want to monitor with this monitor. If you set a city-networks
468
+ # maximum, that limit overrides the traffic percentage that you set.
469
+ #
470
+ # To learn more, see [Choosing an application traffic percentage to
471
+ # monitor ][1] in the Amazon CloudWatch Internet Monitor section of the
472
+ # *CloudWatch User Guide*.
473
+ #
474
+ #
475
+ #
476
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html
461
477
  #
462
478
  # @option params [Types::HealthEventsConfig] :health_events_config
463
- # Defines the health event threshold percentages, for performance score
464
- # and availability score. Internet Monitor creates a health event when
465
- # there's an internet issue that affects your application end users
466
- # where a health score percentage is at or below a set threshold. If you
467
- # don't set a health event threshold, the default calue is 95%.
479
+ # Defines the threshold percentages and other configuration information
480
+ # for when Amazon CloudWatch Internet Monitor creates a health event.
481
+ # Internet Monitor creates a health event when an internet issue that
482
+ # affects your application end users has a health score percentage that
483
+ # is at or below a specific threshold, and, sometimes, when other
484
+ # criteria are met.
485
+ #
486
+ # If you don't set a health event threshold, the default value is 95%.
487
+ #
488
+ # For more information, see [ Change health event thresholds][1] in the
489
+ # Internet Monitor section of the *CloudWatch User Guide*.
490
+ #
491
+ #
492
+ #
493
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview
468
494
  #
469
495
  # @return [Types::CreateMonitorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
470
496
  #
@@ -492,6 +518,16 @@ module Aws::InternetMonitor
492
518
  # health_events_config: {
493
519
  # availability_score_threshold: 1.0,
494
520
  # performance_score_threshold: 1.0,
521
+ # availability_local_health_events_config: {
522
+ # status: "ENABLED", # accepts ENABLED, DISABLED
523
+ # health_score_threshold: 1.0,
524
+ # min_traffic_impact: 1.0,
525
+ # },
526
+ # performance_local_health_events_config: {
527
+ # status: "ENABLED", # accepts ENABLED, DISABLED
528
+ # health_score_threshold: 1.0,
529
+ # min_traffic_impact: 1.0,
530
+ # },
495
531
  # },
496
532
  # })
497
533
  #
@@ -533,12 +569,12 @@ module Aws::InternetMonitor
533
569
 
534
570
  # Gets information the Amazon CloudWatch Internet Monitor has created
535
571
  # and stored about a health event for a specified monitor. This
536
- # information includes the impacted locations, and all of the
537
- # information related to the event by location.
572
+ # information includes the impacted locations, and all the information
573
+ # related to the event, by location.
538
574
  #
539
- # The information returned includes the performance, availability, and
540
- # round-trip time impact, information about the network providers, the
541
- # event type, and so on.
575
+ # The information returned includes the impact on performance,
576
+ # availability, and round-trip time, information about the network
577
+ # providers (ASNs), the event type, and so on.
542
578
  #
543
579
  # Information rolled up at the global traffic level is also returned,
544
580
  # including the impact type and total traffic impact.
@@ -611,7 +647,7 @@ module Aws::InternetMonitor
611
647
  # resp.impacted_locations[0].internet_health.performance.round_trip_time.p95 #=> Float
612
648
  # resp.status #=> String, one of "ACTIVE", "RESOLVED"
613
649
  # resp.percent_of_total_traffic_impacted #=> Float
614
- # resp.impact_type #=> String, one of "AVAILABILITY", "PERFORMANCE"
650
+ # resp.impact_type #=> String, one of "AVAILABILITY", "PERFORMANCE", "LOCAL_AVAILABILITY", "LOCAL_PERFORMANCE"
615
651
  # resp.health_score_threshold #=> Float
616
652
  #
617
653
  # @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetHealthEvent AWS API Documentation
@@ -673,6 +709,12 @@ module Aws::InternetMonitor
673
709
  # resp.traffic_percentage_to_monitor #=> Integer
674
710
  # resp.health_events_config.availability_score_threshold #=> Float
675
711
  # resp.health_events_config.performance_score_threshold #=> Float
712
+ # resp.health_events_config.availability_local_health_events_config.status #=> String, one of "ENABLED", "DISABLED"
713
+ # resp.health_events_config.availability_local_health_events_config.health_score_threshold #=> Float
714
+ # resp.health_events_config.availability_local_health_events_config.min_traffic_impact #=> Float
715
+ # resp.health_events_config.performance_local_health_events_config.status #=> String, one of "ENABLED", "DISABLED"
716
+ # resp.health_events_config.performance_local_health_events_config.health_score_threshold #=> Float
717
+ # resp.health_events_config.performance_local_health_events_config.min_traffic_impact #=> Float
676
718
  #
677
719
  # @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetMonitor AWS API Documentation
678
720
  #
@@ -684,9 +726,8 @@ module Aws::InternetMonitor
684
726
  end
685
727
 
686
728
  # Lists all health events for a monitor in Amazon CloudWatch Internet
687
- # Monitor. Returns all information for health events including the
688
- # client location information the network cause and status, event start
689
- # and end time, percentage of total traffic impacted, and status.
729
+ # Monitor. Returns information for health events including the event
730
+ # start and end time and the status.
690
731
  #
691
732
  # <note markdown="1"> Health events that have start times during the time frame that is
692
733
  # requested are not included in the list of health events.
@@ -772,7 +813,7 @@ module Aws::InternetMonitor
772
813
  # resp.health_events[0].impacted_locations[0].internet_health.performance.round_trip_time.p95 #=> Float
773
814
  # resp.health_events[0].status #=> String, one of "ACTIVE", "RESOLVED"
774
815
  # resp.health_events[0].percent_of_total_traffic_impacted #=> Float
775
- # resp.health_events[0].impact_type #=> String, one of "AVAILABILITY", "PERFORMANCE"
816
+ # resp.health_events[0].impact_type #=> String, one of "AVAILABILITY", "PERFORMANCE", "LOCAL_AVAILABILITY", "LOCAL_PERFORMANCE"
776
817
  # resp.health_events[0].health_score_threshold #=> Float
777
818
  # resp.next_token #=> String
778
819
  #
@@ -931,10 +972,11 @@ module Aws::InternetMonitor
931
972
  req.send_request(options)
932
973
  end
933
974
 
934
- # Updates a monitor. You can update a monitor to change the maximum
935
- # number of city-networks (locations and ASNs or internet service
936
- # providers), to add or remove resources, or to change the status of the
937
- # monitor. Note that you can't change the name of a monitor.
975
+ # Updates a monitor. You can update a monitor to change the percentage
976
+ # of traffic to monitor or the maximum number of city-networks
977
+ # (locations and ASNs), to add or remove resources, or to change the
978
+ # status of the monitor. Note that you can't change the name of a
979
+ # monitor.
938
980
  #
939
981
  # The city-network maximum that you choose is the limit, but you only
940
982
  # pay for the number of city-networks that are actually monitored. For
@@ -950,15 +992,16 @@ module Aws::InternetMonitor
950
992
  #
951
993
  # @option params [Array<String>] :resources_to_add
952
994
  # The resources to include in a monitor, which you provide as a set of
953
- # Amazon Resource Names (ARNs).
995
+ # Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon
996
+ # CloudFront distributions, or Amazon WorkSpaces directories.
954
997
  #
955
- # You can add a combination of Amazon Virtual Private Clouds (VPCs) and
956
- # Amazon CloudFront distributions, or you can add Amazon WorkSpaces
957
- # directories. You can't add all three types of resources.
998
+ # You can add a combination of VPCs and CloudFront distributions, or you
999
+ # can add WorkSpaces directories, or you can add NLBs. You can't add
1000
+ # NLBs or WorkSpaces directories together with any other resources.
958
1001
  #
959
- # <note markdown="1"> If you add only VPC resources, at least one VPC must have an Internet
960
- # Gateway attached to it, to make sure that it has internet
961
- # connectivity.
1002
+ # <note markdown="1"> If you add only Amazon Virtual Private Clouds resources, at least one
1003
+ # VPC must have an Internet Gateway attached to it, to make sure that it
1004
+ # has internet connectivity.
962
1005
  #
963
1006
  # </note>
964
1007
  #
@@ -980,10 +1023,11 @@ module Aws::InternetMonitor
980
1023
  # not need to pass this option.**
981
1024
  #
982
1025
  # @option params [Integer] :max_city_networks_to_monitor
983
- # The maximum number of city-networks to monitor for your resources. A
1026
+ # The maximum number of city-networks to monitor for your application. A
984
1027
  # city-network is the location (city) where clients access your
985
- # application resources from and the network or ASN, such as an internet
986
- # service provider, that clients access the resources through.
1028
+ # application resources from and the ASN or network provider, such as an
1029
+ # internet service provider (ISP), that clients access the resources
1030
+ # through. Setting this limit can help control billing costs.
987
1031
  #
988
1032
  # @option params [Types::InternetMeasurementsLogDelivery] :internet_measurements_log_delivery
989
1033
  # Publish internet measurements for Internet Monitor to another
@@ -992,13 +1036,29 @@ module Aws::InternetMonitor
992
1036
  #
993
1037
  # @option params [Integer] :traffic_percentage_to_monitor
994
1038
  # The percentage of the internet-facing traffic for your application
995
- # that you want to monitor with this monitor.
1039
+ # that you want to monitor with this monitor. If you set a city-networks
1040
+ # maximum, that limit overrides the traffic percentage that you set.
1041
+ #
1042
+ # To learn more, see [Choosing an application traffic percentage to
1043
+ # monitor ][1] in the Amazon CloudWatch Internet Monitor section of the
1044
+ # *CloudWatch User Guide*.
1045
+ #
1046
+ #
1047
+ #
1048
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html
996
1049
  #
997
1050
  # @option params [Types::HealthEventsConfig] :health_events_config
998
- # The list of health event thresholds. A health event threshold
999
- # percentage, for performance and availability, determines when Internet
1000
- # Monitor creates a health event when there's an internet issue that
1001
- # affects your application end users.
1051
+ # The list of health score thresholds. A threshold percentage for health
1052
+ # scores, along with other configuration information, determines when
1053
+ # Internet Monitor creates a health event when there's an internet
1054
+ # issue that affects your application end users.
1055
+ #
1056
+ # For more information, see [ Change health event thresholds][1] in the
1057
+ # Internet Monitor section of the *CloudWatch User Guide*.
1058
+ #
1059
+ #
1060
+ #
1061
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview
1002
1062
  #
1003
1063
  # @return [Types::UpdateMonitorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1004
1064
  #
@@ -1025,6 +1085,16 @@ module Aws::InternetMonitor
1025
1085
  # health_events_config: {
1026
1086
  # availability_score_threshold: 1.0,
1027
1087
  # performance_score_threshold: 1.0,
1088
+ # availability_local_health_events_config: {
1089
+ # status: "ENABLED", # accepts ENABLED, DISABLED
1090
+ # health_score_threshold: 1.0,
1091
+ # min_traffic_impact: 1.0,
1092
+ # },
1093
+ # performance_local_health_events_config: {
1094
+ # status: "ENABLED", # accepts ENABLED, DISABLED
1095
+ # health_score_threshold: 1.0,
1096
+ # min_traffic_impact: 1.0,
1097
+ # },
1028
1098
  # },
1029
1099
  # })
1030
1100
  #
@@ -1055,7 +1125,7 @@ module Aws::InternetMonitor
1055
1125
  params: params,
1056
1126
  config: config)
1057
1127
  context[:gem_name] = 'aws-sdk-internetmonitor'
1058
- context[:gem_version] = '1.6.0'
1128
+ context[:gem_version] = '1.8.0'
1059
1129
  Seahorse::Client::Request.new(handlers, context)
1060
1130
  end
1061
1131
 
@@ -46,6 +46,8 @@ module Aws::InternetMonitor
46
46
  ListMonitorsOutput = Shapes::StructureShape.new(name: 'ListMonitorsOutput')
47
47
  ListTagsForResourceInput = Shapes::StructureShape.new(name: 'ListTagsForResourceInput')
48
48
  ListTagsForResourceOutput = Shapes::StructureShape.new(name: 'ListTagsForResourceOutput')
49
+ LocalHealthEventsConfig = Shapes::StructureShape.new(name: 'LocalHealthEventsConfig')
50
+ LocalHealthEventsConfigStatus = Shapes::StringShape.new(name: 'LocalHealthEventsConfigStatus')
49
51
  LogDeliveryStatus = Shapes::StringShape.new(name: 'LogDeliveryStatus')
50
52
  Long = Shapes::IntegerShape.new(name: 'Long')
51
53
  MaxCityNetworksToMonitor = Shapes::IntegerShape.new(name: 'MaxCityNetworksToMonitor')
@@ -170,6 +172,8 @@ module Aws::InternetMonitor
170
172
 
171
173
  HealthEventsConfig.add_member(:availability_score_threshold, Shapes::ShapeRef.new(shape: Percentage, location_name: "AvailabilityScoreThreshold"))
172
174
  HealthEventsConfig.add_member(:performance_score_threshold, Shapes::ShapeRef.new(shape: Percentage, location_name: "PerformanceScoreThreshold"))
175
+ HealthEventsConfig.add_member(:availability_local_health_events_config, Shapes::ShapeRef.new(shape: LocalHealthEventsConfig, location_name: "AvailabilityLocalHealthEventsConfig"))
176
+ HealthEventsConfig.add_member(:performance_local_health_events_config, Shapes::ShapeRef.new(shape: LocalHealthEventsConfig, location_name: "PerformanceLocalHealthEventsConfig"))
173
177
  HealthEventsConfig.struct_class = Types::HealthEventsConfig
174
178
 
175
179
  ImpactedLocation.add_member(:as_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ASName"))
@@ -233,6 +237,11 @@ module Aws::InternetMonitor
233
237
  ListTagsForResourceOutput.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
234
238
  ListTagsForResourceOutput.struct_class = Types::ListTagsForResourceOutput
235
239
 
240
+ LocalHealthEventsConfig.add_member(:status, Shapes::ShapeRef.new(shape: LocalHealthEventsConfigStatus, location_name: "Status"))
241
+ LocalHealthEventsConfig.add_member(:health_score_threshold, Shapes::ShapeRef.new(shape: Percentage, location_name: "HealthScoreThreshold"))
242
+ LocalHealthEventsConfig.add_member(:min_traffic_impact, Shapes::ShapeRef.new(shape: Percentage, location_name: "MinTrafficImpact"))
243
+ LocalHealthEventsConfig.struct_class = Types::LocalHealthEventsConfig
244
+
236
245
  Monitor.add_member(:monitor_name, Shapes::ShapeRef.new(shape: ResourceName, required: true, location_name: "MonitorName"))
237
246
  Monitor.add_member(:monitor_arn, Shapes::ShapeRef.new(shape: MonitorArn, required: true, location_name: "MonitorArn"))
238
247
  Monitor.add_member(:status, Shapes::ShapeRef.new(shape: MonitorConfigState, required: true, location_name: "Status"))
@@ -23,16 +23,17 @@ module Aws::InternetMonitor
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
- # Measurements about the availability for your application on the
27
- # internet, calculated by Amazon CloudWatch Internet Monitor. Amazon Web
28
- # Services has substantial historical data about internet performance
29
- # and availability between Amazon Web Services services and different
30
- # network providers and geographies. By applying statistical analysis to
31
- # the data, Internet Monitor can detect when the performance and
32
- # availability for your application has dropped, compared to an
33
- # estimated baseline that's already calculated. To make it easier to
34
- # see those drops, we report that information to you in the form of
35
- # health scores: a performance score and an availability score.
26
+ # Amazon CloudWatch Internet Monitor calculates measurements about the
27
+ # availability for your application's internet traffic between client
28
+ # locations and Amazon Web Services. Amazon Web Services has substantial
29
+ # historical data about internet performance and availability between
30
+ # Amazon Web Services services and different network providers and
31
+ # geographies. By applying statistical analysis to the data, Internet
32
+ # Monitor can detect when the performance and availability for your
33
+ # application has dropped, compared to an estimated baseline that's
34
+ # already calculated. To make it easier to see those drops, we report
35
+ # that information to you in the form of health scores: a performance
36
+ # score and an availability score.
36
37
  #
37
38
  # Availability in Internet Monitor represents the estimated percentage
38
39
  # of traffic that is not seeing an availability drop. For example, an
@@ -70,11 +71,15 @@ module Aws::InternetMonitor
70
71
  # @return [Float]
71
72
  #
72
73
  # @!attribute [rw] percent_of_total_traffic_impacted
73
- # The percentage of impact caused by a health event for total traffic
74
- # globally.
74
+ # The impact on total traffic that a health event has, in increased
75
+ # latency or reduced availability. This is the percentage of how much
76
+ # latency has increased or availability has decreased during the
77
+ # event, compared to what is typical for traffic from this client
78
+ # location to the Amazon Web Services location using this client
79
+ # network.
75
80
  #
76
81
  # For information about how Internet Monitor calculates impact, see
77
- # [Inside Internet Monitor][1] in the Amazon CloudWatch Internet
82
+ # [How Internet Monitor works][1] in the Amazon CloudWatch Internet
78
83
  # Monitor section of the Amazon CloudWatch User Guide.
79
84
  #
80
85
  #
@@ -137,13 +142,15 @@ module Aws::InternetMonitor
137
142
  #
138
143
  # @!attribute [rw] resources
139
144
  # The resources to include in a monitor, which you provide as a set of
140
- # Amazon Resource Names (ARNs).
145
+ # Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon
146
+ # CloudFront distributions, or Amazon WorkSpaces directories.
141
147
  #
142
- # You can add a combination of Amazon Virtual Private Clouds (VPCs)
143
- # and Amazon CloudFront distributions, or you can add Amazon
144
- # WorkSpaces directories. You can't add all three types of resources.
148
+ # You can add a combination of VPCs and CloudFront distributions, or
149
+ # you can add WorkSpaces directories, or you can add NLBs. You can't
150
+ # add NLBs or WorkSpaces directories together with any other
151
+ # resources.
145
152
  #
146
- # <note markdown="1"> If you add only VPC resources, at least one VPC must have an
153
+ # <note markdown="1"> If you add only Amazon VPC resources, at least one VPC must have an
147
154
  # Internet Gateway attached to it, to make sure that it has internet
148
155
  # connectivity.
149
156
  #
@@ -167,9 +174,10 @@ module Aws::InternetMonitor
167
174
  # @!attribute [rw] max_city_networks_to_monitor
168
175
  # The maximum number of city-networks to monitor for your resources. A
169
176
  # city-network is the location (city) where clients access your
170
- # application resources from and the network or ASN, such as an
171
- # internet service provider (ISP), that clients access the resources
172
- # through. This limit helps control billing costs.
177
+ # application resources from and the ASN or network provider, such as
178
+ # an internet service provider (ISP), that clients access the
179
+ # resources through. Setting this limit can help control billing
180
+ # costs.
173
181
  #
174
182
  # To learn more, see [Choosing a city-network maximum value ][1] in
175
183
  # the Amazon CloudWatch Internet Monitor section of the *CloudWatch
@@ -187,16 +195,36 @@ module Aws::InternetMonitor
187
195
  #
188
196
  # @!attribute [rw] traffic_percentage_to_monitor
189
197
  # The percentage of the internet-facing traffic for your application
190
- # that you want to monitor with this monitor.
198
+ # that you want to monitor with this monitor. If you set a
199
+ # city-networks maximum, that limit overrides the traffic percentage
200
+ # that you set.
201
+ #
202
+ # To learn more, see [Choosing an application traffic percentage to
203
+ # monitor ][1] in the Amazon CloudWatch Internet Monitor section of
204
+ # the *CloudWatch User Guide*.
205
+ #
206
+ #
207
+ #
208
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html
191
209
  # @return [Integer]
192
210
  #
193
211
  # @!attribute [rw] health_events_config
194
- # Defines the health event threshold percentages, for performance
195
- # score and availability score. Internet Monitor creates a health
196
- # event when there's an internet issue that affects your application
197
- # end users where a health score percentage is at or below a set
198
- # threshold. If you don't set a health event threshold, the default
199
- # calue is 95%.
212
+ # Defines the threshold percentages and other configuration
213
+ # information for when Amazon CloudWatch Internet Monitor creates a
214
+ # health event. Internet Monitor creates a health event when an
215
+ # internet issue that affects your application end users has a health
216
+ # score percentage that is at or below a specific threshold, and,
217
+ # sometimes, when other criteria are met.
218
+ #
219
+ # If you don't set a health event threshold, the default value is
220
+ # 95%.
221
+ #
222
+ # For more information, see [ Change health event thresholds][1] in
223
+ # the Internet Monitor section of the *CloudWatch User Guide*.
224
+ #
225
+ #
226
+ #
227
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview
200
228
  # @return [Types::HealthEventsConfig]
201
229
  #
202
230
  # @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/CreateMonitorInput AWS API Documentation
@@ -300,7 +328,12 @@ module Aws::InternetMonitor
300
328
  # @return [String]
301
329
  #
302
330
  # @!attribute [rw] percent_of_total_traffic_impacted
303
- # The impact on total traffic that a health event has.
331
+ # The impact on total traffic that a health event has, in increased
332
+ # latency or reduced availability. This is the percentage of how much
333
+ # latency has increased or availability has decreased during the
334
+ # event, compared to what is typical for traffic from this client
335
+ # location to the Amazon Web Services location using this client
336
+ # network.
304
337
  # @return [Float]
305
338
  #
306
339
  # @!attribute [rw] impact_type
@@ -308,8 +341,10 @@ module Aws::InternetMonitor
308
341
  # @return [String]
309
342
  #
310
343
  # @!attribute [rw] health_score_threshold
311
- # The threshold percentage for health events when Amazon CloudWatch
312
- # Internet Monitor creates a health event.
344
+ # The threshold percentage for a health score that determines, along
345
+ # with other configuration information, when Internet Monitor creates
346
+ # a health event when there's an internet issue that affects your
347
+ # application end users.
313
348
  # @return [Float]
314
349
  #
315
350
  # @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetHealthEventOutput AWS API Documentation
@@ -351,8 +386,8 @@ module Aws::InternetMonitor
351
386
  # @return [String]
352
387
  #
353
388
  # @!attribute [rw] resources
354
- # The resources that have been added for the monitor. Resources are
355
- # listed by their Amazon Resource Names (ARNs).
389
+ # The resources monitored by the monitor. Resources are listed by
390
+ # their Amazon Resource Names (ARNs).
356
391
  # @return [Array<String>]
357
392
  #
358
393
  # @!attribute [rw] status
@@ -383,9 +418,9 @@ module Aws::InternetMonitor
383
418
  # @!attribute [rw] max_city_networks_to_monitor
384
419
  # The maximum number of city-networks to monitor for your resources. A
385
420
  # city-network is the location (city) where clients access your
386
- # application resources from and the network or ASN, such as an
387
- # internet service provider (ISP), that clients access the resources
388
- # through. This limit helps control billing costs.
421
+ # application resources from and the ASN or network provider, such as
422
+ # an internet service provider (ISP), that clients access the
423
+ # resources through. This limit can help control billing costs.
389
424
  #
390
425
  # To learn more, see [Choosing a city-network maximum value ][1] in
391
426
  # the Amazon CloudWatch Internet Monitor section of the *CloudWatch
@@ -404,15 +439,31 @@ module Aws::InternetMonitor
404
439
  #
405
440
  # @!attribute [rw] traffic_percentage_to_monitor
406
441
  # The percentage of the internet-facing traffic for your application
407
- # that you want to monitor with this monitor.
442
+ # to monitor with this monitor. If you set a city-networks maximum,
443
+ # that limit overrides the traffic percentage that you set.
444
+ #
445
+ # To learn more, see [Choosing an application traffic percentage to
446
+ # monitor ][1] in the Amazon CloudWatch Internet Monitor section of
447
+ # the *CloudWatch User Guide*.
448
+ #
449
+ #
450
+ #
451
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html
408
452
  # @return [Integer]
409
453
  #
410
454
  # @!attribute [rw] health_events_config
411
- # The list of health event thresholds. A health event threshold
412
- # percentage, for performance and availability, determines the level
413
- # of impact at which Amazon CloudWatch Internet Monitor creates a
414
- # health event when there's an internet issue that affects your
415
- # application end users.
455
+ # The list of health event threshold configurations. The threshold
456
+ # percentage for a health score determines, along with other
457
+ # configuration information, when Internet Monitor creates a health
458
+ # event when there's an internet issue that affects your application
459
+ # end users.
460
+ #
461
+ # For more information, see [ Change health event thresholds][1] in
462
+ # the Internet Monitor section of the *CloudWatch User Guide*.
463
+ #
464
+ #
465
+ #
466
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview
416
467
  # @return [Types::HealthEventsConfig]
417
468
  #
418
469
  # @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetMonitorOutput AWS API Documentation
@@ -473,8 +524,12 @@ module Aws::InternetMonitor
473
524
  # @return [String]
474
525
  #
475
526
  # @!attribute [rw] percent_of_total_traffic_impacted
476
- # The impact on global traffic monitored by this monitor for this
477
- # health event.
527
+ # The impact on total traffic that a health event has, in increased
528
+ # latency or reduced availability. This is the percentage of how much
529
+ # latency has increased or availability has decreased during the
530
+ # event, compared to what is typical for traffic from this client
531
+ # location to the Amazon Web Services location using this client
532
+ # network.
478
533
  # @return [Float]
479
534
  #
480
535
  # @!attribute [rw] impact_type
@@ -505,12 +560,35 @@ module Aws::InternetMonitor
505
560
  include Aws::Structure
506
561
  end
507
562
 
508
- # A complex type for the configuration. Defines the health event
509
- # threshold percentages, for performance score and availability score.
510
- # Amazon CloudWatch Internet Monitor creates a health event when
511
- # there's an internet issue that affects your application end users
512
- # where a health score percentage is at or below a set threshold. If you
513
- # don't set a health event threshold, the default value is 95%.
563
+ # A complex type with the configuration information that determines the
564
+ # threshold and other conditions for when Internet Monitor creates a
565
+ # health event for an overall performance or availability issue, across
566
+ # an application's geographies.
567
+ #
568
+ # Defines the percentages, for overall performance scores and
569
+ # availability scores for an application, that are the thresholds for
570
+ # when Amazon CloudWatch Internet Monitor creates a health event. You
571
+ # can override the defaults to set a custom threshold for overall
572
+ # performance or availability scores, or both.
573
+ #
574
+ # You can also set thresholds for local health scores,, where Internet
575
+ # Monitor creates a health event when scores cross a threshold for one
576
+ # or more city-networks, in addition to creating an event when an
577
+ # overall score crosses a threshold.
578
+ #
579
+ # If you don't set a health event threshold, the default value is 95%.
580
+ #
581
+ # For local thresholds, you also set a minimum percentage of overall
582
+ # traffic that is impacted by an issue before Internet Monitor creates
583
+ # an event. In addition, you can disable local thresholds, for
584
+ # performance scores, availability scores, or both.
585
+ #
586
+ # For more information, see [ Change health event thresholds][1] in the
587
+ # Internet Monitor section of the *CloudWatch User Guide*.
588
+ #
589
+ #
590
+ #
591
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview
514
592
  #
515
593
  # @!attribute [rw] availability_score_threshold
516
594
  # The health event threshold percentage set for availability scores.
@@ -520,11 +598,25 @@ module Aws::InternetMonitor
520
598
  # The health event threshold percentage set for performance scores.
521
599
  # @return [Float]
522
600
  #
601
+ # @!attribute [rw] availability_local_health_events_config
602
+ # The configuration that determines the threshold and other conditions
603
+ # for when Internet Monitor creates a health event for a local
604
+ # availability issue.
605
+ # @return [Types::LocalHealthEventsConfig]
606
+ #
607
+ # @!attribute [rw] performance_local_health_events_config
608
+ # The configuration that determines the threshold and other conditions
609
+ # for when Internet Monitor creates a health event for a local
610
+ # performance issue.
611
+ # @return [Types::LocalHealthEventsConfig]
612
+ #
523
613
  # @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/HealthEventsConfig AWS API Documentation
524
614
  #
525
615
  class HealthEventsConfig < Struct.new(
526
616
  :availability_score_threshold,
527
- :performance_score_threshold)
617
+ :performance_score_threshold,
618
+ :availability_local_health_events_config,
619
+ :performance_local_health_events_config)
528
620
  SENSITIVE = []
529
621
  include Aws::Structure
530
622
  end
@@ -663,9 +755,9 @@ module Aws::InternetMonitor
663
755
  # geographies. By applying statistical analysis to the data, Internet
664
756
  # Monitor can detect when the performance and availability for your
665
757
  # application has dropped, compared to an estimated baseline that's
666
- # already calculated. To make it easier to see those drops, we report
667
- # that information to you in the form of health scores: a performance
668
- # score and an availability score.
758
+ # already calculated. To make it easier to see those drops, Internet
759
+ # Monitor reports the information to you in the form of health scores: a
760
+ # performance score and an availability score.
669
761
  #
670
762
  # @!attribute [rw] availability
671
763
  # Availability in Internet Monitor represents the estimated percentage
@@ -872,6 +964,52 @@ module Aws::InternetMonitor
872
964
  include Aws::Structure
873
965
  end
874
966
 
967
+ # A complex type with the configuration information that determines the
968
+ # threshold and other conditions for when Internet Monitor creates a
969
+ # health event for a local performance or availability issue, when
970
+ # scores cross a threshold for one or more city-networks.
971
+ #
972
+ # Defines the percentages, for performance scores or availability
973
+ # scores, that are the local thresholds for when Amazon CloudWatch
974
+ # Internet Monitor creates a health event. Also defines whether a local
975
+ # threshold is enabled or disabled, and the minimum percentage of
976
+ # overall traffic that must be impacted by an issue before Internet
977
+ # Monitor creates an event when a threshold is crossed for a local
978
+ # health score.
979
+ #
980
+ # For more information, see [ Change health event thresholds][1] in the
981
+ # Internet Monitor section of the *CloudWatch User Guide*.
982
+ #
983
+ #
984
+ #
985
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview
986
+ #
987
+ # @!attribute [rw] status
988
+ # The status of whether Internet Monitor creates a health event based
989
+ # on a threshold percentage set for a local health score. The status
990
+ # can be `ENABLED` or `DISABLED`.
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] health_score_threshold
994
+ # The health event threshold percentage set for a local health score.
995
+ # @return [Float]
996
+ #
997
+ # @!attribute [rw] min_traffic_impact
998
+ # The minimum percentage of overall traffic for an application that
999
+ # must be impacted by an issue before Internet Monitor creates an
1000
+ # event when a threshold is crossed for a local health score.
1001
+ # @return [Float]
1002
+ #
1003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/LocalHealthEventsConfig AWS API Documentation
1004
+ #
1005
+ class LocalHealthEventsConfig < Struct.new(
1006
+ :status,
1007
+ :health_score_threshold,
1008
+ :min_traffic_impact)
1009
+ SENSITIVE = []
1010
+ include Aws::Structure
1011
+ end
1012
+
875
1013
  # The description of and information about a monitor in Amazon
876
1014
  # CloudWatch Internet Monitor.
877
1015
  #
@@ -962,16 +1100,17 @@ module Aws::InternetMonitor
962
1100
  include Aws::Structure
963
1101
  end
964
1102
 
965
- # Measurements about the performance for your application on the
966
- # internet calculated by Amazon CloudWatch Internet Monitor. Amazon Web
967
- # Services has substantial historical data about internet performance
968
- # and availability between Amazon Web Services services and different
969
- # network providers and geographies. By applying statistical analysis to
970
- # the data, Internet Monitor can detect when the performance and
971
- # availability for your application has dropped, compared to an
972
- # estimated baseline that's already calculated. To make it easier to
973
- # see those drops, we report that information to you in the form of
974
- # health scores: a performance score and an availability score.
1103
+ # Amazon CloudWatch Internet Monitor calculates measurements about the
1104
+ # performance for your application's internet traffic between client
1105
+ # locations and Amazon Web Services. Amazon Web Services has substantial
1106
+ # historical data about internet performance and availability between
1107
+ # Amazon Web Services services and different network providers and
1108
+ # geographies. By applying statistical analysis to the data, Internet
1109
+ # Monitor can detect when the performance and availability for your
1110
+ # application has dropped, compared to an estimated baseline that's
1111
+ # already calculated. To make it easier to see those drops, we report
1112
+ # that information to you in the form of health scores: a performance
1113
+ # score and an availability score.
975
1114
  #
976
1115
  # Performance in Internet Monitor represents the estimated percentage of
977
1116
  # traffic that is not seeing a performance drop. For example, a
@@ -1009,10 +1148,12 @@ module Aws::InternetMonitor
1009
1148
  # @return [Float]
1010
1149
  #
1011
1150
  # @!attribute [rw] percent_of_total_traffic_impacted
1012
- # How much performance impact was caused by a health event for total
1013
- # traffic globally. For performance, this is the percentage of how
1014
- # much latency increased during the event compared to typical
1015
- # performance for your application traffic globally.
1151
+ # The impact on total traffic that a health event has, in increased
1152
+ # latency or reduced availability. This is the percentage of how much
1153
+ # latency has increased or availability has decreased during the
1154
+ # event, compared to what is typical for traffic from this client
1155
+ # location to the Amazon Web Services location using this client
1156
+ # network.
1016
1157
  #
1017
1158
  # For more information, see [When Amazon Web Services creates and
1018
1159
  # resolves health events][1] in the Amazon CloudWatch Internet Monitor
@@ -1210,15 +1351,17 @@ module Aws::InternetMonitor
1210
1351
  #
1211
1352
  # @!attribute [rw] resources_to_add
1212
1353
  # The resources to include in a monitor, which you provide as a set of
1213
- # Amazon Resource Names (ARNs).
1354
+ # Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon
1355
+ # CloudFront distributions, or Amazon WorkSpaces directories.
1214
1356
  #
1215
- # You can add a combination of Amazon Virtual Private Clouds (VPCs)
1216
- # and Amazon CloudFront distributions, or you can add Amazon
1217
- # WorkSpaces directories. You can't add all three types of resources.
1357
+ # You can add a combination of VPCs and CloudFront distributions, or
1358
+ # you can add WorkSpaces directories, or you can add NLBs. You can't
1359
+ # add NLBs or WorkSpaces directories together with any other
1360
+ # resources.
1218
1361
  #
1219
- # <note markdown="1"> If you add only VPC resources, at least one VPC must have an
1220
- # Internet Gateway attached to it, to make sure that it has internet
1221
- # connectivity.
1362
+ # <note markdown="1"> If you add only Amazon Virtual Private Clouds resources, at least
1363
+ # one VPC must have an Internet Gateway attached to it, to make sure
1364
+ # that it has internet connectivity.
1222
1365
  #
1223
1366
  # </note>
1224
1367
  # @return [Array<String>]
@@ -1244,11 +1387,12 @@ module Aws::InternetMonitor
1244
1387
  # @return [String]
1245
1388
  #
1246
1389
  # @!attribute [rw] max_city_networks_to_monitor
1247
- # The maximum number of city-networks to monitor for your resources. A
1248
- # city-network is the location (city) where clients access your
1249
- # application resources from and the network or ASN, such as an
1250
- # internet service provider, that clients access the resources
1251
- # through.
1390
+ # The maximum number of city-networks to monitor for your application.
1391
+ # A city-network is the location (city) where clients access your
1392
+ # application resources from and the ASN or network provider, such as
1393
+ # an internet service provider (ISP), that clients access the
1394
+ # resources through. Setting this limit can help control billing
1395
+ # costs.
1252
1396
  # @return [Integer]
1253
1397
  #
1254
1398
  # @!attribute [rw] internet_measurements_log_delivery
@@ -1259,14 +1403,31 @@ module Aws::InternetMonitor
1259
1403
  #
1260
1404
  # @!attribute [rw] traffic_percentage_to_monitor
1261
1405
  # The percentage of the internet-facing traffic for your application
1262
- # that you want to monitor with this monitor.
1406
+ # that you want to monitor with this monitor. If you set a
1407
+ # city-networks maximum, that limit overrides the traffic percentage
1408
+ # that you set.
1409
+ #
1410
+ # To learn more, see [Choosing an application traffic percentage to
1411
+ # monitor ][1] in the Amazon CloudWatch Internet Monitor section of
1412
+ # the *CloudWatch User Guide*.
1413
+ #
1414
+ #
1415
+ #
1416
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html
1263
1417
  # @return [Integer]
1264
1418
  #
1265
1419
  # @!attribute [rw] health_events_config
1266
- # The list of health event thresholds. A health event threshold
1267
- # percentage, for performance and availability, determines when
1268
- # Internet Monitor creates a health event when there's an internet
1269
- # issue that affects your application end users.
1420
+ # The list of health score thresholds. A threshold percentage for
1421
+ # health scores, along with other configuration information,
1422
+ # determines when Internet Monitor creates a health event when
1423
+ # there's an internet issue that affects your application end users.
1424
+ #
1425
+ # For more information, see [ Change health event thresholds][1] in
1426
+ # the Internet Monitor section of the *CloudWatch User Guide*.
1427
+ #
1428
+ #
1429
+ #
1430
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-overview.html#IMUpdateThresholdFromOverview
1270
1431
  # @return [Types::HealthEventsConfig]
1271
1432
  #
1272
1433
  # @see http://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/UpdateMonitorInput AWS API Documentation
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-internetmonitor/customizations'
53
53
  # @!group service
54
54
  module Aws::InternetMonitor
55
55
 
56
- GEM_VERSION = '1.6.0'
56
+ GEM_VERSION = '1.8.0'
57
57
 
58
58
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-internetmonitor
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.6.0
4
+ version: 1.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-07-06 00:00:00.000000000 Z
11
+ date: 2023-08-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core