aws-sdk-lightsail 1.29.0 → 1.34.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 +5 -5
- data/lib/aws-sdk-lightsail.rb +3 -1
- data/lib/aws-sdk-lightsail/client.rb +205 -115
- data/lib/aws-sdk-lightsail/client_api.rb +8 -0
- data/lib/aws-sdk-lightsail/errors.rb +2 -0
- data/lib/aws-sdk-lightsail/resource.rb +3 -7
- data/lib/aws-sdk-lightsail/types.rb +764 -281
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 54b03f91eab3b5c0a63974448185ddf6ad517ec3ddea3870bdf03a1e23db8b67
|
4
|
+
data.tar.gz: 69a058637aaa07d08ba33f3b93fb1923fb370231c82fa707c3dcf27201e8a358
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d6f53c06329bf5f401ad76b210a1b7c2586720c3f4925b3740de79fa0ecd4371eb1612402f2b70bb94a7da1ea619960347a62d357faffa500982cd73c95a04df
|
7
|
+
data.tar.gz: afc0a1382d791ad00d31068e659f283fa9d48b7c1fdea53230ec7f92451dc7b488030efdb5a78fd7c081407c284ef0f081900c79d34484cb687d42aa9e380f28
|
data/lib/aws-sdk-lightsail.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-lightsail/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::Lightsail
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.34.0'
|
49
51
|
|
50
52
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
32
|
|
@@ -32,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:lightsail)
|
|
32
35
|
module Aws::Lightsail
|
33
36
|
# An API client for Lightsail. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
37
|
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
38
|
+
# client = Aws::Lightsail::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
40
43
|
#
|
41
44
|
# For details on configuring region and credentials see
|
42
45
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -69,6 +72,7 @@ module Aws::Lightsail
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
74
78
|
|
@@ -105,7 +109,7 @@ module Aws::Lightsail
|
|
105
109
|
# @option options [required, String] :region
|
106
110
|
# The AWS region to connect to. The configured `:region` is
|
107
111
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
112
|
+
# a default `:region` is searched for in the following locations:
|
109
113
|
#
|
110
114
|
# * `Aws.config[:region]`
|
111
115
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +165,7 @@ module Aws::Lightsail
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +180,7 @@ module Aws::Lightsail
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
181
|
#
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
184
|
#
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
186
|
# The log formatter.
|
@@ -229,15 +233,19 @@ module Aws::Lightsail
|
|
229
233
|
#
|
230
234
|
# @option options [String] :retry_mode ("legacy")
|
231
235
|
# Specifies which retry algorithm to use. Values are:
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
236
|
+
#
|
237
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
238
|
+
# no retry mode is provided.
|
239
|
+
#
|
240
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
241
|
+
# This includes support for retry quotas, which limit the number of
|
242
|
+
# unsuccessful retries a client can make.
|
243
|
+
#
|
244
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
245
|
+
# functionality of `standard` mode along with automatic client side
|
246
|
+
# throttling. This is a provisional mode that may change behavior
|
247
|
+
# in the future.
|
248
|
+
#
|
241
249
|
#
|
242
250
|
# @option options [String] :secret_access_key
|
243
251
|
#
|
@@ -275,8 +283,7 @@ module Aws::Lightsail
|
|
275
283
|
#
|
276
284
|
# @option options [Integer] :http_read_timeout (60) The default
|
277
285
|
# number of seconds to wait for response data. This value can
|
278
|
-
# safely be set
|
279
|
-
# per-request on the session yielded by {#session_for}.
|
286
|
+
# safely be set per-request on the session.
|
280
287
|
#
|
281
288
|
# @option options [Float] :http_idle_timeout (5) The number of
|
282
289
|
# seconds a connection is allowed to sit idle before it is
|
@@ -288,7 +295,7 @@ module Aws::Lightsail
|
|
288
295
|
# request body. This option has no effect unless the request has
|
289
296
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
290
297
|
# disables this behaviour. This value can safely be set per
|
291
|
-
# request on the session
|
298
|
+
# request on the session.
|
292
299
|
#
|
293
300
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
294
301
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -589,11 +596,11 @@ module Aws::Lightsail
|
|
589
596
|
req.send_request(options)
|
590
597
|
end
|
591
598
|
|
592
|
-
# Closes
|
599
|
+
# Closes ports for a specific Amazon Lightsail instance.
|
593
600
|
#
|
594
|
-
# The `
|
601
|
+
# The `CloseInstancePublicPorts` action supports tag-based access
|
595
602
|
# control via resource tags applied to the resource identified by
|
596
|
-
# `
|
603
|
+
# `instanceName`. For more information, see the [Lightsail Dev
|
597
604
|
# Guide][1].
|
598
605
|
#
|
599
606
|
#
|
@@ -601,11 +608,10 @@ module Aws::Lightsail
|
|
601
608
|
# [1]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags
|
602
609
|
#
|
603
610
|
# @option params [required, Types::PortInfo] :port_info
|
604
|
-
#
|
611
|
+
# An object to describe the ports to close for the specified instance.
|
605
612
|
#
|
606
613
|
# @option params [required, String] :instance_name
|
607
|
-
# The name of the instance
|
608
|
-
# public ports.
|
614
|
+
# The name of the instance for which to close ports.
|
609
615
|
#
|
610
616
|
# @return [Types::CloseInstancePublicPortsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
611
617
|
#
|
@@ -617,7 +623,9 @@ module Aws::Lightsail
|
|
617
623
|
# port_info: { # required
|
618
624
|
# from_port: 1,
|
619
625
|
# to_port: 1,
|
620
|
-
# protocol: "tcp", # accepts tcp, all, udp
|
626
|
+
# protocol: "tcp", # accepts tcp, all, udp, icmp
|
627
|
+
# cidrs: ["string"],
|
628
|
+
# cidr_list_aliases: ["string"],
|
621
629
|
# },
|
622
630
|
# instance_name: "ResourceName", # required
|
623
631
|
# })
|
@@ -889,7 +897,7 @@ module Aws::Lightsail
|
|
889
897
|
# maximum of 15 digits, and they are prefixed with the plus character
|
890
898
|
# (+) and the country code. For example, a U.S. phone number in E.164
|
891
899
|
# format would be specified as +1XXX5550100. For more information, see
|
892
|
-
# [E.164][1]
|
900
|
+
# [E.164][1] on *Wikipedia*.
|
893
901
|
#
|
894
902
|
#
|
895
903
|
#
|
@@ -3778,7 +3786,7 @@ module Aws::Lightsail
|
|
3778
3786
|
# resp.alarms[0].datapoints_to_alarm #=> Integer
|
3779
3787
|
# resp.alarms[0].treat_missing_data #=> String, one of "breaching", "notBreaching", "ignore", "missing"
|
3780
3788
|
# resp.alarms[0].statistic #=> String, one of "Minimum", "Maximum", "Sum", "Average", "SampleCount"
|
3781
|
-
# resp.alarms[0].metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System", "ClientTLSNegotiationErrorCount", "HealthyHostCount", "UnhealthyHostCount", "HTTPCode_LB_4XX_Count", "HTTPCode_LB_5XX_Count", "HTTPCode_Instance_2XX_Count", "HTTPCode_Instance_3XX_Count", "HTTPCode_Instance_4XX_Count", "HTTPCode_Instance_5XX_Count", "InstanceResponseTime", "RejectedConnectionCount", "RequestCount", "DatabaseConnections", "DiskQueueDepth", "FreeStorageSpace", "NetworkReceiveThroughput", "NetworkTransmitThroughput"
|
3789
|
+
# resp.alarms[0].metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System", "ClientTLSNegotiationErrorCount", "HealthyHostCount", "UnhealthyHostCount", "HTTPCode_LB_4XX_Count", "HTTPCode_LB_5XX_Count", "HTTPCode_Instance_2XX_Count", "HTTPCode_Instance_3XX_Count", "HTTPCode_Instance_4XX_Count", "HTTPCode_Instance_5XX_Count", "InstanceResponseTime", "RejectedConnectionCount", "RequestCount", "DatabaseConnections", "DiskQueueDepth", "FreeStorageSpace", "NetworkReceiveThroughput", "NetworkTransmitThroughput", "BurstCapacityTime", "BurstCapacityPercentage"
|
3782
3790
|
# resp.alarms[0].state #=> String, one of "OK", "ALARM", "INSUFFICIENT_DATA"
|
3783
3791
|
# resp.alarms[0].unit #=> String, one of "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
|
3784
3792
|
# resp.alarms[0].contact_protocols #=> Array
|
@@ -4502,11 +4510,15 @@ module Aws::Lightsail
|
|
4502
4510
|
# resp.instance.networking.ports #=> Array
|
4503
4511
|
# resp.instance.networking.ports[0].from_port #=> Integer
|
4504
4512
|
# resp.instance.networking.ports[0].to_port #=> Integer
|
4505
|
-
# resp.instance.networking.ports[0].protocol #=> String, one of "tcp", "all", "udp"
|
4513
|
+
# resp.instance.networking.ports[0].protocol #=> String, one of "tcp", "all", "udp", "icmp"
|
4506
4514
|
# resp.instance.networking.ports[0].access_from #=> String
|
4507
4515
|
# resp.instance.networking.ports[0].access_type #=> String, one of "Public", "Private"
|
4508
4516
|
# resp.instance.networking.ports[0].common_name #=> String
|
4509
4517
|
# resp.instance.networking.ports[0].access_direction #=> String, one of "inbound", "outbound"
|
4518
|
+
# resp.instance.networking.ports[0].cidrs #=> Array
|
4519
|
+
# resp.instance.networking.ports[0].cidrs[0] #=> String
|
4520
|
+
# resp.instance.networking.ports[0].cidr_list_aliases #=> Array
|
4521
|
+
# resp.instance.networking.ports[0].cidr_list_aliases[0] #=> String
|
4510
4522
|
# resp.instance.state.code #=> Integer
|
4511
4523
|
# resp.instance.state.name #=> String
|
4512
4524
|
# resp.instance.username #=> String
|
@@ -4583,6 +4595,11 @@ module Aws::Lightsail
|
|
4583
4595
|
# Returns the data points for the specified Amazon Lightsail instance
|
4584
4596
|
# metric, given an instance name.
|
4585
4597
|
#
|
4598
|
+
# Metrics report the utilization of your resources, and the error counts
|
4599
|
+
# generated by them. Monitor and collect metric data regularly to
|
4600
|
+
# maintain the reliability, availability, and performance of your
|
4601
|
+
# resources.
|
4602
|
+
#
|
4586
4603
|
# @option params [required, String] :instance_name
|
4587
4604
|
# The name of the instance for which you want to get metrics data.
|
4588
4605
|
#
|
@@ -4593,7 +4610,39 @@ module Aws::Lightsail
|
|
4593
4610
|
# useful `statistics` to include in your request, and the published
|
4594
4611
|
# `unit` value.
|
4595
4612
|
#
|
4596
|
-
# * <b> <code>
|
4613
|
+
# * <b> <code>BurstCapacityPercentage</code> </b> - The percentage of
|
4614
|
+
# CPU performance available for your instance to burst above its
|
4615
|
+
# baseline. Your instance continuously accrues and consumes burst
|
4616
|
+
# capacity. Burst capacity stops accruing when your instance's
|
4617
|
+
# `BurstCapacityPercentage` reaches 100%. For more information, see
|
4618
|
+
# [Viewing instance burst capacity in Amazon Lightsail][1].
|
4619
|
+
#
|
4620
|
+
# `Statistics`\: The most useful statistics are `Maximum` and
|
4621
|
+
# `Average`.
|
4622
|
+
#
|
4623
|
+
# `Unit`\: The published unit is `Percent`.
|
4624
|
+
#
|
4625
|
+
# * <b> <code>BurstCapacityTime</code> </b> - The available amount of
|
4626
|
+
# time for your instance to burst at 100% CPU utilization. Your
|
4627
|
+
# instance continuously accrues and consumes burst capacity. Burst
|
4628
|
+
# capacity time stops accruing when your instance's
|
4629
|
+
# `BurstCapacityPercentage` metric reaches 100%.
|
4630
|
+
#
|
4631
|
+
# Burst capacity time is consumed at the full rate only when your
|
4632
|
+
# instance operates at 100% CPU utilization. For example, if your
|
4633
|
+
# instance operates at 50% CPU utilization in the burstable zone for a
|
4634
|
+
# 5-minute period, then it consumes CPU burst capacity minutes at a
|
4635
|
+
# 50% rate in that period. Your instance consumed 2 minutes and 30
|
4636
|
+
# seconds of CPU burst capacity minutes in the 5-minute period. For
|
4637
|
+
# more information, see [Viewing instance burst capacity in Amazon
|
4638
|
+
# Lightsail][1].
|
4639
|
+
#
|
4640
|
+
# `Statistics`\: The most useful statistics are `Maximum` and
|
4641
|
+
# `Average`.
|
4642
|
+
#
|
4643
|
+
# `Unit`\: The published unit is `Seconds`.
|
4644
|
+
#
|
4645
|
+
# * <b> <code>CPUUtilization</code> </b> - The percentage of allocated
|
4597
4646
|
# compute units that are currently in use on the instance. This metric
|
4598
4647
|
# identifies the processing power to run the applications on the
|
4599
4648
|
# instance. Tools in your operating system can show a lower percentage
|
@@ -4605,7 +4654,7 @@ module Aws::Lightsail
|
|
4605
4654
|
#
|
4606
4655
|
# `Unit`\: The published unit is `Percent`.
|
4607
4656
|
#
|
4608
|
-
# * <b> <code>NetworkIn</code> </b>
|
4657
|
+
# * <b> <code>NetworkIn</code> </b> - The number of bytes received on
|
4609
4658
|
# all network interfaces by the instance. This metric identifies the
|
4610
4659
|
# volume of incoming network traffic to the instance. The number
|
4611
4660
|
# reported is the number of bytes received during the period. Because
|
@@ -4616,7 +4665,7 @@ module Aws::Lightsail
|
|
4616
4665
|
#
|
4617
4666
|
# `Unit`\: The published unit is `Bytes`.
|
4618
4667
|
#
|
4619
|
-
# * <b> <code>NetworkOut</code> </b>
|
4668
|
+
# * <b> <code>NetworkOut</code> </b> - The number of bytes sent out on
|
4620
4669
|
# all network interfaces by the instance. This metric identifies the
|
4621
4670
|
# volume of outgoing network traffic from the instance. The number
|
4622
4671
|
# reported is the number of bytes sent during the period. Because this
|
@@ -4627,7 +4676,7 @@ module Aws::Lightsail
|
|
4627
4676
|
#
|
4628
4677
|
# `Unit`\: The published unit is `Bytes`.
|
4629
4678
|
#
|
4630
|
-
# * <b> <code>StatusCheckFailed</code> </b>
|
4679
|
+
# * <b> <code>StatusCheckFailed</code> </b> - Reports whether the
|
4631
4680
|
# instance passed or failed both the instance status check and the
|
4632
4681
|
# system status check. This metric can be either 0 (passed) or 1
|
4633
4682
|
# (failed). This metric data is available in 1-minute (60 seconds)
|
@@ -4637,7 +4686,7 @@ module Aws::Lightsail
|
|
4637
4686
|
#
|
4638
4687
|
# `Unit`\: The published unit is `Count`.
|
4639
4688
|
#
|
4640
|
-
# * <b> <code>StatusCheckFailed_Instance</code> </b>
|
4689
|
+
# * <b> <code>StatusCheckFailed_Instance</code> </b> - Reports whether
|
4641
4690
|
# the instance passed or failed the instance status check. This metric
|
4642
4691
|
# can be either 0 (passed) or 1 (failed). This metric data is
|
4643
4692
|
# available in 1-minute (60 seconds) granularity.
|
@@ -4646,7 +4695,7 @@ module Aws::Lightsail
|
|
4646
4695
|
#
|
4647
4696
|
# `Unit`\: The published unit is `Count`.
|
4648
4697
|
#
|
4649
|
-
# * <b> <code>StatusCheckFailed_System</code> </b>
|
4698
|
+
# * <b> <code>StatusCheckFailed_System</code> </b> - Reports whether the
|
4650
4699
|
# instance passed or failed the system status check. This metric can
|
4651
4700
|
# be either 0 (passed) or 1 (failed). This metric data is available in
|
4652
4701
|
# 1-minute (60 seconds) granularity.
|
@@ -4655,6 +4704,10 @@ module Aws::Lightsail
|
|
4655
4704
|
#
|
4656
4705
|
# `Unit`\: The published unit is `Count`.
|
4657
4706
|
#
|
4707
|
+
#
|
4708
|
+
#
|
4709
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity
|
4710
|
+
#
|
4658
4711
|
# @option params [required, Integer] :period
|
4659
4712
|
# The granularity, in seconds, of the returned data points.
|
4660
4713
|
#
|
@@ -4671,34 +4724,34 @@ module Aws::Lightsail
|
|
4671
4724
|
#
|
4672
4725
|
# @option params [required, String] :unit
|
4673
4726
|
# The unit for the metric data request. Valid units depend on the metric
|
4674
|
-
# data being
|
4675
|
-
# see the `metricName` parameter.
|
4727
|
+
# data being requested. For the valid units to specify with each
|
4728
|
+
# available metric, see the `metricName` parameter.
|
4676
4729
|
#
|
4677
4730
|
# @option params [required, Array<String>] :statistics
|
4678
4731
|
# The statistic for the metric.
|
4679
4732
|
#
|
4680
4733
|
# The following statistics are available:
|
4681
4734
|
#
|
4682
|
-
# * `Minimum`
|
4735
|
+
# * `Minimum` - The lowest value observed during the specified period.
|
4683
4736
|
# Use this value to determine low volumes of activity for your
|
4684
4737
|
# application.
|
4685
4738
|
#
|
4686
|
-
# * `Maximum`
|
4739
|
+
# * `Maximum` - The highest value observed during the specified period.
|
4687
4740
|
# Use this value to determine high volumes of activity for your
|
4688
4741
|
# application.
|
4689
4742
|
#
|
4690
|
-
# * `Sum`
|
4743
|
+
# * `Sum` - All values submitted for the matching metric added together.
|
4691
4744
|
# You can use this statistic to determine the total volume of a
|
4692
4745
|
# metric.
|
4693
4746
|
#
|
4694
|
-
# * `Average`
|
4747
|
+
# * `Average` - The value of Sum / SampleCount during the specified
|
4695
4748
|
# period. By comparing this statistic with the Minimum and Maximum
|
4696
4749
|
# values, you can determine the full scope of a metric and how close
|
4697
4750
|
# the average use is to the Minimum and Maximum values. This
|
4698
4751
|
# comparison helps you to know when to increase or decrease your
|
4699
4752
|
# resources.
|
4700
4753
|
#
|
4701
|
-
# * `SampleCount`
|
4754
|
+
# * `SampleCount` - The count, or number, of data points used for the
|
4702
4755
|
# statistical calculation.
|
4703
4756
|
#
|
4704
4757
|
# @return [Types::GetInstanceMetricDataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -4710,7 +4763,7 @@ module Aws::Lightsail
|
|
4710
4763
|
#
|
4711
4764
|
# resp = client.get_instance_metric_data({
|
4712
4765
|
# instance_name: "ResourceName", # required
|
4713
|
-
# metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System
|
4766
|
+
# metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, BurstCapacityTime, BurstCapacityPercentage
|
4714
4767
|
# period: 1, # required
|
4715
4768
|
# start_time: Time.now, # required
|
4716
4769
|
# end_time: Time.now, # required
|
@@ -4720,7 +4773,7 @@ module Aws::Lightsail
|
|
4720
4773
|
#
|
4721
4774
|
# @example Response structure
|
4722
4775
|
#
|
4723
|
-
# resp.metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System"
|
4776
|
+
# resp.metric_name #=> String, one of "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System", "BurstCapacityTime", "BurstCapacityPercentage"
|
4724
4777
|
# resp.metric_data #=> Array
|
4725
4778
|
# resp.metric_data[0].average #=> Float
|
4726
4779
|
# resp.metric_data[0].maximum #=> Float
|
@@ -4739,11 +4792,12 @@ module Aws::Lightsail
|
|
4739
4792
|
req.send_request(options)
|
4740
4793
|
end
|
4741
4794
|
|
4742
|
-
# Returns the port states for a specific
|
4743
|
-
#
|
4795
|
+
# Returns the firewall port states for a specific Amazon Lightsail
|
4796
|
+
# instance, the IP addresses allowed to connect to the instance through
|
4797
|
+
# the ports, and the protocol.
|
4744
4798
|
#
|
4745
4799
|
# @option params [required, String] :instance_name
|
4746
|
-
# The name of the instance.
|
4800
|
+
# The name of the instance for which to return firewall port states.
|
4747
4801
|
#
|
4748
4802
|
# @return [Types::GetInstancePortStatesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4749
4803
|
#
|
@@ -4760,8 +4814,12 @@ module Aws::Lightsail
|
|
4760
4814
|
# resp.port_states #=> Array
|
4761
4815
|
# resp.port_states[0].from_port #=> Integer
|
4762
4816
|
# resp.port_states[0].to_port #=> Integer
|
4763
|
-
# resp.port_states[0].protocol #=> String, one of "tcp", "all", "udp"
|
4817
|
+
# resp.port_states[0].protocol #=> String, one of "tcp", "all", "udp", "icmp"
|
4764
4818
|
# resp.port_states[0].state #=> String, one of "open", "closed"
|
4819
|
+
# resp.port_states[0].cidrs #=> Array
|
4820
|
+
# resp.port_states[0].cidrs[0] #=> String
|
4821
|
+
# resp.port_states[0].cidr_list_aliases #=> Array
|
4822
|
+
# resp.port_states[0].cidr_list_aliases[0] #=> String
|
4765
4823
|
#
|
4766
4824
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStates AWS API Documentation
|
4767
4825
|
#
|
@@ -5027,11 +5085,15 @@ module Aws::Lightsail
|
|
5027
5085
|
# resp.instances[0].networking.ports #=> Array
|
5028
5086
|
# resp.instances[0].networking.ports[0].from_port #=> Integer
|
5029
5087
|
# resp.instances[0].networking.ports[0].to_port #=> Integer
|
5030
|
-
# resp.instances[0].networking.ports[0].protocol #=> String, one of "tcp", "all", "udp"
|
5088
|
+
# resp.instances[0].networking.ports[0].protocol #=> String, one of "tcp", "all", "udp", "icmp"
|
5031
5089
|
# resp.instances[0].networking.ports[0].access_from #=> String
|
5032
5090
|
# resp.instances[0].networking.ports[0].access_type #=> String, one of "Public", "Private"
|
5033
5091
|
# resp.instances[0].networking.ports[0].common_name #=> String
|
5034
5092
|
# resp.instances[0].networking.ports[0].access_direction #=> String, one of "inbound", "outbound"
|
5093
|
+
# resp.instances[0].networking.ports[0].cidrs #=> Array
|
5094
|
+
# resp.instances[0].networking.ports[0].cidrs[0] #=> String
|
5095
|
+
# resp.instances[0].networking.ports[0].cidr_list_aliases #=> Array
|
5096
|
+
# resp.instances[0].networking.ports[0].cidr_list_aliases[0] #=> String
|
5035
5097
|
# resp.instances[0].state.code #=> Integer
|
5036
5098
|
# resp.instances[0].state.name #=> String
|
5037
5099
|
# resp.instances[0].username #=> String
|
@@ -5186,6 +5248,11 @@ module Aws::Lightsail
|
|
5186
5248
|
# Returns information about health metrics for your Lightsail load
|
5187
5249
|
# balancer.
|
5188
5250
|
#
|
5251
|
+
# Metrics report the utilization of your resources, and the error counts
|
5252
|
+
# generated by them. Monitor and collect metric data regularly to
|
5253
|
+
# maintain the reliability, availability, and performance of your
|
5254
|
+
# resources.
|
5255
|
+
#
|
5189
5256
|
# @option params [required, String] :load_balancer_name
|
5190
5257
|
# The name of the load balancer.
|
5191
5258
|
#
|
@@ -5196,7 +5263,7 @@ module Aws::Lightsail
|
|
5196
5263
|
# useful `statistics` to include in your request, and the published
|
5197
5264
|
# `unit` value.
|
5198
5265
|
#
|
5199
|
-
# * <b> <code>ClientTLSNegotiationErrorCount</code> </b>
|
5266
|
+
# * <b> <code>ClientTLSNegotiationErrorCount</code> </b> - The number of
|
5200
5267
|
# TLS connections initiated by the client that did not establish a
|
5201
5268
|
# session with the load balancer due to a TLS error generated by the
|
5202
5269
|
# load balancer. Possible causes include a mismatch of ciphers or
|
@@ -5206,7 +5273,7 @@ module Aws::Lightsail
|
|
5206
5273
|
#
|
5207
5274
|
# `Unit`\: The published unit is `Count`.
|
5208
5275
|
#
|
5209
|
-
# * <b> <code>HealthyHostCount</code> </b>
|
5276
|
+
# * <b> <code>HealthyHostCount</code> </b> - The number of target
|
5210
5277
|
# instances that are considered healthy.
|
5211
5278
|
#
|
5212
5279
|
# `Statistics`\: The most useful statistic are `Average`, `Minimum`,
|
@@ -5214,7 +5281,7 @@ module Aws::Lightsail
|
|
5214
5281
|
#
|
5215
5282
|
# `Unit`\: The published unit is `Count`.
|
5216
5283
|
#
|
5217
|
-
# * <b> <code>HTTPCode_Instance_2XX_Count</code> </b>
|
5284
|
+
# * <b> <code>HTTPCode_Instance_2XX_Count</code> </b> - The number of
|
5218
5285
|
# HTTP 2XX response codes generated by the target instances. This does
|
5219
5286
|
# not include any response codes generated by the load balancer.
|
5220
5287
|
#
|
@@ -5223,7 +5290,7 @@ module Aws::Lightsail
|
|
5223
5290
|
#
|
5224
5291
|
# `Unit`\: The published unit is `Count`.
|
5225
5292
|
#
|
5226
|
-
# * <b> <code>HTTPCode_Instance_3XX_Count</code> </b>
|
5293
|
+
# * <b> <code>HTTPCode_Instance_3XX_Count</code> </b> - The number of
|
5227
5294
|
# HTTP 3XX response codes generated by the target instances. This does
|
5228
5295
|
# not include any response codes generated by the load balancer.
|
5229
5296
|
#
|
@@ -5232,7 +5299,7 @@ module Aws::Lightsail
|
|
5232
5299
|
#
|
5233
5300
|
# `Unit`\: The published unit is `Count`.
|
5234
5301
|
#
|
5235
|
-
# * <b> <code>HTTPCode_Instance_4XX_Count</code> </b>
|
5302
|
+
# * <b> <code>HTTPCode_Instance_4XX_Count</code> </b> - The number of
|
5236
5303
|
# HTTP 4XX response codes generated by the target instances. This does
|
5237
5304
|
# not include any response codes generated by the load balancer.
|
5238
5305
|
#
|
@@ -5241,7 +5308,7 @@ module Aws::Lightsail
|
|
5241
5308
|
#
|
5242
5309
|
# `Unit`\: The published unit is `Count`.
|
5243
5310
|
#
|
5244
|
-
# * <b> <code>HTTPCode_Instance_5XX_Count</code> </b>
|
5311
|
+
# * <b> <code>HTTPCode_Instance_5XX_Count</code> </b> - The number of
|
5245
5312
|
# HTTP 5XX response codes generated by the target instances. This does
|
5246
5313
|
# not include any response codes generated by the load balancer.
|
5247
5314
|
#
|
@@ -5250,7 +5317,7 @@ module Aws::Lightsail
|
|
5250
5317
|
#
|
5251
5318
|
# `Unit`\: The published unit is `Count`.
|
5252
5319
|
#
|
5253
|
-
# * <b> <code>HTTPCode_LB_4XX_Count</code> </b>
|
5320
|
+
# * <b> <code>HTTPCode_LB_4XX_Count</code> </b> - The number of HTTP 4XX
|
5254
5321
|
# client error codes that originated from the load balancer. Client
|
5255
5322
|
# errors are generated when requests are malformed or incomplete.
|
5256
5323
|
# These requests were not received by the target instance. This count
|
@@ -5261,7 +5328,7 @@ module Aws::Lightsail
|
|
5261
5328
|
#
|
5262
5329
|
# `Unit`\: The published unit is `Count`.
|
5263
5330
|
#
|
5264
|
-
# * <b> <code>HTTPCode_LB_5XX_Count</code> </b>
|
5331
|
+
# * <b> <code>HTTPCode_LB_5XX_Count</code> </b> - The number of HTTP 5XX
|
5265
5332
|
# server error codes that originated from the load balancer. This does
|
5266
5333
|
# not include any response codes generated by the target instance.
|
5267
5334
|
# This metric is reported if there are no healthy instances attached
|
@@ -5273,7 +5340,7 @@ module Aws::Lightsail
|
|
5273
5340
|
#
|
5274
5341
|
# `Unit`\: The published unit is `Count`.
|
5275
5342
|
#
|
5276
|
-
# * <b> <code>InstanceResponseTime</code> </b>
|
5343
|
+
# * <b> <code>InstanceResponseTime</code> </b> - The time elapsed, in
|
5277
5344
|
# seconds, after the request leaves the load balancer until a response
|
5278
5345
|
# from the target instance is received.
|
5279
5346
|
#
|
@@ -5281,7 +5348,7 @@ module Aws::Lightsail
|
|
5281
5348
|
#
|
5282
5349
|
# `Unit`\: The published unit is `Seconds`.
|
5283
5350
|
#
|
5284
|
-
# * <b> <code>RejectedConnectionCount</code> </b>
|
5351
|
+
# * <b> <code>RejectedConnectionCount</code> </b> - The number of
|
5285
5352
|
# connections that were rejected because the load balancer had reached
|
5286
5353
|
# its maximum number of connections.
|
5287
5354
|
#
|
@@ -5289,7 +5356,7 @@ module Aws::Lightsail
|
|
5289
5356
|
#
|
5290
5357
|
# `Unit`\: The published unit is `Count`.
|
5291
5358
|
#
|
5292
|
-
# * <b> <code>RequestCount</code> </b>
|
5359
|
+
# * <b> <code>RequestCount</code> </b> - The number of requests
|
5293
5360
|
# processed over IPv4. This count includes only the requests with a
|
5294
5361
|
# response generated by a target instance of the load balancer.
|
5295
5362
|
#
|
@@ -5298,7 +5365,7 @@ module Aws::Lightsail
|
|
5298
5365
|
#
|
5299
5366
|
# `Unit`\: The published unit is `Count`.
|
5300
5367
|
#
|
5301
|
-
# * <b> <code>UnhealthyHostCount</code> </b>
|
5368
|
+
# * <b> <code>UnhealthyHostCount</code> </b> - The number of target
|
5302
5369
|
# instances that are considered unhealthy.
|
5303
5370
|
#
|
5304
5371
|
# `Statistics`\: The most useful statistic are `Average`, `Minimum`,
|
@@ -5317,7 +5384,7 @@ module Aws::Lightsail
|
|
5317
5384
|
#
|
5318
5385
|
# @option params [required, String] :unit
|
5319
5386
|
# The unit for the metric data request. Valid units depend on the metric
|
5320
|
-
# data being
|
5387
|
+
# data being requested. For the valid units with each available metric,
|
5321
5388
|
# see the `metricName` parameter.
|
5322
5389
|
#
|
5323
5390
|
# @option params [required, Array<String>] :statistics
|
@@ -5325,26 +5392,26 @@ module Aws::Lightsail
|
|
5325
5392
|
#
|
5326
5393
|
# The following statistics are available:
|
5327
5394
|
#
|
5328
|
-
# * `Minimum`
|
5395
|
+
# * `Minimum` - The lowest value observed during the specified period.
|
5329
5396
|
# Use this value to determine low volumes of activity for your
|
5330
5397
|
# application.
|
5331
5398
|
#
|
5332
|
-
# * `Maximum`
|
5399
|
+
# * `Maximum` - The highest value observed during the specified period.
|
5333
5400
|
# Use this value to determine high volumes of activity for your
|
5334
5401
|
# application.
|
5335
5402
|
#
|
5336
|
-
# * `Sum`
|
5403
|
+
# * `Sum` - All values submitted for the matching metric added together.
|
5337
5404
|
# You can use this statistic to determine the total volume of a
|
5338
5405
|
# metric.
|
5339
5406
|
#
|
5340
|
-
# * `Average`
|
5407
|
+
# * `Average` - The value of Sum / SampleCount during the specified
|
5341
5408
|
# period. By comparing this statistic with the Minimum and Maximum
|
5342
5409
|
# values, you can determine the full scope of a metric and how close
|
5343
5410
|
# the average use is to the Minimum and Maximum values. This
|
5344
5411
|
# comparison helps you to know when to increase or decrease your
|
5345
5412
|
# resources.
|
5346
5413
|
#
|
5347
|
-
# * `SampleCount`
|
5414
|
+
# * `SampleCount` - The count, or number, of data points used for the
|
5348
5415
|
# statistical calculation.
|
5349
5416
|
#
|
5350
5417
|
# @return [Types::GetLoadBalancerMetricDataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -6094,6 +6161,11 @@ module Aws::Lightsail
|
|
6094
6161
|
# Returns the data points of the specified metric for a database in
|
6095
6162
|
# Amazon Lightsail.
|
6096
6163
|
#
|
6164
|
+
# Metrics report the utilization of your resources, and the error counts
|
6165
|
+
# generated by them. Monitor and collect metric data regularly to
|
6166
|
+
# maintain the reliability, availability, and performance of your
|
6167
|
+
# resources.
|
6168
|
+
#
|
6097
6169
|
# @option params [required, String] :relational_database_name
|
6098
6170
|
# The name of your database from which to get metric data.
|
6099
6171
|
#
|
@@ -6105,7 +6177,7 @@ module Aws::Lightsail
|
|
6105
6177
|
# published `unit` value. All relational database metric data is
|
6106
6178
|
# available in 1-minute (60 seconds) granularity.
|
6107
6179
|
#
|
6108
|
-
# * <b> <code>CPUUtilization</code> </b>
|
6180
|
+
# * <b> <code>CPUUtilization</code> </b> - The percentage of CPU
|
6109
6181
|
# utilization currently in use on the database.
|
6110
6182
|
#
|
6111
6183
|
# `Statistics`\: The most useful statistics are `Maximum` and
|
@@ -6113,28 +6185,28 @@ module Aws::Lightsail
|
|
6113
6185
|
#
|
6114
6186
|
# `Unit`\: The published unit is `Percent`.
|
6115
6187
|
#
|
6116
|
-
# * <b> <code>DatabaseConnections</code> </b>
|
6188
|
+
# * <b> <code>DatabaseConnections</code> </b> - The number of database
|
6117
6189
|
# connections in use.
|
6118
6190
|
#
|
6119
6191
|
# `Statistics`\: The most useful statistics are `Maximum` and `Sum`.
|
6120
6192
|
#
|
6121
6193
|
# `Unit`\: The published unit is `Count`.
|
6122
6194
|
#
|
6123
|
-
# * <b> <code>DiskQueueDepth</code> </b>
|
6195
|
+
# * <b> <code>DiskQueueDepth</code> </b> - The number of outstanding IOs
|
6124
6196
|
# (read/write requests) that are waiting to access the disk.
|
6125
6197
|
#
|
6126
6198
|
# `Statistics`\: The most useful statistic is `Sum`.
|
6127
6199
|
#
|
6128
6200
|
# `Unit`\: The published unit is `Count`.
|
6129
6201
|
#
|
6130
|
-
# * <b> <code>FreeStorageSpace</code> </b>
|
6202
|
+
# * <b> <code>FreeStorageSpace</code> </b> - The amount of available
|
6131
6203
|
# storage space.
|
6132
6204
|
#
|
6133
6205
|
# `Statistics`\: The most useful statistic is `Sum`.
|
6134
6206
|
#
|
6135
6207
|
# `Unit`\: The published unit is `Bytes`.
|
6136
6208
|
#
|
6137
|
-
# * <b> <code>NetworkReceiveThroughput</code> </b>
|
6209
|
+
# * <b> <code>NetworkReceiveThroughput</code> </b> - The incoming
|
6138
6210
|
# (Receive) network traffic on the database, including both customer
|
6139
6211
|
# database traffic and AWS traffic used for monitoring and
|
6140
6212
|
# replication.
|
@@ -6143,7 +6215,7 @@ module Aws::Lightsail
|
|
6143
6215
|
#
|
6144
6216
|
# `Unit`\: The published unit is `Bytes/Second`.
|
6145
6217
|
#
|
6146
|
-
# * <b> <code>NetworkTransmitThroughput</code> </b>
|
6218
|
+
# * <b> <code>NetworkTransmitThroughput</code> </b> - The outgoing
|
6147
6219
|
# (Transmit) network traffic on the database, including both customer
|
6148
6220
|
# database traffic and AWS traffic used for monitoring and
|
6149
6221
|
# replication.
|
@@ -6184,7 +6256,7 @@ module Aws::Lightsail
|
|
6184
6256
|
#
|
6185
6257
|
# @option params [required, String] :unit
|
6186
6258
|
# The unit for the metric data request. Valid units depend on the metric
|
6187
|
-
# data being
|
6259
|
+
# data being requested. For the valid units with each available metric,
|
6188
6260
|
# see the `metricName` parameter.
|
6189
6261
|
#
|
6190
6262
|
# @option params [required, Array<String>] :statistics
|
@@ -6192,26 +6264,26 @@ module Aws::Lightsail
|
|
6192
6264
|
#
|
6193
6265
|
# The following statistics are available:
|
6194
6266
|
#
|
6195
|
-
# * `Minimum`
|
6267
|
+
# * `Minimum` - The lowest value observed during the specified period.
|
6196
6268
|
# Use this value to determine low volumes of activity for your
|
6197
6269
|
# application.
|
6198
6270
|
#
|
6199
|
-
# * `Maximum`
|
6271
|
+
# * `Maximum` - The highest value observed during the specified period.
|
6200
6272
|
# Use this value to determine high volumes of activity for your
|
6201
6273
|
# application.
|
6202
6274
|
#
|
6203
|
-
# * `Sum`
|
6275
|
+
# * `Sum` - All values submitted for the matching metric added together.
|
6204
6276
|
# You can use this statistic to determine the total volume of a
|
6205
6277
|
# metric.
|
6206
6278
|
#
|
6207
|
-
# * `Average`
|
6279
|
+
# * `Average` - The value of Sum / SampleCount during the specified
|
6208
6280
|
# period. By comparing this statistic with the Minimum and Maximum
|
6209
6281
|
# values, you can determine the full scope of a metric and how close
|
6210
6282
|
# the average use is to the Minimum and Maximum values. This
|
6211
6283
|
# comparison helps you to know when to increase or decrease your
|
6212
6284
|
# resources.
|
6213
6285
|
#
|
6214
|
-
# * `SampleCount`
|
6286
|
+
# * `SampleCount` - The count, or number, of data points used for the
|
6215
6287
|
# statistical calculation.
|
6216
6288
|
#
|
6217
6289
|
# @return [Types::GetRelationalDatabaseMetricDataResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -6623,11 +6695,13 @@ module Aws::Lightsail
|
|
6623
6695
|
req.send_request(options)
|
6624
6696
|
end
|
6625
6697
|
|
6626
|
-
#
|
6698
|
+
# Opens ports for a specific Amazon Lightsail instance, and specifies
|
6699
|
+
# the IP addresses allowed to connect to the instance through the ports,
|
6700
|
+
# and the protocol.
|
6627
6701
|
#
|
6628
|
-
# The `
|
6629
|
-
#
|
6630
|
-
# `
|
6702
|
+
# The `OpenInstancePublicPorts` action supports tag-based access control
|
6703
|
+
# via resource tags applied to the resource identified by
|
6704
|
+
# `instanceName`. For more information, see the [Lightsail Dev
|
6631
6705
|
# Guide][1].
|
6632
6706
|
#
|
6633
6707
|
#
|
@@ -6635,11 +6709,10 @@ module Aws::Lightsail
|
|
6635
6709
|
# [1]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags
|
6636
6710
|
#
|
6637
6711
|
# @option params [required, Types::PortInfo] :port_info
|
6638
|
-
# An
|
6639
|
-
# mappings.
|
6712
|
+
# An object to describe the ports to open for the specified instance.
|
6640
6713
|
#
|
6641
6714
|
# @option params [required, String] :instance_name
|
6642
|
-
# The name of the instance for which
|
6715
|
+
# The name of the instance for which to open ports.
|
6643
6716
|
#
|
6644
6717
|
# @return [Types::OpenInstancePublicPortsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6645
6718
|
#
|
@@ -6651,7 +6724,9 @@ module Aws::Lightsail
|
|
6651
6724
|
# port_info: { # required
|
6652
6725
|
# from_port: 1,
|
6653
6726
|
# to_port: 1,
|
6654
|
-
# protocol: "tcp", # accepts tcp, all, udp
|
6727
|
+
# protocol: "tcp", # accepts tcp, all, udp, icmp
|
6728
|
+
# cidrs: ["string"],
|
6729
|
+
# cidr_list_aliases: ["string"],
|
6655
6730
|
# },
|
6656
6731
|
# instance_name: "ResourceName", # required
|
6657
6732
|
# })
|
@@ -6744,9 +6819,9 @@ module Aws::Lightsail
|
|
6744
6819
|
#
|
6745
6820
|
# The following metrics are available for each resource type:
|
6746
6821
|
#
|
6747
|
-
# * **Instances**\: `
|
6748
|
-
# `
|
6749
|
-
# `StatusCheckFailed_System`.
|
6822
|
+
# * **Instances**\: `BurstCapacityPercentage`, `BurstCapacityTime`,
|
6823
|
+
# `CPUUtilization`, `NetworkIn`, `NetworkOut`, `StatusCheckFailed`,
|
6824
|
+
# `StatusCheckFailed_Instance`, and `StatusCheckFailed_System`.
|
6750
6825
|
#
|
6751
6826
|
# * **Load balancers**\: `ClientTLSNegotiationErrorCount`,
|
6752
6827
|
# `HealthyHostCount`, `UnhealthyHostCount`, `HTTPCode_LB_4XX_Count`,
|
@@ -6759,6 +6834,13 @@ module Aws::Lightsail
|
|
6759
6834
|
# `DiskQueueDepth`, `FreeStorageSpace`, `NetworkReceiveThroughput`,
|
6760
6835
|
# and `NetworkTransmitThroughput`.
|
6761
6836
|
#
|
6837
|
+
# For more information about these metrics, see [Metrics available in
|
6838
|
+
# Lightsail][1].
|
6839
|
+
#
|
6840
|
+
#
|
6841
|
+
#
|
6842
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics
|
6843
|
+
#
|
6762
6844
|
# @option params [required, String] :monitored_resource_name
|
6763
6845
|
# The name of the Lightsail resource that will be monitored.
|
6764
6846
|
#
|
@@ -6799,18 +6881,18 @@ module Aws::Lightsail
|
|
6799
6881
|
#
|
6800
6882
|
# An alarm can treat missing data in the following ways:
|
6801
6883
|
#
|
6802
|
-
# * `breaching`
|
6884
|
+
# * `breaching` - Assume the missing data is not within the threshold.
|
6803
6885
|
# Missing data counts towards the number of times the metric is not
|
6804
6886
|
# within the threshold.
|
6805
6887
|
#
|
6806
|
-
# * `notBreaching`
|
6888
|
+
# * `notBreaching` - Assume the missing data is within the threshold.
|
6807
6889
|
# Missing data does not count towards the number of times the metric
|
6808
6890
|
# is not within the threshold.
|
6809
6891
|
#
|
6810
|
-
# * `ignore`
|
6892
|
+
# * `ignore` - Ignore the missing data. Maintains the current alarm
|
6811
6893
|
# state.
|
6812
6894
|
#
|
6813
|
-
# * `missing`
|
6895
|
+
# * `missing` - Missing data is treated as missing.
|
6814
6896
|
#
|
6815
6897
|
# If `treatMissingData` is not specified, the default behavior of
|
6816
6898
|
# `missing` is used.
|
@@ -6836,13 +6918,13 @@ module Aws::Lightsail
|
|
6836
6918
|
#
|
6837
6919
|
# An alarm has the following possible states:
|
6838
6920
|
#
|
6839
|
-
# * `ALARM`
|
6921
|
+
# * `ALARM` - The metric is outside of the defined threshold.
|
6840
6922
|
#
|
6841
|
-
# * `INSUFFICIENT_DATA`
|
6923
|
+
# * `INSUFFICIENT_DATA` - The alarm has just started, the metric is not
|
6842
6924
|
# available, or not enough data is available for the metric to
|
6843
6925
|
# determine the alarm state.
|
6844
6926
|
#
|
6845
|
-
# * `OK`
|
6927
|
+
# * `OK` - The metric is within the defined threshold.
|
6846
6928
|
#
|
6847
6929
|
# When you specify a notification trigger, the `ALARM` state must be
|
6848
6930
|
# specified. The `INSUFFICIENT_DATA` and `OK` states can be specified in
|
@@ -6874,7 +6956,7 @@ module Aws::Lightsail
|
|
6874
6956
|
#
|
6875
6957
|
# resp = client.put_alarm({
|
6876
6958
|
# alarm_name: "ResourceName", # required
|
6877
|
-
# metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput
|
6959
|
+
# metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput, BurstCapacityTime, BurstCapacityPercentage
|
6878
6960
|
# monitored_resource_name: "ResourceName", # required
|
6879
6961
|
# comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
|
6880
6962
|
# threshold: 1.0, # required
|
@@ -6912,13 +6994,17 @@ module Aws::Lightsail
|
|
6912
6994
|
req.send_request(options)
|
6913
6995
|
end
|
6914
6996
|
|
6915
|
-
#
|
6916
|
-
#
|
6917
|
-
#
|
6918
|
-
#
|
6919
|
-
#
|
6920
|
-
#
|
6921
|
-
#
|
6997
|
+
# Opens ports for a specific Amazon Lightsail instance, and specifies
|
6998
|
+
# the IP addresses allowed to connect to the instance through the ports,
|
6999
|
+
# and the protocol. This action also closes all currently open ports
|
7000
|
+
# that are not included in the request. Include all of the ports and the
|
7001
|
+
# protocols you want to open in your `PutInstancePublicPorts`request. Or
|
7002
|
+
# use the `OpenInstancePublicPorts` action to open ports without closing
|
7003
|
+
# currently open ports.
|
7004
|
+
#
|
7005
|
+
# The `PutInstancePublicPorts` action supports tag-based access control
|
7006
|
+
# via resource tags applied to the resource identified by
|
7007
|
+
# `instanceName`. For more information, see the [Lightsail Dev
|
6922
7008
|
# Guide][1].
|
6923
7009
|
#
|
6924
7010
|
#
|
@@ -6926,10 +7012,11 @@ module Aws::Lightsail
|
|
6926
7012
|
# [1]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags
|
6927
7013
|
#
|
6928
7014
|
# @option params [required, Array<Types::PortInfo>] :port_infos
|
6929
|
-
#
|
7015
|
+
# An array of objects to describe the ports to open for the specified
|
7016
|
+
# instance.
|
6930
7017
|
#
|
6931
7018
|
# @option params [required, String] :instance_name
|
6932
|
-
# The
|
7019
|
+
# The name of the instance for which to open ports.
|
6933
7020
|
#
|
6934
7021
|
# @return [Types::PutInstancePublicPortsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6935
7022
|
#
|
@@ -6942,7 +7029,9 @@ module Aws::Lightsail
|
|
6942
7029
|
# {
|
6943
7030
|
# from_port: 1,
|
6944
7031
|
# to_port: 1,
|
6945
|
-
# protocol: "tcp", # accepts tcp, all, udp
|
7032
|
+
# protocol: "tcp", # accepts tcp, all, udp, icmp
|
7033
|
+
# cidrs: ["string"],
|
7034
|
+
# cidr_list_aliases: ["string"],
|
6946
7035
|
# },
|
6947
7036
|
# ],
|
6948
7037
|
# instance_name: "ResourceName", # required
|
@@ -7113,8 +7202,9 @@ module Aws::Lightsail
|
|
7113
7202
|
req.send_request(options)
|
7114
7203
|
end
|
7115
7204
|
|
7116
|
-
# Sends a verification request to an email contact method to ensure
|
7117
|
-
# owned by the requester. SMS contact methods don
|
7205
|
+
# Sends a verification request to an email contact method to ensure
|
7206
|
+
# it's owned by the requester. SMS contact methods don't need to be
|
7207
|
+
# verified.
|
7118
7208
|
#
|
7119
7209
|
# A contact method is used to send you notifications about your Amazon
|
7120
7210
|
# Lightsail resources. You can add one email address and one mobile
|
@@ -7495,13 +7585,13 @@ module Aws::Lightsail
|
|
7495
7585
|
#
|
7496
7586
|
# An alarm has the following possible states that can be tested:
|
7497
7587
|
#
|
7498
|
-
# * `ALARM`
|
7588
|
+
# * `ALARM` - The metric is outside of the defined threshold.
|
7499
7589
|
#
|
7500
|
-
# * `INSUFFICIENT_DATA`
|
7590
|
+
# * `INSUFFICIENT_DATA` - The alarm has just started, the metric is not
|
7501
7591
|
# available, or not enough data is available for the metric to
|
7502
7592
|
# determine the alarm state.
|
7503
7593
|
#
|
7504
|
-
# * `OK`
|
7594
|
+
# * `OK` - The metric is within the defined threshold.
|
7505
7595
|
#
|
7506
7596
|
# @return [Types::TestAlarmResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7507
7597
|
#
|
@@ -7988,7 +8078,7 @@ module Aws::Lightsail
|
|
7988
8078
|
params: params,
|
7989
8079
|
config: config)
|
7990
8080
|
context[:gem_name] = 'aws-sdk-lightsail'
|
7991
|
-
context[:gem_version] = '1.
|
8081
|
+
context[:gem_version] = '1.34.0'
|
7992
8082
|
Seahorse::Client::Request.new(handlers, context)
|
7993
8083
|
end
|
7994
8084
|
|