aws-sdk-lightsail 1.27.0 → 1.32.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-lightsail.rb +7 -4
- data/lib/aws-sdk-lightsail/client.rb +1415 -329
- data/lib/aws-sdk-lightsail/client_api.rb +257 -0
- data/lib/aws-sdk-lightsail/errors.rb +29 -7
- data/lib/aws-sdk-lightsail/resource.rb +1 -0
- data/lib/aws-sdk-lightsail/types.rb +1895 -398
- metadata +3 -3
@@ -6,6 +6,35 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::Lightsail
|
9
|
+
|
10
|
+
# When Lightsail returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::Lightsail::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all Lightsail errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::Lightsail::Errors::ServiceError
|
18
|
+
# # rescues all Lightsail API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {AccessDeniedException}
|
29
|
+
# * {AccountSetupInProgressException}
|
30
|
+
# * {InvalidInputException}
|
31
|
+
# * {NotFoundException}
|
32
|
+
# * {OperationFailureException}
|
33
|
+
# * {ServiceException}
|
34
|
+
# * {UnauthenticatedException}
|
35
|
+
#
|
36
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
37
|
+
# if they are not defined above.
|
9
38
|
module Errors
|
10
39
|
|
11
40
|
extend Aws::Errors::DynamicErrors
|
@@ -38,7 +67,6 @@ module Aws::Lightsail
|
|
38
67
|
def tip
|
39
68
|
@data[:tip]
|
40
69
|
end
|
41
|
-
|
42
70
|
end
|
43
71
|
|
44
72
|
class AccountSetupInProgressException < ServiceError
|
@@ -69,7 +97,6 @@ module Aws::Lightsail
|
|
69
97
|
def tip
|
70
98
|
@data[:tip]
|
71
99
|
end
|
72
|
-
|
73
100
|
end
|
74
101
|
|
75
102
|
class InvalidInputException < ServiceError
|
@@ -100,7 +127,6 @@ module Aws::Lightsail
|
|
100
127
|
def tip
|
101
128
|
@data[:tip]
|
102
129
|
end
|
103
|
-
|
104
130
|
end
|
105
131
|
|
106
132
|
class NotFoundException < ServiceError
|
@@ -131,7 +157,6 @@ module Aws::Lightsail
|
|
131
157
|
def tip
|
132
158
|
@data[:tip]
|
133
159
|
end
|
134
|
-
|
135
160
|
end
|
136
161
|
|
137
162
|
class OperationFailureException < ServiceError
|
@@ -162,7 +187,6 @@ module Aws::Lightsail
|
|
162
187
|
def tip
|
163
188
|
@data[:tip]
|
164
189
|
end
|
165
|
-
|
166
190
|
end
|
167
191
|
|
168
192
|
class ServiceException < ServiceError
|
@@ -193,7 +217,6 @@ module Aws::Lightsail
|
|
193
217
|
def tip
|
194
218
|
@data[:tip]
|
195
219
|
end
|
196
|
-
|
197
220
|
end
|
198
221
|
|
199
222
|
class UnauthenticatedException < ServiceError
|
@@ -224,7 +247,6 @@ module Aws::Lightsail
|
|
224
247
|
def tip
|
225
248
|
@data[:tip]
|
226
249
|
end
|
227
|
-
|
228
250
|
end
|
229
251
|
|
230
252
|
end
|
@@ -137,6 +137,177 @@ module Aws::Lightsail
|
|
137
137
|
include Aws::Structure
|
138
138
|
end
|
139
139
|
|
140
|
+
# Describes an alarm.
|
141
|
+
#
|
142
|
+
# An alarm is a way to monitor your Amazon Lightsail resource metrics.
|
143
|
+
# For more information, see [Alarms in Amazon Lightsail][1].
|
144
|
+
#
|
145
|
+
#
|
146
|
+
#
|
147
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms
|
148
|
+
#
|
149
|
+
# @!attribute [rw] name
|
150
|
+
# The name of the alarm.
|
151
|
+
# @return [String]
|
152
|
+
#
|
153
|
+
# @!attribute [rw] arn
|
154
|
+
# The Amazon Resource Name (ARN) of the alarm.
|
155
|
+
# @return [String]
|
156
|
+
#
|
157
|
+
# @!attribute [rw] created_at
|
158
|
+
# The timestamp when the alarm was created.
|
159
|
+
# @return [Time]
|
160
|
+
#
|
161
|
+
# @!attribute [rw] location
|
162
|
+
# An object that lists information about the location of the alarm.
|
163
|
+
# @return [Types::ResourceLocation]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] resource_type
|
166
|
+
# The Lightsail resource type (e.g., `Alarm`).
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] support_code
|
170
|
+
# The support code. Include this code in your email to support when
|
171
|
+
# you have questions about your Lightsail alarm. This code enables our
|
172
|
+
# support team to look up your Lightsail information more easily.
|
173
|
+
# @return [String]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] monitored_resource_info
|
176
|
+
# An object that lists information about the resource monitored by the
|
177
|
+
# alarm.
|
178
|
+
# @return [Types::MonitoredResourceInfo]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] comparison_operator
|
181
|
+
# The arithmetic operation used when comparing the specified statistic
|
182
|
+
# and threshold.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] evaluation_periods
|
186
|
+
# The number of periods over which data is compared to the specified
|
187
|
+
# threshold.
|
188
|
+
# @return [Integer]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] period
|
191
|
+
# The period, in seconds, over which the statistic is applied.
|
192
|
+
# @return [Integer]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] threshold
|
195
|
+
# The value against which the specified statistic is compared.
|
196
|
+
# @return [Float]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] datapoints_to_alarm
|
199
|
+
# The number of data points that must not within the specified
|
200
|
+
# threshold to trigger the alarm.
|
201
|
+
# @return [Integer]
|
202
|
+
#
|
203
|
+
# @!attribute [rw] treat_missing_data
|
204
|
+
# Specifies how the alarm handles missing data points.
|
205
|
+
#
|
206
|
+
# An alarm can treat missing data in the following ways:
|
207
|
+
#
|
208
|
+
# * `breaching` - Assume the missing data is not within the threshold.
|
209
|
+
# Missing data counts towards the number of times the metric is not
|
210
|
+
# within the threshold.
|
211
|
+
#
|
212
|
+
# * `notBreaching` - Assume the missing data is within the threshold.
|
213
|
+
# Missing data does not count towards the number of times the metric
|
214
|
+
# is not within the threshold.
|
215
|
+
#
|
216
|
+
# * `ignore` - Ignore the missing data. Maintains the current alarm
|
217
|
+
# state.
|
218
|
+
#
|
219
|
+
# * `missing` - Missing data is treated as missing.
|
220
|
+
# @return [String]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] statistic
|
223
|
+
# The statistic for the metric associated with the alarm.
|
224
|
+
#
|
225
|
+
# The following statistics are available:
|
226
|
+
#
|
227
|
+
# * `Minimum` - The lowest value observed during the specified period.
|
228
|
+
# Use this value to determine low volumes of activity for your
|
229
|
+
# application.
|
230
|
+
#
|
231
|
+
# * `Maximum` - The highest value observed during the specified
|
232
|
+
# period. Use this value to determine high volumes of activity for
|
233
|
+
# your application.
|
234
|
+
#
|
235
|
+
# * `Sum` - All values submitted for the matching metric added
|
236
|
+
# together. You can use this statistic to determine the total volume
|
237
|
+
# of a metric.
|
238
|
+
#
|
239
|
+
# * `Average` - The value of Sum / SampleCount during the specified
|
240
|
+
# period. By comparing this statistic with the Minimum and Maximum
|
241
|
+
# values, you can determine the full scope of a metric and how close
|
242
|
+
# the average use is to the Minimum and Maximum values. This
|
243
|
+
# comparison helps you to know when to increase or decrease your
|
244
|
+
# resources.
|
245
|
+
#
|
246
|
+
# * `SampleCount` - The count, or number, of data points used for the
|
247
|
+
# statistical calculation.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] metric_name
|
251
|
+
# The name of the metric associated with the alarm.
|
252
|
+
# @return [String]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] state
|
255
|
+
# The current state of the alarm.
|
256
|
+
#
|
257
|
+
# An alarm has the following possible states:
|
258
|
+
#
|
259
|
+
# * `ALARM` - The metric is outside of the defined threshold.
|
260
|
+
#
|
261
|
+
# * `INSUFFICIENT_DATA` - The alarm has just started, the metric is
|
262
|
+
# not available, or not enough data is available for the metric to
|
263
|
+
# determine the alarm state.
|
264
|
+
#
|
265
|
+
# * `OK` - The metric is within the defined threshold.
|
266
|
+
# @return [String]
|
267
|
+
#
|
268
|
+
# @!attribute [rw] unit
|
269
|
+
# The unit of the metric associated with the alarm.
|
270
|
+
# @return [String]
|
271
|
+
#
|
272
|
+
# @!attribute [rw] contact_protocols
|
273
|
+
# The contact protocols for the alarm, such as `Email`, `SMS` (text
|
274
|
+
# messaging), or both.
|
275
|
+
# @return [Array<String>]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] notification_triggers
|
278
|
+
# The alarm states that trigger a notification.
|
279
|
+
# @return [Array<String>]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] notification_enabled
|
282
|
+
# Indicates whether the alarm is enabled.
|
283
|
+
# @return [Boolean]
|
284
|
+
#
|
285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Alarm AWS API Documentation
|
286
|
+
#
|
287
|
+
class Alarm < Struct.new(
|
288
|
+
:name,
|
289
|
+
:arn,
|
290
|
+
:created_at,
|
291
|
+
:location,
|
292
|
+
:resource_type,
|
293
|
+
:support_code,
|
294
|
+
:monitored_resource_info,
|
295
|
+
:comparison_operator,
|
296
|
+
:evaluation_periods,
|
297
|
+
:period,
|
298
|
+
:threshold,
|
299
|
+
:datapoints_to_alarm,
|
300
|
+
:treat_missing_data,
|
301
|
+
:statistic,
|
302
|
+
:metric_name,
|
303
|
+
:state,
|
304
|
+
:unit,
|
305
|
+
:contact_protocols,
|
306
|
+
:notification_triggers,
|
307
|
+
:notification_enabled)
|
308
|
+
include Aws::Structure
|
309
|
+
end
|
310
|
+
|
140
311
|
# @note When making an API call, you may pass AllocateStaticIpRequest
|
141
312
|
# data as a hash:
|
142
313
|
#
|
@@ -156,8 +327,9 @@ module Aws::Lightsail
|
|
156
327
|
end
|
157
328
|
|
158
329
|
# @!attribute [rw] operations
|
159
|
-
# An array of
|
160
|
-
#
|
330
|
+
# An array of objects that describe the result of the action, such as
|
331
|
+
# the status of the request, the timestamp of the request, and the
|
332
|
+
# resources affected by the request.
|
161
333
|
# @return [Array<Types::Operation>]
|
162
334
|
#
|
163
335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AllocateStaticIpResult AWS API Documentation
|
@@ -199,7 +371,9 @@ module Aws::Lightsail
|
|
199
371
|
end
|
200
372
|
|
201
373
|
# @!attribute [rw] operations
|
202
|
-
# An
|
374
|
+
# An array of objects that describe the result of the action, such as
|
375
|
+
# the status of the request, the timestamp of the request, and the
|
376
|
+
# resources affected by the request.
|
203
377
|
# @return [Array<Types::Operation>]
|
204
378
|
#
|
205
379
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDiskResult AWS API Documentation
|
@@ -242,7 +416,9 @@ module Aws::Lightsail
|
|
242
416
|
end
|
243
417
|
|
244
418
|
# @!attribute [rw] operations
|
245
|
-
# An
|
419
|
+
# An array of objects that describe the result of the action, such as
|
420
|
+
# the status of the request, the timestamp of the request, and the
|
421
|
+
# resources affected by the request.
|
246
422
|
# @return [Array<Types::Operation>]
|
247
423
|
#
|
248
424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancerResult AWS API Documentation
|
@@ -278,7 +454,9 @@ module Aws::Lightsail
|
|
278
454
|
end
|
279
455
|
|
280
456
|
# @!attribute [rw] operations
|
281
|
-
# An
|
457
|
+
# An array of objects that describe the result of the action, such as
|
458
|
+
# the status of the request, the timestamp of the request, and the
|
459
|
+
# resources affected by the request.
|
282
460
|
#
|
283
461
|
# These SSL/TLS certificates are only usable by Lightsail load
|
284
462
|
# balancers. You can't get the certificate and use it for another
|
@@ -317,8 +495,9 @@ module Aws::Lightsail
|
|
317
495
|
end
|
318
496
|
|
319
497
|
# @!attribute [rw] operations
|
320
|
-
# An array of
|
321
|
-
#
|
498
|
+
# An array of objects that describe the result of the action, such as
|
499
|
+
# the status of the request, the timestamp of the request, and the
|
500
|
+
# resources affected by the request.
|
322
501
|
# @return [Array<Types::Operation>]
|
323
502
|
#
|
324
503
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachStaticIpResult AWS API Documentation
|
@@ -539,7 +718,7 @@ module Aws::Lightsail
|
|
539
718
|
# private server (or *instance*).
|
540
719
|
#
|
541
720
|
# @!attribute [rw] price
|
542
|
-
# The price in US dollars (e.g., `5.0`).
|
721
|
+
# The price in US dollars (e.g., `5.0`) of the bundle.
|
543
722
|
# @return [Float]
|
544
723
|
#
|
545
724
|
# @!attribute [rw] cpu_count
|
@@ -614,18 +793,19 @@ module Aws::Lightsail
|
|
614
793
|
# port_info: { # required
|
615
794
|
# from_port: 1,
|
616
795
|
# to_port: 1,
|
617
|
-
# protocol: "tcp", # accepts tcp, all, udp
|
796
|
+
# protocol: "tcp", # accepts tcp, all, udp, icmp
|
797
|
+
# cidrs: ["string"],
|
798
|
+
# cidr_list_aliases: ["string"],
|
618
799
|
# },
|
619
800
|
# instance_name: "ResourceName", # required
|
620
801
|
# }
|
621
802
|
#
|
622
803
|
# @!attribute [rw] port_info
|
623
|
-
#
|
804
|
+
# An object to describe the ports to close for the specified instance.
|
624
805
|
# @return [Types::PortInfo]
|
625
806
|
#
|
626
807
|
# @!attribute [rw] instance_name
|
627
|
-
# The name of the instance
|
628
|
-
# public ports.
|
808
|
+
# The name of the instance for which to close ports.
|
629
809
|
# @return [String]
|
630
810
|
#
|
631
811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloseInstancePublicPortsRequest AWS API Documentation
|
@@ -637,8 +817,9 @@ module Aws::Lightsail
|
|
637
817
|
end
|
638
818
|
|
639
819
|
# @!attribute [rw] operation
|
640
|
-
# An
|
641
|
-
#
|
820
|
+
# An object that describes the result of the action, such as the
|
821
|
+
# status of the request, the timestamp of the request, and the
|
822
|
+
# resources affected by the request.
|
642
823
|
# @return [Types::Operation]
|
643
824
|
#
|
644
825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CloseInstancePublicPortsResult AWS API Documentation
|
@@ -730,6 +911,81 @@ module Aws::Lightsail
|
|
730
911
|
include Aws::Structure
|
731
912
|
end
|
732
913
|
|
914
|
+
# Describes a contact method.
|
915
|
+
#
|
916
|
+
# A contact method is a way to send you notifications. For more
|
917
|
+
# information, see [Notifications in Amazon Lightsail][1].
|
918
|
+
#
|
919
|
+
#
|
920
|
+
#
|
921
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications
|
922
|
+
#
|
923
|
+
# @!attribute [rw] contact_endpoint
|
924
|
+
# The destination of the contact method, such as an email address or a
|
925
|
+
# mobile phone number.
|
926
|
+
# @return [String]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] status
|
929
|
+
# The current status of the contact method.
|
930
|
+
#
|
931
|
+
# A contact method has the following possible status:
|
932
|
+
#
|
933
|
+
# * `PendingVerification` - The contact method has not yet been
|
934
|
+
# verified, and the verification has not yet expired.
|
935
|
+
#
|
936
|
+
# * `Valid` - The contact method has been verified.
|
937
|
+
#
|
938
|
+
# * `InValid` - An attempt was made to verify the contact method, but
|
939
|
+
# the verification has expired.
|
940
|
+
# @return [String]
|
941
|
+
#
|
942
|
+
# @!attribute [rw] protocol
|
943
|
+
# The protocol of the contact method, such as email or SMS (text
|
944
|
+
# messaging).
|
945
|
+
# @return [String]
|
946
|
+
#
|
947
|
+
# @!attribute [rw] name
|
948
|
+
# The name of the contact method.
|
949
|
+
# @return [String]
|
950
|
+
#
|
951
|
+
# @!attribute [rw] arn
|
952
|
+
# The Amazon Resource Name (ARN) of the contact method.
|
953
|
+
# @return [String]
|
954
|
+
#
|
955
|
+
# @!attribute [rw] created_at
|
956
|
+
# The timestamp when the contact method was created.
|
957
|
+
# @return [Time]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] location
|
960
|
+
# Describes the resource location.
|
961
|
+
# @return [Types::ResourceLocation]
|
962
|
+
#
|
963
|
+
# @!attribute [rw] resource_type
|
964
|
+
# The Lightsail resource type (e.g., `ContactMethod`).
|
965
|
+
# @return [String]
|
966
|
+
#
|
967
|
+
# @!attribute [rw] support_code
|
968
|
+
# The support code. Include this code in your email to support when
|
969
|
+
# you have questions about your Lightsail contact method. This code
|
970
|
+
# enables our support team to look up your Lightsail information more
|
971
|
+
# easily.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContactMethod AWS API Documentation
|
975
|
+
#
|
976
|
+
class ContactMethod < Struct.new(
|
977
|
+
:contact_endpoint,
|
978
|
+
:status,
|
979
|
+
:protocol,
|
980
|
+
:name,
|
981
|
+
:arn,
|
982
|
+
:created_at,
|
983
|
+
:location,
|
984
|
+
:resource_type,
|
985
|
+
:support_code)
|
986
|
+
include Aws::Structure
|
987
|
+
end
|
988
|
+
|
733
989
|
# @note When making an API call, you may pass CopySnapshotRequest
|
734
990
|
# data as a hash:
|
735
991
|
#
|
@@ -834,7 +1090,9 @@ module Aws::Lightsail
|
|
834
1090
|
end
|
835
1091
|
|
836
1092
|
# @!attribute [rw] operations
|
837
|
-
#
|
1093
|
+
# An array of objects that describe the result of the action, such as
|
1094
|
+
# the status of the request, the timestamp of the request, and the
|
1095
|
+
# resources affected by the request.
|
838
1096
|
# @return [Array<Types::Operation>]
|
839
1097
|
#
|
840
1098
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CopySnapshotResult AWS API Documentation
|
@@ -874,7 +1132,9 @@ module Aws::Lightsail
|
|
874
1132
|
end
|
875
1133
|
|
876
1134
|
# @!attribute [rw] operations
|
877
|
-
#
|
1135
|
+
# An array of objects that describe the result of the action, such as
|
1136
|
+
# the status of the request, the timestamp of the request, and the
|
1137
|
+
# resources affected by the request.
|
878
1138
|
# @return [Array<Types::Operation>]
|
879
1139
|
#
|
880
1140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateCloudFormationStackResult AWS API Documentation
|
@@ -884,6 +1144,84 @@ module Aws::Lightsail
|
|
884
1144
|
include Aws::Structure
|
885
1145
|
end
|
886
1146
|
|
1147
|
+
# @note When making an API call, you may pass CreateContactMethodRequest
|
1148
|
+
# data as a hash:
|
1149
|
+
#
|
1150
|
+
# {
|
1151
|
+
# protocol: "Email", # required, accepts Email, SMS
|
1152
|
+
# contact_endpoint: "StringMax256", # required
|
1153
|
+
# }
|
1154
|
+
#
|
1155
|
+
# @!attribute [rw] protocol
|
1156
|
+
# The protocol of the contact method, such as `Email` or `SMS` (text
|
1157
|
+
# messaging).
|
1158
|
+
#
|
1159
|
+
# The `SMS` protocol is supported only in the following AWS Regions.
|
1160
|
+
#
|
1161
|
+
# * US East (N. Virginia) (`us-east-1`)
|
1162
|
+
#
|
1163
|
+
# * US West (Oregon) (`us-west-2`)
|
1164
|
+
#
|
1165
|
+
# * Europe (Ireland) (`eu-west-1`)
|
1166
|
+
#
|
1167
|
+
# * Asia Pacific (Tokyo) (`ap-northeast-1`)
|
1168
|
+
#
|
1169
|
+
# * Asia Pacific (Singapore) (`ap-southeast-1`)
|
1170
|
+
#
|
1171
|
+
# * Asia Pacific (Sydney) (`ap-southeast-2`)
|
1172
|
+
#
|
1173
|
+
# For a list of countries/regions where SMS text messages can be sent,
|
1174
|
+
# and the latest AWS Regions where SMS text messaging is supported,
|
1175
|
+
# see [Supported Regions and Countries][1] in the *Amazon SNS
|
1176
|
+
# Developer Guide*.
|
1177
|
+
#
|
1178
|
+
# For more information about notifications in Amazon Lightsail, see
|
1179
|
+
# [Notifications in Amazon Lightsail][2].
|
1180
|
+
#
|
1181
|
+
#
|
1182
|
+
#
|
1183
|
+
# [1]: https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html
|
1184
|
+
# [2]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications
|
1185
|
+
# @return [String]
|
1186
|
+
#
|
1187
|
+
# @!attribute [rw] contact_endpoint
|
1188
|
+
# The destination of the contact method, such as an email address or a
|
1189
|
+
# mobile phone number.
|
1190
|
+
#
|
1191
|
+
# Use the E.164 format when specifying a mobile phone number. E.164 is
|
1192
|
+
# a standard for the phone number structure used for international
|
1193
|
+
# telecommunication. Phone numbers that follow this format can have a
|
1194
|
+
# maximum of 15 digits, and they are prefixed with the plus character
|
1195
|
+
# (+) and the country code. For example, a U.S. phone number in E.164
|
1196
|
+
# format would be specified as +1XXX5550100. For more information, see
|
1197
|
+
# [E.164][1] on *Wikipedia*.
|
1198
|
+
#
|
1199
|
+
#
|
1200
|
+
#
|
1201
|
+
# [1]: https://en.wikipedia.org/wiki/E.164
|
1202
|
+
# @return [String]
|
1203
|
+
#
|
1204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContactMethodRequest AWS API Documentation
|
1205
|
+
#
|
1206
|
+
class CreateContactMethodRequest < Struct.new(
|
1207
|
+
:protocol,
|
1208
|
+
:contact_endpoint)
|
1209
|
+
include Aws::Structure
|
1210
|
+
end
|
1211
|
+
|
1212
|
+
# @!attribute [rw] operations
|
1213
|
+
# An array of objects that describe the result of the action, such as
|
1214
|
+
# the status of the request, the timestamp of the request, and the
|
1215
|
+
# resources affected by the request.
|
1216
|
+
# @return [Array<Types::Operation>]
|
1217
|
+
#
|
1218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateContactMethodResult AWS API Documentation
|
1219
|
+
#
|
1220
|
+
class CreateContactMethodResult < Struct.new(
|
1221
|
+
:operations)
|
1222
|
+
include Aws::Structure
|
1223
|
+
end
|
1224
|
+
|
887
1225
|
# @note When making an API call, you may pass CreateDiskFromSnapshotRequest
|
888
1226
|
# data as a hash:
|
889
1227
|
#
|
@@ -1031,7 +1369,9 @@ module Aws::Lightsail
|
|
1031
1369
|
end
|
1032
1370
|
|
1033
1371
|
# @!attribute [rw] operations
|
1034
|
-
# An
|
1372
|
+
# An array of objects that describe the result of the action, such as
|
1373
|
+
# the status of the request, the timestamp of the request, and the
|
1374
|
+
# resources affected by the request.
|
1035
1375
|
# @return [Array<Types::Operation>]
|
1036
1376
|
#
|
1037
1377
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskFromSnapshotResult AWS API Documentation
|
@@ -1106,7 +1446,9 @@ module Aws::Lightsail
|
|
1106
1446
|
end
|
1107
1447
|
|
1108
1448
|
# @!attribute [rw] operations
|
1109
|
-
# An
|
1449
|
+
# An array of objects that describe the result of the action, such as
|
1450
|
+
# the status of the request, the timestamp of the request, and the
|
1451
|
+
# resources affected by the request.
|
1110
1452
|
# @return [Array<Types::Operation>]
|
1111
1453
|
#
|
1112
1454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskResult AWS API Documentation
|
@@ -1177,7 +1519,9 @@ module Aws::Lightsail
|
|
1177
1519
|
end
|
1178
1520
|
|
1179
1521
|
# @!attribute [rw] operations
|
1180
|
-
# An
|
1522
|
+
# An array of objects that describe the result of the action, such as
|
1523
|
+
# the status of the request, the timestamp of the request, and the
|
1524
|
+
# resources affected by the request.
|
1181
1525
|
# @return [Array<Types::Operation>]
|
1182
1526
|
#
|
1183
1527
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDiskSnapshotResult AWS API Documentation
|
@@ -1223,8 +1567,9 @@ module Aws::Lightsail
|
|
1223
1567
|
end
|
1224
1568
|
|
1225
1569
|
# @!attribute [rw] operation
|
1226
|
-
# An array of
|
1227
|
-
#
|
1570
|
+
# An array of objects that describe the result of the action, such as
|
1571
|
+
# the status of the request, the timestamp of the request, and the
|
1572
|
+
# resources affected by the request.
|
1228
1573
|
# @return [Types::Operation]
|
1229
1574
|
#
|
1230
1575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainEntryResult AWS API Documentation
|
@@ -1276,8 +1621,9 @@ module Aws::Lightsail
|
|
1276
1621
|
end
|
1277
1622
|
|
1278
1623
|
# @!attribute [rw] operation
|
1279
|
-
# An array of
|
1280
|
-
#
|
1624
|
+
# An array of objects that describe the result of the action, such as
|
1625
|
+
# the status of the request, the timestamp of the request, and the
|
1626
|
+
# resources affected by the request.
|
1281
1627
|
# @return [Types::Operation]
|
1282
1628
|
#
|
1283
1629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateDomainResult AWS API Documentation
|
@@ -1327,8 +1673,9 @@ module Aws::Lightsail
|
|
1327
1673
|
end
|
1328
1674
|
|
1329
1675
|
# @!attribute [rw] operations
|
1330
|
-
# An array of
|
1331
|
-
# of
|
1676
|
+
# An array of objects that describe the result of the action, such as
|
1677
|
+
# the status of the request, the timestamp of the request, and the
|
1678
|
+
# resources affected by the request.
|
1332
1679
|
# @return [Array<Types::Operation>]
|
1333
1680
|
#
|
1334
1681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstanceSnapshotResult AWS API Documentation
|
@@ -1528,8 +1875,9 @@ module Aws::Lightsail
|
|
1528
1875
|
end
|
1529
1876
|
|
1530
1877
|
# @!attribute [rw] operations
|
1531
|
-
# An array of
|
1532
|
-
# of
|
1878
|
+
# An array of objects that describe the result of the action, such as
|
1879
|
+
# the status of the request, the timestamp of the request, and the
|
1880
|
+
# resources affected by the request.
|
1533
1881
|
# @return [Array<Types::Operation>]
|
1534
1882
|
#
|
1535
1883
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesFromSnapshotResult AWS API Documentation
|
@@ -1663,8 +2011,9 @@ module Aws::Lightsail
|
|
1663
2011
|
end
|
1664
2012
|
|
1665
2013
|
# @!attribute [rw] operations
|
1666
|
-
# An array of
|
1667
|
-
# of
|
2014
|
+
# An array of objects that describe the result of the action, such as
|
2015
|
+
# the status of the request, the timestamp of the request, and the
|
2016
|
+
# resources affected by the request.
|
1668
2017
|
# @return [Array<Types::Operation>]
|
1669
2018
|
#
|
1670
2019
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateInstancesResult AWS API Documentation
|
@@ -1721,8 +2070,9 @@ module Aws::Lightsail
|
|
1721
2070
|
# @return [String]
|
1722
2071
|
#
|
1723
2072
|
# @!attribute [rw] operation
|
1724
|
-
# An array of
|
1725
|
-
# of
|
2073
|
+
# An array of objects that describe the result of the action, such as
|
2074
|
+
# the status of the request, the timestamp of the request, and the
|
2075
|
+
# resources affected by the request.
|
1726
2076
|
# @return [Types::Operation]
|
1727
2077
|
#
|
1728
2078
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateKeyPairResult AWS API Documentation
|
@@ -1814,7 +2164,9 @@ module Aws::Lightsail
|
|
1814
2164
|
end
|
1815
2165
|
|
1816
2166
|
# @!attribute [rw] operations
|
1817
|
-
# An
|
2167
|
+
# An array of objects that describe the result of the action, such as
|
2168
|
+
# the status of the request, the timestamp of the request, and the
|
2169
|
+
# resources affected by the request.
|
1818
2170
|
# @return [Array<Types::Operation>]
|
1819
2171
|
#
|
1820
2172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerResult AWS API Documentation
|
@@ -1891,7 +2243,9 @@ module Aws::Lightsail
|
|
1891
2243
|
end
|
1892
2244
|
|
1893
2245
|
# @!attribute [rw] operations
|
1894
|
-
# An
|
2246
|
+
# An array of objects that describe the result of the action, such as
|
2247
|
+
# the status of the request, the timestamp of the request, and the
|
2248
|
+
# resources affected by the request.
|
1895
2249
|
# @return [Array<Types::Operation>]
|
1896
2250
|
#
|
1897
2251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificateResult AWS API Documentation
|
@@ -2020,8 +2374,9 @@ module Aws::Lightsail
|
|
2020
2374
|
end
|
2021
2375
|
|
2022
2376
|
# @!attribute [rw] operations
|
2023
|
-
# An
|
2024
|
-
#
|
2377
|
+
# An array of objects that describe the result of the action, such as
|
2378
|
+
# the status of the request, the timestamp of the request, and the
|
2379
|
+
# resources affected by the request.
|
2025
2380
|
# @return [Array<Types::Operation>]
|
2026
2381
|
#
|
2027
2382
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshotResult AWS API Documentation
|
@@ -2212,8 +2567,9 @@ module Aws::Lightsail
|
|
2212
2567
|
end
|
2213
2568
|
|
2214
2569
|
# @!attribute [rw] operations
|
2215
|
-
# An
|
2216
|
-
# request
|
2570
|
+
# An array of objects that describe the result of the action, such as
|
2571
|
+
# the status of the request, the timestamp of the request, and the
|
2572
|
+
# resources affected by the request.
|
2217
2573
|
# @return [Array<Types::Operation>]
|
2218
2574
|
#
|
2219
2575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseResult AWS API Documentation
|
@@ -2269,8 +2625,9 @@ module Aws::Lightsail
|
|
2269
2625
|
end
|
2270
2626
|
|
2271
2627
|
# @!attribute [rw] operations
|
2272
|
-
# An
|
2273
|
-
#
|
2628
|
+
# An array of objects that describe the result of the action, such as
|
2629
|
+
# the status of the request, the timestamp of the request, and the
|
2630
|
+
# resources affected by the request.
|
2274
2631
|
# @return [Array<Types::Operation>]
|
2275
2632
|
#
|
2276
2633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshotResult AWS API Documentation
|
@@ -2280,6 +2637,37 @@ module Aws::Lightsail
|
|
2280
2637
|
include Aws::Structure
|
2281
2638
|
end
|
2282
2639
|
|
2640
|
+
# @note When making an API call, you may pass DeleteAlarmRequest
|
2641
|
+
# data as a hash:
|
2642
|
+
#
|
2643
|
+
# {
|
2644
|
+
# alarm_name: "ResourceName", # required
|
2645
|
+
# }
|
2646
|
+
#
|
2647
|
+
# @!attribute [rw] alarm_name
|
2648
|
+
# The name of the alarm to delete.
|
2649
|
+
# @return [String]
|
2650
|
+
#
|
2651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteAlarmRequest AWS API Documentation
|
2652
|
+
#
|
2653
|
+
class DeleteAlarmRequest < Struct.new(
|
2654
|
+
:alarm_name)
|
2655
|
+
include Aws::Structure
|
2656
|
+
end
|
2657
|
+
|
2658
|
+
# @!attribute [rw] operations
|
2659
|
+
# An array of objects that describe the result of the action, such as
|
2660
|
+
# the status of the request, the timestamp of the request, and the
|
2661
|
+
# resources affected by the request.
|
2662
|
+
# @return [Array<Types::Operation>]
|
2663
|
+
#
|
2664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteAlarmResult AWS API Documentation
|
2665
|
+
#
|
2666
|
+
class DeleteAlarmResult < Struct.new(
|
2667
|
+
:operations)
|
2668
|
+
include Aws::Structure
|
2669
|
+
end
|
2670
|
+
|
2283
2671
|
# @note When making an API call, you may pass DeleteAutoSnapshotRequest
|
2284
2672
|
# data as a hash:
|
2285
2673
|
#
|
@@ -2308,7 +2696,9 @@ module Aws::Lightsail
|
|
2308
2696
|
end
|
2309
2697
|
|
2310
2698
|
# @!attribute [rw] operations
|
2311
|
-
# An array of objects that describe the result of
|
2699
|
+
# An array of objects that describe the result of the action, such as
|
2700
|
+
# the status of the request, the timestamp of the request, and the
|
2701
|
+
# resources affected by the request.
|
2312
2702
|
# @return [Array<Types::Operation>]
|
2313
2703
|
#
|
2314
2704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteAutoSnapshotResult AWS API Documentation
|
@@ -2318,6 +2708,44 @@ module Aws::Lightsail
|
|
2318
2708
|
include Aws::Structure
|
2319
2709
|
end
|
2320
2710
|
|
2711
|
+
# @note When making an API call, you may pass DeleteContactMethodRequest
|
2712
|
+
# data as a hash:
|
2713
|
+
#
|
2714
|
+
# {
|
2715
|
+
# protocol: "Email", # required, accepts Email, SMS
|
2716
|
+
# }
|
2717
|
+
#
|
2718
|
+
# @!attribute [rw] protocol
|
2719
|
+
# The protocol that will be deleted, such as `Email` or `SMS` (text
|
2720
|
+
# messaging).
|
2721
|
+
#
|
2722
|
+
# <note markdown="1"> To delete an `Email` and an `SMS` contact method if you added both,
|
2723
|
+
# you must run separate `DeleteContactMethod` actions to delete each
|
2724
|
+
# protocol.
|
2725
|
+
#
|
2726
|
+
# </note>
|
2727
|
+
# @return [String]
|
2728
|
+
#
|
2729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContactMethodRequest AWS API Documentation
|
2730
|
+
#
|
2731
|
+
class DeleteContactMethodRequest < Struct.new(
|
2732
|
+
:protocol)
|
2733
|
+
include Aws::Structure
|
2734
|
+
end
|
2735
|
+
|
2736
|
+
# @!attribute [rw] operations
|
2737
|
+
# An array of objects that describe the result of the action, such as
|
2738
|
+
# the status of the request, the timestamp of the request, and the
|
2739
|
+
# resources affected by the request.
|
2740
|
+
# @return [Array<Types::Operation>]
|
2741
|
+
#
|
2742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteContactMethodResult AWS API Documentation
|
2743
|
+
#
|
2744
|
+
class DeleteContactMethodResult < Struct.new(
|
2745
|
+
:operations)
|
2746
|
+
include Aws::Structure
|
2747
|
+
end
|
2748
|
+
|
2321
2749
|
# @note When making an API call, you may pass DeleteDiskRequest
|
2322
2750
|
# data as a hash:
|
2323
2751
|
#
|
@@ -2344,7 +2772,9 @@ module Aws::Lightsail
|
|
2344
2772
|
end
|
2345
2773
|
|
2346
2774
|
# @!attribute [rw] operations
|
2347
|
-
# An array of objects that describe the result of
|
2775
|
+
# An array of objects that describe the result of the action, such as
|
2776
|
+
# the status of the request, the timestamp of the request, and the
|
2777
|
+
# resources affected by the request.
|
2348
2778
|
# @return [Array<Types::Operation>]
|
2349
2779
|
#
|
2350
2780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskResult AWS API Documentation
|
@@ -2374,7 +2804,9 @@ module Aws::Lightsail
|
|
2374
2804
|
end
|
2375
2805
|
|
2376
2806
|
# @!attribute [rw] operations
|
2377
|
-
# An
|
2807
|
+
# An array of objects that describe the result of the action, such as
|
2808
|
+
# the status of the request, the timestamp of the request, and the
|
2809
|
+
# resources affected by the request.
|
2378
2810
|
# @return [Array<Types::Operation>]
|
2379
2811
|
#
|
2380
2812
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDiskSnapshotResult AWS API Documentation
|
@@ -2419,8 +2851,9 @@ module Aws::Lightsail
|
|
2419
2851
|
end
|
2420
2852
|
|
2421
2853
|
# @!attribute [rw] operation
|
2422
|
-
# An array of
|
2423
|
-
# of
|
2854
|
+
# An array of objects that describe the result of the action, such as
|
2855
|
+
# the status of the request, the timestamp of the request, and the
|
2856
|
+
# resources affected by the request.
|
2424
2857
|
# @return [Types::Operation]
|
2425
2858
|
#
|
2426
2859
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainEntryResult AWS API Documentation
|
@@ -2449,8 +2882,9 @@ module Aws::Lightsail
|
|
2449
2882
|
end
|
2450
2883
|
|
2451
2884
|
# @!attribute [rw] operation
|
2452
|
-
# An array of
|
2453
|
-
# of
|
2885
|
+
# An array of objects that describe the result of the action, such as
|
2886
|
+
# the status of the request, the timestamp of the request, and the
|
2887
|
+
# resources affected by the request.
|
2454
2888
|
# @return [Types::Operation]
|
2455
2889
|
#
|
2456
2890
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteDomainResult AWS API Documentation
|
@@ -2486,8 +2920,9 @@ module Aws::Lightsail
|
|
2486
2920
|
end
|
2487
2921
|
|
2488
2922
|
# @!attribute [rw] operations
|
2489
|
-
# An array of
|
2490
|
-
# of
|
2923
|
+
# An array of objects that describe the result of the action, such as
|
2924
|
+
# the status of the request, the timestamp of the request, and the
|
2925
|
+
# resources affected by the request.
|
2491
2926
|
# @return [Array<Types::Operation>]
|
2492
2927
|
#
|
2493
2928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceResult AWS API Documentation
|
@@ -2516,8 +2951,9 @@ module Aws::Lightsail
|
|
2516
2951
|
end
|
2517
2952
|
|
2518
2953
|
# @!attribute [rw] operations
|
2519
|
-
# An array of
|
2520
|
-
# of
|
2954
|
+
# An array of objects that describe the result of the action, such as
|
2955
|
+
# the status of the request, the timestamp of the request, and the
|
2956
|
+
# resources affected by the request.
|
2521
2957
|
# @return [Array<Types::Operation>]
|
2522
2958
|
#
|
2523
2959
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteInstanceSnapshotResult AWS API Documentation
|
@@ -2546,8 +2982,9 @@ module Aws::Lightsail
|
|
2546
2982
|
end
|
2547
2983
|
|
2548
2984
|
# @!attribute [rw] operation
|
2549
|
-
# An array of
|
2550
|
-
# of
|
2985
|
+
# An array of objects that describe the result of the action, such as
|
2986
|
+
# the status of the request, the timestamp of the request, and the
|
2987
|
+
# resources affected by the request.
|
2551
2988
|
# @return [Types::Operation]
|
2552
2989
|
#
|
2553
2990
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKeyPairResult AWS API Documentation
|
@@ -2577,7 +3014,9 @@ module Aws::Lightsail
|
|
2577
3014
|
end
|
2578
3015
|
|
2579
3016
|
# @!attribute [rw] operations
|
2580
|
-
#
|
3017
|
+
# An array of objects that describe the result of the action, such as
|
3018
|
+
# the status of the request, the timestamp of the request, and the
|
3019
|
+
# resources affected by the request.
|
2581
3020
|
# @return [Array<Types::Operation>]
|
2582
3021
|
#
|
2583
3022
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteKnownHostKeysResult AWS API Documentation
|
@@ -2606,7 +3045,9 @@ module Aws::Lightsail
|
|
2606
3045
|
end
|
2607
3046
|
|
2608
3047
|
# @!attribute [rw] operations
|
2609
|
-
# An
|
3048
|
+
# An array of objects that describe the result of the action, such as
|
3049
|
+
# the status of the request, the timestamp of the request, and the
|
3050
|
+
# resources affected by the request.
|
2610
3051
|
# @return [Array<Types::Operation>]
|
2611
3052
|
#
|
2612
3053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerResult AWS API Documentation
|
@@ -2652,7 +3093,9 @@ module Aws::Lightsail
|
|
2652
3093
|
end
|
2653
3094
|
|
2654
3095
|
# @!attribute [rw] operations
|
2655
|
-
# An
|
3096
|
+
# An array of objects that describe the result of the action, such as
|
3097
|
+
# the status of the request, the timestamp of the request, and the
|
3098
|
+
# resources affected by the request.
|
2656
3099
|
# @return [Array<Types::Operation>]
|
2657
3100
|
#
|
2658
3101
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificateResult AWS API Documentation
|
@@ -2713,8 +3156,9 @@ module Aws::Lightsail
|
|
2713
3156
|
end
|
2714
3157
|
|
2715
3158
|
# @!attribute [rw] operations
|
2716
|
-
# An
|
2717
|
-
# request
|
3159
|
+
# An array of objects that describe the result of the action, such as
|
3160
|
+
# the status of the request, the timestamp of the request, and the
|
3161
|
+
# resources affected by the request.
|
2718
3162
|
# @return [Array<Types::Operation>]
|
2719
3163
|
#
|
2720
3164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseResult AWS API Documentation
|
@@ -2743,8 +3187,9 @@ module Aws::Lightsail
|
|
2743
3187
|
end
|
2744
3188
|
|
2745
3189
|
# @!attribute [rw] operations
|
2746
|
-
# An
|
2747
|
-
#
|
3190
|
+
# An array of objects that describe the result of the action, such as
|
3191
|
+
# the status of the request, the timestamp of the request, and the
|
3192
|
+
# resources affected by the request.
|
2748
3193
|
# @return [Array<Types::Operation>]
|
2749
3194
|
#
|
2750
3195
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshotResult AWS API Documentation
|
@@ -2792,7 +3237,9 @@ module Aws::Lightsail
|
|
2792
3237
|
end
|
2793
3238
|
|
2794
3239
|
# @!attribute [rw] operations
|
2795
|
-
# An
|
3240
|
+
# An array of objects that describe the result of the action, such as
|
3241
|
+
# the status of the request, the timestamp of the request, and the
|
3242
|
+
# resources affected by the request.
|
2796
3243
|
# @return [Array<Types::Operation>]
|
2797
3244
|
#
|
2798
3245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachDiskResult AWS API Documentation
|
@@ -2828,7 +3275,9 @@ module Aws::Lightsail
|
|
2828
3275
|
end
|
2829
3276
|
|
2830
3277
|
# @!attribute [rw] operations
|
2831
|
-
# An
|
3278
|
+
# An array of objects that describe the result of the action, such as
|
3279
|
+
# the status of the request, the timestamp of the request, and the
|
3280
|
+
# resources affected by the request.
|
2832
3281
|
# @return [Array<Types::Operation>]
|
2833
3282
|
#
|
2834
3283
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancerResult AWS API Documentation
|
@@ -2857,8 +3306,9 @@ module Aws::Lightsail
|
|
2857
3306
|
end
|
2858
3307
|
|
2859
3308
|
# @!attribute [rw] operations
|
2860
|
-
# An array of
|
2861
|
-
# of
|
3309
|
+
# An array of objects that describe the result of the action, such as
|
3310
|
+
# the status of the request, the timestamp of the request, and the
|
3311
|
+
# resources affected by the request.
|
2862
3312
|
# @return [Array<Types::Operation>]
|
2863
3313
|
#
|
2864
3314
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachStaticIpResult AWS API Documentation
|
@@ -2893,7 +3343,9 @@ module Aws::Lightsail
|
|
2893
3343
|
end
|
2894
3344
|
|
2895
3345
|
# @!attribute [rw] operations
|
2896
|
-
# An array of objects that describe the result of
|
3346
|
+
# An array of objects that describe the result of the action, such as
|
3347
|
+
# the status of the request, the timestamp of the request, and the
|
3348
|
+
# resources affected by the request.
|
2897
3349
|
# @return [Array<Types::Operation>]
|
2898
3350
|
#
|
2899
3351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DisableAddOnResult AWS API Documentation
|
@@ -3381,7 +3833,9 @@ module Aws::Lightsail
|
|
3381
3833
|
end
|
3382
3834
|
|
3383
3835
|
# @!attribute [rw] operations
|
3384
|
-
# An array of objects that describe the result of
|
3836
|
+
# An array of objects that describe the result of the action, such as
|
3837
|
+
# the status of the request, the timestamp of the request, and the
|
3838
|
+
# resources affected by the request.
|
3385
3839
|
# @return [Array<Types::Operation>]
|
3386
3840
|
#
|
3387
3841
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/EnableAddOnResult AWS API Documentation
|
@@ -3513,7 +3967,9 @@ module Aws::Lightsail
|
|
3513
3967
|
end
|
3514
3968
|
|
3515
3969
|
# @!attribute [rw] operations
|
3516
|
-
#
|
3970
|
+
# An array of objects that describe the result of the action, such as
|
3971
|
+
# the status of the request, the timestamp of the request, and the
|
3972
|
+
# resources affected by the request.
|
3517
3973
|
# @return [Array<Types::Operation>]
|
3518
3974
|
#
|
3519
3975
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ExportSnapshotResult AWS API Documentation
|
@@ -3531,7 +3987,11 @@ module Aws::Lightsail
|
|
3531
3987
|
# }
|
3532
3988
|
#
|
3533
3989
|
# @!attribute [rw] page_token
|
3534
|
-
#
|
3990
|
+
# The token to advance to the next page of results from your request.
|
3991
|
+
#
|
3992
|
+
# To get a page token, perform an initial `GetActiveNames` request. If
|
3993
|
+
# your results are paginated, the response will return a next page
|
3994
|
+
# token that you can specify as the page token in a subsequent
|
3535
3995
|
# request.
|
3536
3996
|
# @return [String]
|
3537
3997
|
#
|
@@ -3547,8 +4007,14 @@ module Aws::Lightsail
|
|
3547
4007
|
# @return [Array<String>]
|
3548
4008
|
#
|
3549
4009
|
# @!attribute [rw] next_page_token
|
3550
|
-
#
|
3551
|
-
#
|
4010
|
+
# The token to advance to the next page of resutls from your request.
|
4011
|
+
#
|
4012
|
+
# A next page token is not returned if there are no more results to
|
4013
|
+
# display.
|
4014
|
+
#
|
4015
|
+
# To get the next page of results, perform another `GetActiveNames`
|
4016
|
+
# request and specify the next page token using the `pageToken`
|
4017
|
+
# parameter.
|
3552
4018
|
# @return [String]
|
3553
4019
|
#
|
3554
4020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetActiveNamesResult AWS API Documentation
|
@@ -3559,31 +4025,92 @@ module Aws::Lightsail
|
|
3559
4025
|
include Aws::Structure
|
3560
4026
|
end
|
3561
4027
|
|
3562
|
-
# @note When making an API call, you may pass
|
4028
|
+
# @note When making an API call, you may pass GetAlarmsRequest
|
3563
4029
|
# data as a hash:
|
3564
4030
|
#
|
3565
4031
|
# {
|
3566
|
-
#
|
4032
|
+
# alarm_name: "ResourceName",
|
4033
|
+
# page_token: "string",
|
4034
|
+
# monitored_resource_name: "ResourceName",
|
3567
4035
|
# }
|
3568
4036
|
#
|
3569
|
-
# @!attribute [rw]
|
3570
|
-
# The name of the
|
3571
|
-
#
|
4037
|
+
# @!attribute [rw] alarm_name
|
4038
|
+
# The name of the alarm.
|
4039
|
+
#
|
4040
|
+
# Specify an alarm name to return information about a specific alarm.
|
3572
4041
|
# @return [String]
|
3573
4042
|
#
|
3574
|
-
#
|
4043
|
+
# @!attribute [rw] page_token
|
4044
|
+
# The token to advance to the next page of results from your request.
|
3575
4045
|
#
|
3576
|
-
|
3577
|
-
|
3578
|
-
|
3579
|
-
end
|
3580
|
-
|
3581
|
-
# @!attribute [rw] resource_name
|
3582
|
-
# The name of the source instance or disk for the automatic snapshots.
|
4046
|
+
# To get a page token, perform an initial `GetAlarms` request. If your
|
4047
|
+
# results are paginated, the response will return a next page token
|
4048
|
+
# that you can specify as the page token in a subsequent request.
|
3583
4049
|
# @return [String]
|
3584
4050
|
#
|
3585
|
-
# @!attribute [rw]
|
3586
|
-
# The resource
|
4051
|
+
# @!attribute [rw] monitored_resource_name
|
4052
|
+
# The name of the Lightsail resource being monitored by the alarm.
|
4053
|
+
#
|
4054
|
+
# Specify a monitored resource name to return information about all
|
4055
|
+
# alarms for a specific resource.
|
4056
|
+
# @return [String]
|
4057
|
+
#
|
4058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAlarmsRequest AWS API Documentation
|
4059
|
+
#
|
4060
|
+
class GetAlarmsRequest < Struct.new(
|
4061
|
+
:alarm_name,
|
4062
|
+
:page_token,
|
4063
|
+
:monitored_resource_name)
|
4064
|
+
include Aws::Structure
|
4065
|
+
end
|
4066
|
+
|
4067
|
+
# @!attribute [rw] alarms
|
4068
|
+
# An array of objects that describe the alarms.
|
4069
|
+
# @return [Array<Types::Alarm>]
|
4070
|
+
#
|
4071
|
+
# @!attribute [rw] next_page_token
|
4072
|
+
# The token to advance to the next page of resutls from your request.
|
4073
|
+
#
|
4074
|
+
# A next page token is not returned if there are no more results to
|
4075
|
+
# display.
|
4076
|
+
#
|
4077
|
+
# To get the next page of results, perform another `GetAlarms` request
|
4078
|
+
# and specify the next page token using the `pageToken` parameter.
|
4079
|
+
# @return [String]
|
4080
|
+
#
|
4081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAlarmsResult AWS API Documentation
|
4082
|
+
#
|
4083
|
+
class GetAlarmsResult < Struct.new(
|
4084
|
+
:alarms,
|
4085
|
+
:next_page_token)
|
4086
|
+
include Aws::Structure
|
4087
|
+
end
|
4088
|
+
|
4089
|
+
# @note When making an API call, you may pass GetAutoSnapshotsRequest
|
4090
|
+
# data as a hash:
|
4091
|
+
#
|
4092
|
+
# {
|
4093
|
+
# resource_name: "ResourceName", # required
|
4094
|
+
# }
|
4095
|
+
#
|
4096
|
+
# @!attribute [rw] resource_name
|
4097
|
+
# The name of the source instance or disk from which to get automatic
|
4098
|
+
# snapshot information.
|
4099
|
+
# @return [String]
|
4100
|
+
#
|
4101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAutoSnapshotsRequest AWS API Documentation
|
4102
|
+
#
|
4103
|
+
class GetAutoSnapshotsRequest < Struct.new(
|
4104
|
+
:resource_name)
|
4105
|
+
include Aws::Structure
|
4106
|
+
end
|
4107
|
+
|
4108
|
+
# @!attribute [rw] resource_name
|
4109
|
+
# The name of the source instance or disk for the automatic snapshots.
|
4110
|
+
# @return [String]
|
4111
|
+
#
|
4112
|
+
# @!attribute [rw] resource_type
|
4113
|
+
# The resource type (e.g., `Instance` or `Disk`).
|
3587
4114
|
# @return [String]
|
3588
4115
|
#
|
3589
4116
|
# @!attribute [rw] auto_snapshots
|
@@ -3614,8 +4141,12 @@ module Aws::Lightsail
|
|
3614
4141
|
# @return [Boolean]
|
3615
4142
|
#
|
3616
4143
|
# @!attribute [rw] page_token
|
3617
|
-
#
|
3618
|
-
#
|
4144
|
+
# The token to advance to the next page of results from your request.
|
4145
|
+
#
|
4146
|
+
# To get a page token, perform an initial `GetBlueprints` request. If
|
4147
|
+
# your results are paginated, the response will return a next page
|
4148
|
+
# token that you can specify as the page token in a subsequent
|
4149
|
+
# request.
|
3619
4150
|
# @return [String]
|
3620
4151
|
#
|
3621
4152
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprintsRequest AWS API Documentation
|
@@ -3632,8 +4163,14 @@ module Aws::Lightsail
|
|
3632
4163
|
# @return [Array<Types::Blueprint>]
|
3633
4164
|
#
|
3634
4165
|
# @!attribute [rw] next_page_token
|
3635
|
-
#
|
3636
|
-
#
|
4166
|
+
# The token to advance to the next page of resutls from your request.
|
4167
|
+
#
|
4168
|
+
# A next page token is not returned if there are no more results to
|
4169
|
+
# display.
|
4170
|
+
#
|
4171
|
+
# To get the next page of results, perform another `GetBlueprints`
|
4172
|
+
# request and specify the next page token using the `pageToken`
|
4173
|
+
# parameter.
|
3637
4174
|
# @return [String]
|
3638
4175
|
#
|
3639
4176
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprintsResult AWS API Documentation
|
@@ -3658,8 +4195,12 @@ module Aws::Lightsail
|
|
3658
4195
|
# @return [Boolean]
|
3659
4196
|
#
|
3660
4197
|
# @!attribute [rw] page_token
|
3661
|
-
#
|
3662
|
-
#
|
4198
|
+
# The token to advance to the next page of results from your request.
|
4199
|
+
#
|
4200
|
+
# To get a page token, perform an initial `GetBundles` request. If
|
4201
|
+
# your results are paginated, the response will return a next page
|
4202
|
+
# token that you can specify as the page token in a subsequent
|
4203
|
+
# request.
|
3663
4204
|
# @return [String]
|
3664
4205
|
#
|
3665
4206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundlesRequest AWS API Documentation
|
@@ -3676,8 +4217,14 @@ module Aws::Lightsail
|
|
3676
4217
|
# @return [Array<Types::Bundle>]
|
3677
4218
|
#
|
3678
4219
|
# @!attribute [rw] next_page_token
|
3679
|
-
#
|
3680
|
-
#
|
4220
|
+
# The token to advance to the next page of resutls from your request.
|
4221
|
+
#
|
4222
|
+
# A next page token is not returned if there are no more results to
|
4223
|
+
# display.
|
4224
|
+
#
|
4225
|
+
# To get the next page of results, perform another `GetBundles`
|
4226
|
+
# request and specify the next page token using the `pageToken`
|
4227
|
+
# parameter.
|
3681
4228
|
# @return [String]
|
3682
4229
|
#
|
3683
4230
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBundlesResult AWS API Documentation
|
@@ -3696,8 +4243,12 @@ module Aws::Lightsail
|
|
3696
4243
|
# }
|
3697
4244
|
#
|
3698
4245
|
# @!attribute [rw] page_token
|
3699
|
-
#
|
3700
|
-
#
|
4246
|
+
# The token to advance to the next page of results from your request.
|
4247
|
+
#
|
4248
|
+
# To get a page token, perform an initial
|
4249
|
+
# `GetClouFormationStackRecords` request. If your results are
|
4250
|
+
# paginated, the response will return a next page token that you can
|
4251
|
+
# specify as the page token in a subsequent request.
|
3701
4252
|
# @return [String]
|
3702
4253
|
#
|
3703
4254
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecordsRequest AWS API Documentation
|
@@ -3712,8 +4263,14 @@ module Aws::Lightsail
|
|
3712
4263
|
# @return [Array<Types::CloudFormationStackRecord>]
|
3713
4264
|
#
|
3714
4265
|
# @!attribute [rw] next_page_token
|
3715
|
-
#
|
3716
|
-
#
|
4266
|
+
# The token to advance to the next page of resutls from your request.
|
4267
|
+
#
|
4268
|
+
# A next page token is not returned if there are no more results to
|
4269
|
+
# display.
|
4270
|
+
#
|
4271
|
+
# To get the next page of results, perform another
|
4272
|
+
# `GetCloudFormationStackRecords` request and specify the next page
|
4273
|
+
# token using the `pageToken` parameter.
|
3717
4274
|
# @return [String]
|
3718
4275
|
#
|
3719
4276
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetCloudFormationStackRecordsResult AWS API Documentation
|
@@ -3724,6 +4281,39 @@ module Aws::Lightsail
|
|
3724
4281
|
include Aws::Structure
|
3725
4282
|
end
|
3726
4283
|
|
4284
|
+
# @note When making an API call, you may pass GetContactMethodsRequest
|
4285
|
+
# data as a hash:
|
4286
|
+
#
|
4287
|
+
# {
|
4288
|
+
# protocols: ["Email"], # accepts Email, SMS
|
4289
|
+
# }
|
4290
|
+
#
|
4291
|
+
# @!attribute [rw] protocols
|
4292
|
+
# The protocols used to send notifications, such as `Email`, or `SMS`
|
4293
|
+
# (text messaging).
|
4294
|
+
#
|
4295
|
+
# Specify a protocol in your request to return information about a
|
4296
|
+
# specific contact method protocol.
|
4297
|
+
# @return [Array<String>]
|
4298
|
+
#
|
4299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContactMethodsRequest AWS API Documentation
|
4300
|
+
#
|
4301
|
+
class GetContactMethodsRequest < Struct.new(
|
4302
|
+
:protocols)
|
4303
|
+
include Aws::Structure
|
4304
|
+
end
|
4305
|
+
|
4306
|
+
# @!attribute [rw] contact_methods
|
4307
|
+
# An array of objects that describe the contact methods.
|
4308
|
+
# @return [Array<Types::ContactMethod>]
|
4309
|
+
#
|
4310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetContactMethodsResult AWS API Documentation
|
4311
|
+
#
|
4312
|
+
class GetContactMethodsResult < Struct.new(
|
4313
|
+
:contact_methods)
|
4314
|
+
include Aws::Structure
|
4315
|
+
end
|
4316
|
+
|
3727
4317
|
# @note When making an API call, you may pass GetDiskRequest
|
3728
4318
|
# data as a hash:
|
3729
4319
|
#
|
@@ -3790,8 +4380,12 @@ module Aws::Lightsail
|
|
3790
4380
|
# }
|
3791
4381
|
#
|
3792
4382
|
# @!attribute [rw] page_token
|
3793
|
-
#
|
3794
|
-
#
|
4383
|
+
# The token to advance to the next page of results from your request.
|
4384
|
+
#
|
4385
|
+
# To get a page token, perform an initial `GetDiskSnapshots` request.
|
4386
|
+
# If your results are paginated, the response will return a next page
|
4387
|
+
# token that you can specify as the page token in a subsequent
|
4388
|
+
# request.
|
3795
4389
|
# @return [String]
|
3796
4390
|
#
|
3797
4391
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshotsRequest AWS API Documentation
|
@@ -3807,8 +4401,14 @@ module Aws::Lightsail
|
|
3807
4401
|
# @return [Array<Types::DiskSnapshot>]
|
3808
4402
|
#
|
3809
4403
|
# @!attribute [rw] next_page_token
|
3810
|
-
#
|
3811
|
-
#
|
4404
|
+
# The token to advance to the next page of resutls from your request.
|
4405
|
+
#
|
4406
|
+
# A next page token is not returned if there are no more results to
|
4407
|
+
# display.
|
4408
|
+
#
|
4409
|
+
# To get the next page of results, perform another `GetDiskSnapshots`
|
4410
|
+
# request and specify the next page token using the `pageToken`
|
4411
|
+
# parameter.
|
3812
4412
|
# @return [String]
|
3813
4413
|
#
|
3814
4414
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDiskSnapshotsResult AWS API Documentation
|
@@ -3827,8 +4427,11 @@ module Aws::Lightsail
|
|
3827
4427
|
# }
|
3828
4428
|
#
|
3829
4429
|
# @!attribute [rw] page_token
|
3830
|
-
#
|
3831
|
-
#
|
4430
|
+
# The token to advance to the next page of results from your request.
|
4431
|
+
#
|
4432
|
+
# To get a page token, perform an initial `GetDisks` request. If your
|
4433
|
+
# results are paginated, the response will return a next page token
|
4434
|
+
# that you can specify as the page token in a subsequent request.
|
3832
4435
|
# @return [String]
|
3833
4436
|
#
|
3834
4437
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisksRequest AWS API Documentation
|
@@ -3844,8 +4447,13 @@ module Aws::Lightsail
|
|
3844
4447
|
# @return [Array<Types::Disk>]
|
3845
4448
|
#
|
3846
4449
|
# @!attribute [rw] next_page_token
|
3847
|
-
#
|
3848
|
-
#
|
4450
|
+
# The token to advance to the next page of resutls from your request.
|
4451
|
+
#
|
4452
|
+
# A next page token is not returned if there are no more results to
|
4453
|
+
# display.
|
4454
|
+
#
|
4455
|
+
# To get the next page of results, perform another `GetDisks` request
|
4456
|
+
# and specify the next page token using the `pageToken` parameter.
|
3849
4457
|
# @return [String]
|
3850
4458
|
#
|
3851
4459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDisksResult AWS API Documentation
|
@@ -3894,8 +4502,12 @@ module Aws::Lightsail
|
|
3894
4502
|
# }
|
3895
4503
|
#
|
3896
4504
|
# @!attribute [rw] page_token
|
3897
|
-
#
|
3898
|
-
#
|
4505
|
+
# The token to advance to the next page of results from your request.
|
4506
|
+
#
|
4507
|
+
# To get a page token, perform an initial `GetDomains` request. If
|
4508
|
+
# your results are paginated, the response will return a next page
|
4509
|
+
# token that you can specify as the page token in a subsequent
|
4510
|
+
# request.
|
3899
4511
|
# @return [String]
|
3900
4512
|
#
|
3901
4513
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomainsRequest AWS API Documentation
|
@@ -3911,8 +4523,14 @@ module Aws::Lightsail
|
|
3911
4523
|
# @return [Array<Types::Domain>]
|
3912
4524
|
#
|
3913
4525
|
# @!attribute [rw] next_page_token
|
3914
|
-
#
|
3915
|
-
#
|
4526
|
+
# The token to advance to the next page of resutls from your request.
|
4527
|
+
#
|
4528
|
+
# A next page token is not returned if there are no more results to
|
4529
|
+
# display.
|
4530
|
+
#
|
4531
|
+
# To get the next page of results, perform another `GetDomains`
|
4532
|
+
# request and specify the next page token using the `pageToken`
|
4533
|
+
# parameter.
|
3916
4534
|
# @return [String]
|
3917
4535
|
#
|
3918
4536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetDomainsResult AWS API Documentation
|
@@ -3931,8 +4549,12 @@ module Aws::Lightsail
|
|
3931
4549
|
# }
|
3932
4550
|
#
|
3933
4551
|
# @!attribute [rw] page_token
|
3934
|
-
#
|
3935
|
-
#
|
4552
|
+
# The token to advance to the next page of results from your request.
|
4553
|
+
#
|
4554
|
+
# To get a page token, perform an initial `GetExportSnapshotRecords`
|
4555
|
+
# request. If your results are paginated, the response will return a
|
4556
|
+
# next page token that you can specify as the page token in a
|
4557
|
+
# subsequent request.
|
3936
4558
|
# @return [String]
|
3937
4559
|
#
|
3938
4560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetExportSnapshotRecordsRequest AWS API Documentation
|
@@ -3947,8 +4569,14 @@ module Aws::Lightsail
|
|
3947
4569
|
# @return [Array<Types::ExportSnapshotRecord>]
|
3948
4570
|
#
|
3949
4571
|
# @!attribute [rw] next_page_token
|
3950
|
-
#
|
3951
|
-
#
|
4572
|
+
# The token to advance to the next page of resutls from your request.
|
4573
|
+
#
|
4574
|
+
# A next page token is not returned if there are no more results to
|
4575
|
+
# display.
|
4576
|
+
#
|
4577
|
+
# To get the next page of results, perform another
|
4578
|
+
# `GetExportSnapshotRecords` request and specify the next page token
|
4579
|
+
# using the `pageToken` parameter.
|
3952
4580
|
# @return [String]
|
3953
4581
|
#
|
3954
4582
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetExportSnapshotRecordsResult AWS API Documentation
|
@@ -4000,7 +4628,7 @@ module Aws::Lightsail
|
|
4000
4628
|
#
|
4001
4629
|
# {
|
4002
4630
|
# instance_name: "ResourceName", # required
|
4003
|
-
# metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System
|
4631
|
+
# metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System, BurstCapacityTime, BurstCapacityPercentage
|
4004
4632
|
# period: 1, # required
|
4005
4633
|
# start_time: Time.now, # required
|
4006
4634
|
# end_time: Time.now, # required
|
@@ -4013,11 +4641,118 @@ module Aws::Lightsail
|
|
4013
4641
|
# @return [String]
|
4014
4642
|
#
|
4015
4643
|
# @!attribute [rw] metric_name
|
4016
|
-
# The metric
|
4644
|
+
# The metric for which you want to return information.
|
4645
|
+
#
|
4646
|
+
# Valid instance metric names are listed below, along with the most
|
4647
|
+
# useful `statistics` to include in your request, and the published
|
4648
|
+
# `unit` value.
|
4649
|
+
#
|
4650
|
+
# * <b> <code>BurstCapacityPercentage</code> </b> - The percentage of
|
4651
|
+
# CPU performance available for your instance to burst above its
|
4652
|
+
# baseline. Your instance continously accrues and consumes burst
|
4653
|
+
# capacity. Burst capacity stops accruing when your instance's
|
4654
|
+
# `BurstCapacityPercentage` reaches 100%. For more information, see
|
4655
|
+
# [Viewing instance burst capacity in Amazon Lightsail][1].
|
4656
|
+
#
|
4657
|
+
# `Statistics`\: The most useful statistics are `Maximum` and
|
4658
|
+
# `Average`.
|
4659
|
+
#
|
4660
|
+
# `Unit`\: The published unit is `Percent`.
|
4661
|
+
#
|
4662
|
+
# * <b> <code>BurstCapacityTime</code> </b> - The available amount of
|
4663
|
+
# time for your instance to burst at 100% CPU utilization. Your
|
4664
|
+
# instance continously accrues and consumes burst capacity. Burst
|
4665
|
+
# capacity time stops accruing when your instance's
|
4666
|
+
# `BurstCapacityPercentage` metric reaches 100%.
|
4667
|
+
#
|
4668
|
+
# Burst capacity time is consumed at the full rate only when your
|
4669
|
+
# instance operates at 100% CPU utilization. For example, if your
|
4670
|
+
# instance operates at 50% CPU utilization in the burstable zone for
|
4671
|
+
# a 5-minute period, then it consumes CPU burst capacity minutes at
|
4672
|
+
# a 50% rate in that period. Your instance consumed 2 minutes and 30
|
4673
|
+
# seconds of CPU burst capacity minutes in the 5-minute period. For
|
4674
|
+
# more information, see [Viewing instance burst capacity in Amazon
|
4675
|
+
# Lightsail][1].
|
4676
|
+
#
|
4677
|
+
# `Statistics`\: The most useful statistics are `Maximum` and
|
4678
|
+
# `Average`.
|
4679
|
+
#
|
4680
|
+
# `Unit`\: The published unit is `Seconds`.
|
4681
|
+
#
|
4682
|
+
# * <b> <code>CPUUtilization</code> </b> - The percentage of allocated
|
4683
|
+
# compute units that are currently in use on the instance. This
|
4684
|
+
# metric identifies the processing power to run the applications on
|
4685
|
+
# the instance. Tools in your operating system can show a lower
|
4686
|
+
# percentage than Lightsail when the instance is not allocated a
|
4687
|
+
# full processor core.
|
4688
|
+
#
|
4689
|
+
# `Statistics`\: The most useful statistics are `Maximum` and
|
4690
|
+
# `Average`.
|
4691
|
+
#
|
4692
|
+
# `Unit`\: The published unit is `Percent`.
|
4693
|
+
#
|
4694
|
+
# * <b> <code>NetworkIn</code> </b> - The number of bytes received on
|
4695
|
+
# all network interfaces by the instance. This metric identifies the
|
4696
|
+
# volume of incoming network traffic to the instance. The number
|
4697
|
+
# reported is the number of bytes received during the period.
|
4698
|
+
# Because this metric is reported in 5-minute intervals, divide the
|
4699
|
+
# reported number by 300 to find Bytes/second.
|
4700
|
+
#
|
4701
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
4702
|
+
#
|
4703
|
+
# `Unit`\: The published unit is `Bytes`.
|
4704
|
+
#
|
4705
|
+
# * <b> <code>NetworkOut</code> </b> - The number of bytes sent out on
|
4706
|
+
# all network interfaces by the instance. This metric identifies the
|
4707
|
+
# volume of outgoing network traffic from the instance. The number
|
4708
|
+
# reported is the number of bytes sent during the period. Because
|
4709
|
+
# this metric is reported in 5-minute intervals, divide the reported
|
4710
|
+
# number by 300 to find Bytes/second.
|
4711
|
+
#
|
4712
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
4713
|
+
#
|
4714
|
+
# `Unit`\: The published unit is `Bytes`.
|
4715
|
+
#
|
4716
|
+
# * <b> <code>StatusCheckFailed</code> </b> - Reports whether the
|
4717
|
+
# instance passed or failed both the instance status check and the
|
4718
|
+
# system status check. This metric can be either 0 (passed) or 1
|
4719
|
+
# (failed). This metric data is available in 1-minute (60 seconds)
|
4720
|
+
# granularity.
|
4721
|
+
#
|
4722
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
4723
|
+
#
|
4724
|
+
# `Unit`\: The published unit is `Count`.
|
4725
|
+
#
|
4726
|
+
# * <b> <code>StatusCheckFailed_Instance</code> </b> - Reports whether
|
4727
|
+
# the instance passed or failed the instance status check. This
|
4728
|
+
# metric can be either 0 (passed) or 1 (failed). This metric data is
|
4729
|
+
# available in 1-minute (60 seconds) granularity.
|
4730
|
+
#
|
4731
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
4732
|
+
#
|
4733
|
+
# `Unit`\: The published unit is `Count`.
|
4734
|
+
#
|
4735
|
+
# * <b> <code>StatusCheckFailed_System</code> </b> - Reports whether
|
4736
|
+
# the instance passed or failed the system status check. This metric
|
4737
|
+
# can be either 0 (passed) or 1 (failed). This metric data is
|
4738
|
+
# available in 1-minute (60 seconds) granularity.
|
4739
|
+
#
|
4740
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
4741
|
+
#
|
4742
|
+
# `Unit`\: The published unit is `Count`.
|
4743
|
+
#
|
4744
|
+
#
|
4745
|
+
#
|
4746
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity
|
4017
4747
|
# @return [String]
|
4018
4748
|
#
|
4019
4749
|
# @!attribute [rw] period
|
4020
4750
|
# The granularity, in seconds, of the returned data points.
|
4751
|
+
#
|
4752
|
+
# The `StatusCheckFailed`, `StatusCheckFailed_Instance`, and
|
4753
|
+
# `StatusCheckFailed_System` instance metric data is available in
|
4754
|
+
# 1-minute (60 seconds) granularity. All other instance metric data is
|
4755
|
+
# available in 5-minute (300 seconds) granularity.
|
4021
4756
|
# @return [Integer]
|
4022
4757
|
#
|
4023
4758
|
# @!attribute [rw] start_time
|
@@ -4029,11 +4764,37 @@ module Aws::Lightsail
|
|
4029
4764
|
# @return [Time]
|
4030
4765
|
#
|
4031
4766
|
# @!attribute [rw] unit
|
4032
|
-
# The unit
|
4767
|
+
# The unit for the metric data request. Valid units depend on the
|
4768
|
+
# metric data being requested. For the valid units to specify with
|
4769
|
+
# each available metric, see the `metricName` parameter.
|
4033
4770
|
# @return [String]
|
4034
4771
|
#
|
4035
4772
|
# @!attribute [rw] statistics
|
4036
|
-
# The
|
4773
|
+
# The statistic for the metric.
|
4774
|
+
#
|
4775
|
+
# The following statistics are available:
|
4776
|
+
#
|
4777
|
+
# * `Minimum` - The lowest value observed during the specified period.
|
4778
|
+
# Use this value to determine low volumes of activity for your
|
4779
|
+
# application.
|
4780
|
+
#
|
4781
|
+
# * `Maximum` - The highest value observed during the specified
|
4782
|
+
# period. Use this value to determine high volumes of activity for
|
4783
|
+
# your application.
|
4784
|
+
#
|
4785
|
+
# * `Sum` - All values submitted for the matching metric added
|
4786
|
+
# together. You can use this statistic to determine the total volume
|
4787
|
+
# of a metric.
|
4788
|
+
#
|
4789
|
+
# * `Average` - The value of Sum / SampleCount during the specified
|
4790
|
+
# period. By comparing this statistic with the Minimum and Maximum
|
4791
|
+
# values, you can determine the full scope of a metric and how close
|
4792
|
+
# the average use is to the Minimum and Maximum values. This
|
4793
|
+
# comparison helps you to know when to increase or decrease your
|
4794
|
+
# resources.
|
4795
|
+
#
|
4796
|
+
# * `SampleCount` - The count, or number, of data points used for the
|
4797
|
+
# statistical calculation.
|
4037
4798
|
# @return [Array<String>]
|
4038
4799
|
#
|
4039
4800
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricDataRequest AWS API Documentation
|
@@ -4050,12 +4811,11 @@ module Aws::Lightsail
|
|
4050
4811
|
end
|
4051
4812
|
|
4052
4813
|
# @!attribute [rw] metric_name
|
4053
|
-
# The
|
4814
|
+
# The name of the metric returned.
|
4054
4815
|
# @return [String]
|
4055
4816
|
#
|
4056
4817
|
# @!attribute [rw] metric_data
|
4057
|
-
# An array of
|
4058
|
-
# of your get instance metric data request.
|
4818
|
+
# An array of objects that describe the metric data returned.
|
4059
4819
|
# @return [Array<Types::MetricDatapoint>]
|
4060
4820
|
#
|
4061
4821
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceMetricDataResult AWS API Documentation
|
@@ -4074,7 +4834,7 @@ module Aws::Lightsail
|
|
4074
4834
|
# }
|
4075
4835
|
#
|
4076
4836
|
# @!attribute [rw] instance_name
|
4077
|
-
# The name of the instance.
|
4837
|
+
# The name of the instance for which to return firewall port states.
|
4078
4838
|
# @return [String]
|
4079
4839
|
#
|
4080
4840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStatesRequest AWS API Documentation
|
@@ -4085,7 +4845,8 @@ module Aws::Lightsail
|
|
4085
4845
|
end
|
4086
4846
|
|
4087
4847
|
# @!attribute [rw] port_states
|
4088
|
-
#
|
4848
|
+
# An array of objects that describe the firewall port states for the
|
4849
|
+
# specified instance.
|
4089
4850
|
# @return [Array<Types::InstancePortState>]
|
4090
4851
|
#
|
4091
4852
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancePortStatesResult AWS API Documentation
|
@@ -4163,8 +4924,12 @@ module Aws::Lightsail
|
|
4163
4924
|
# }
|
4164
4925
|
#
|
4165
4926
|
# @!attribute [rw] page_token
|
4166
|
-
#
|
4167
|
-
#
|
4927
|
+
# The token to advance to the next page of results from your request.
|
4928
|
+
#
|
4929
|
+
# To get a page token, perform an initial `GetInstanceSnapshots`
|
4930
|
+
# request. If your results are paginated, the response will return a
|
4931
|
+
# next page token that you can specify as the page token in a
|
4932
|
+
# subsequent request.
|
4168
4933
|
# @return [String]
|
4169
4934
|
#
|
4170
4935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshotsRequest AWS API Documentation
|
@@ -4180,8 +4945,14 @@ module Aws::Lightsail
|
|
4180
4945
|
# @return [Array<Types::InstanceSnapshot>]
|
4181
4946
|
#
|
4182
4947
|
# @!attribute [rw] next_page_token
|
4183
|
-
#
|
4184
|
-
#
|
4948
|
+
# The token to advance to the next page of resutls from your request.
|
4949
|
+
#
|
4950
|
+
# A next page token is not returned if there are no more results to
|
4951
|
+
# display.
|
4952
|
+
#
|
4953
|
+
# To get the next page of results, perform another
|
4954
|
+
# `GetInstanceSnapshots` request and specify the next page token using
|
4955
|
+
# the `pageToken` parameter.
|
4185
4956
|
# @return [String]
|
4186
4957
|
#
|
4187
4958
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstanceSnapshotsResult AWS API Documentation
|
@@ -4229,8 +5000,12 @@ module Aws::Lightsail
|
|
4229
5000
|
# }
|
4230
5001
|
#
|
4231
5002
|
# @!attribute [rw] page_token
|
4232
|
-
#
|
4233
|
-
#
|
5003
|
+
# The token to advance to the next page of results from your request.
|
5004
|
+
#
|
5005
|
+
# To get a page token, perform an initial `GetInstances` request. If
|
5006
|
+
# your results are paginated, the response will return a next page
|
5007
|
+
# token that you can specify as the page token in a subsequent
|
5008
|
+
# request.
|
4234
5009
|
# @return [String]
|
4235
5010
|
#
|
4236
5011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancesRequest AWS API Documentation
|
@@ -4246,8 +5021,14 @@ module Aws::Lightsail
|
|
4246
5021
|
# @return [Array<Types::Instance>]
|
4247
5022
|
#
|
4248
5023
|
# @!attribute [rw] next_page_token
|
4249
|
-
#
|
4250
|
-
#
|
5024
|
+
# The token to advance to the next page of resutls from your request.
|
5025
|
+
#
|
5026
|
+
# A next page token is not returned if there are no more results to
|
5027
|
+
# display.
|
5028
|
+
#
|
5029
|
+
# To get the next page of results, perform another `GetInstances`
|
5030
|
+
# request and specify the next page token using the `pageToken`
|
5031
|
+
# parameter.
|
4251
5032
|
# @return [String]
|
4252
5033
|
#
|
4253
5034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetInstancesResult AWS API Documentation
|
@@ -4296,8 +5077,12 @@ module Aws::Lightsail
|
|
4296
5077
|
# }
|
4297
5078
|
#
|
4298
5079
|
# @!attribute [rw] page_token
|
4299
|
-
#
|
4300
|
-
#
|
5080
|
+
# The token to advance to the next page of results from your request.
|
5081
|
+
#
|
5082
|
+
# To get a page token, perform an initial `GetKeyPairs` request. If
|
5083
|
+
# your results are paginated, the response will return a next page
|
5084
|
+
# token that you can specify as the page token in a subsequent
|
5085
|
+
# request.
|
4301
5086
|
# @return [String]
|
4302
5087
|
#
|
4303
5088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairsRequest AWS API Documentation
|
@@ -4313,8 +5098,14 @@ module Aws::Lightsail
|
|
4313
5098
|
# @return [Array<Types::KeyPair>]
|
4314
5099
|
#
|
4315
5100
|
# @!attribute [rw] next_page_token
|
4316
|
-
#
|
4317
|
-
#
|
5101
|
+
# The token to advance to the next page of resutls from your request.
|
5102
|
+
#
|
5103
|
+
# A next page token is not returned if there are no more results to
|
5104
|
+
# display.
|
5105
|
+
#
|
5106
|
+
# To get the next page of results, perform another `GetKeyPairs`
|
5107
|
+
# request and specify the next page token using the `pageToken`
|
5108
|
+
# parameter.
|
4318
5109
|
# @return [String]
|
4319
5110
|
#
|
4320
5111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetKeyPairsResult AWS API Documentation
|
@@ -4343,94 +5134,127 @@ module Aws::Lightsail
|
|
4343
5134
|
# @return [String]
|
4344
5135
|
#
|
4345
5136
|
# @!attribute [rw] metric_name
|
4346
|
-
# The metric
|
4347
|
-
#
|
4348
|
-
#
|
5137
|
+
# The metric for which you want to return information.
|
5138
|
+
#
|
5139
|
+
# Valid load balancer metric names are listed below, along with the
|
5140
|
+
# most useful `statistics` to include in your request, and the
|
5141
|
+
# published `unit` value.
|
4349
5142
|
#
|
4350
5143
|
# * <b> <code>ClientTLSNegotiationErrorCount</code> </b> - The number
|
4351
5144
|
# of TLS connections initiated by the client that did not establish
|
4352
|
-
# a session with the load balancer
|
4353
|
-
# mismatch of ciphers
|
5145
|
+
# a session with the load balancer due to a TLS error generated by
|
5146
|
+
# the load balancer. Possible causes include a mismatch of ciphers
|
5147
|
+
# or protocols.
|
4354
5148
|
#
|
4355
5149
|
# `Statistics`\: The most useful statistic is `Sum`.
|
4356
5150
|
#
|
5151
|
+
# `Unit`\: The published unit is `Count`.
|
5152
|
+
#
|
4357
5153
|
# * <b> <code>HealthyHostCount</code> </b> - The number of target
|
4358
5154
|
# instances that are considered healthy.
|
4359
5155
|
#
|
4360
5156
|
# `Statistics`\: The most useful statistic are `Average`, `Minimum`,
|
4361
5157
|
# and `Maximum`.
|
4362
5158
|
#
|
4363
|
-
#
|
4364
|
-
# instances that are considered unhealthy.
|
5159
|
+
# `Unit`\: The published unit is `Count`.
|
4365
5160
|
#
|
4366
|
-
#
|
4367
|
-
#
|
4368
|
-
#
|
4369
|
-
#
|
4370
|
-
# 4XX client error codes that originate from the load balancer.
|
4371
|
-
# Client errors are generated when requests are malformed or
|
4372
|
-
# incomplete. These requests have not been received by the target
|
4373
|
-
# instance. This count does not include any response codes generated
|
4374
|
-
# by the target instances.
|
5161
|
+
# * <b> <code>HTTPCode_Instance_2XX_Count</code> </b> - The number of
|
5162
|
+
# HTTP 2XX response codes generated by the target instances. This
|
5163
|
+
# does not include any response codes generated by the load
|
5164
|
+
# balancer.
|
4375
5165
|
#
|
4376
5166
|
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4377
5167
|
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4378
5168
|
#
|
4379
|
-
#
|
4380
|
-
#
|
4381
|
-
#
|
4382
|
-
# instances.
|
5169
|
+
# `Unit`\: The published unit is `Count`.
|
5170
|
+
#
|
5171
|
+
# * <b> <code>HTTPCode_Instance_3XX_Count</code> </b> - The number of
|
5172
|
+
# HTTP 3XX response codes generated by the target instances. This
|
5173
|
+
# does not include any response codes generated by the load
|
5174
|
+
# balancer.
|
4383
5175
|
#
|
4384
5176
|
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4385
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`. Note that
|
4386
5177
|
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4387
5178
|
#
|
4388
|
-
#
|
4389
|
-
#
|
4390
|
-
#
|
5179
|
+
# `Unit`\: The published unit is `Count`.
|
5180
|
+
#
|
5181
|
+
# * <b> <code>HTTPCode_Instance_4XX_Count</code> </b> - The number of
|
5182
|
+
# HTTP 4XX response codes generated by the target instances. This
|
5183
|
+
# does not include any response codes generated by the load
|
5184
|
+
# balancer.
|
4391
5185
|
#
|
4392
5186
|
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4393
5187
|
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4394
5188
|
#
|
4395
|
-
#
|
4396
|
-
#
|
4397
|
-
#
|
5189
|
+
# `Unit`\: The published unit is `Count`.
|
5190
|
+
#
|
5191
|
+
# * <b> <code>HTTPCode_Instance_5XX_Count</code> </b> - The number of
|
5192
|
+
# HTTP 5XX response codes generated by the target instances. This
|
5193
|
+
# does not include any response codes generated by the load
|
5194
|
+
# balancer.
|
4398
5195
|
#
|
4399
5196
|
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4400
5197
|
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4401
5198
|
#
|
4402
|
-
#
|
4403
|
-
#
|
4404
|
-
#
|
5199
|
+
# `Unit`\: The published unit is `Count`.
|
5200
|
+
#
|
5201
|
+
# * <b> <code>HTTPCode_LB_4XX_Count</code> </b> - The number of HTTP
|
5202
|
+
# 4XX client error codes that originated from the load balancer.
|
5203
|
+
# Client errors are generated when requests are malformed or
|
5204
|
+
# incomplete. These requests were not received by the target
|
5205
|
+
# instance. This count does not include response codes generated by
|
5206
|
+
# the target instances.
|
4405
5207
|
#
|
4406
5208
|
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4407
5209
|
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4408
5210
|
#
|
4409
|
-
#
|
4410
|
-
#
|
4411
|
-
#
|
5211
|
+
# `Unit`\: The published unit is `Count`.
|
5212
|
+
#
|
5213
|
+
# * <b> <code>HTTPCode_LB_5XX_Count</code> </b> - The number of HTTP
|
5214
|
+
# 5XX server error codes that originated from the load balancer.
|
5215
|
+
# This does not include any response codes generated by the target
|
5216
|
+
# instance. This metric is reported if there are no healthy
|
5217
|
+
# instances attached to the load balancer, or if the request rate
|
5218
|
+
# exceeds the capacity of the instances (spillover) or the load
|
5219
|
+
# balancer.
|
4412
5220
|
#
|
4413
5221
|
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4414
5222
|
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4415
5223
|
#
|
5224
|
+
# `Unit`\: The published unit is `Count`.
|
5225
|
+
#
|
4416
5226
|
# * <b> <code>InstanceResponseTime</code> </b> - The time elapsed, in
|
4417
5227
|
# seconds, after the request leaves the load balancer until a
|
4418
5228
|
# response from the target instance is received.
|
4419
5229
|
#
|
4420
5230
|
# `Statistics`\: The most useful statistic is `Average`.
|
4421
5231
|
#
|
5232
|
+
# `Unit`\: The published unit is `Seconds`.
|
5233
|
+
#
|
4422
5234
|
# * <b> <code>RejectedConnectionCount</code> </b> - The number of
|
4423
5235
|
# connections that were rejected because the load balancer had
|
4424
5236
|
# reached its maximum number of connections.
|
4425
5237
|
#
|
4426
5238
|
# `Statistics`\: The most useful statistic is `Sum`.
|
4427
5239
|
#
|
5240
|
+
# `Unit`\: The published unit is `Count`.
|
5241
|
+
#
|
4428
5242
|
# * <b> <code>RequestCount</code> </b> - The number of requests
|
4429
5243
|
# processed over IPv4. This count includes only the requests with a
|
4430
5244
|
# response generated by a target instance of the load balancer.
|
4431
5245
|
#
|
4432
5246
|
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4433
5247
|
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
5248
|
+
#
|
5249
|
+
# `Unit`\: The published unit is `Count`.
|
5250
|
+
#
|
5251
|
+
# * <b> <code>UnhealthyHostCount</code> </b> - The number of target
|
5252
|
+
# instances that are considered unhealthy.
|
5253
|
+
#
|
5254
|
+
# `Statistics`\: The most useful statistic are `Average`, `Minimum`,
|
5255
|
+
# and `Maximum`.
|
5256
|
+
#
|
5257
|
+
# `Unit`\: The published unit is `Count`.
|
4434
5258
|
# @return [String]
|
4435
5259
|
#
|
4436
5260
|
# @!attribute [rw] period
|
@@ -4446,34 +5270,37 @@ module Aws::Lightsail
|
|
4446
5270
|
# @return [Time]
|
4447
5271
|
#
|
4448
5272
|
# @!attribute [rw] unit
|
4449
|
-
# The unit for the
|
5273
|
+
# The unit for the metric data request. Valid units depend on the
|
5274
|
+
# metric data being requested. For the valid units with each available
|
5275
|
+
# metric, see the `metricName` parameter.
|
4450
5276
|
# @return [String]
|
4451
5277
|
#
|
4452
5278
|
# @!attribute [rw] statistics
|
4453
|
-
#
|
4454
|
-
# values are listed below.
|
5279
|
+
# The statistic for the metric.
|
4455
5280
|
#
|
4456
|
-
#
|
4457
|
-
# points used for the statistical calculation.
|
5281
|
+
# The following statistics are available:
|
4458
5282
|
#
|
4459
|
-
# *
|
4460
|
-
#
|
4461
|
-
#
|
4462
|
-
# and how close the average use is to the Minimum and Maximum. This
|
4463
|
-
# comparison helps you to know when to increase or decrease your
|
4464
|
-
# resources as needed.
|
5283
|
+
# * `Minimum` - The lowest value observed during the specified period.
|
5284
|
+
# Use this value to determine low volumes of activity for your
|
5285
|
+
# application.
|
4465
5286
|
#
|
4466
|
-
# *
|
4467
|
-
#
|
4468
|
-
#
|
5287
|
+
# * `Maximum` - The highest value observed during the specified
|
5288
|
+
# period. Use this value to determine high volumes of activity for
|
5289
|
+
# your application.
|
4469
5290
|
#
|
4470
|
-
# *
|
4471
|
-
#
|
4472
|
-
#
|
5291
|
+
# * `Sum` - All values submitted for the matching metric added
|
5292
|
+
# together. You can use this statistic to determine the total volume
|
5293
|
+
# of a metric.
|
4473
5294
|
#
|
4474
|
-
# *
|
4475
|
-
#
|
4476
|
-
#
|
5295
|
+
# * `Average` - The value of Sum / SampleCount during the specified
|
5296
|
+
# period. By comparing this statistic with the Minimum and Maximum
|
5297
|
+
# values, you can determine the full scope of a metric and how close
|
5298
|
+
# the average use is to the Minimum and Maximum values. This
|
5299
|
+
# comparison helps you to know when to increase or decrease your
|
5300
|
+
# resources.
|
5301
|
+
#
|
5302
|
+
# * `SampleCount` - The count, or number, of data points used for the
|
5303
|
+
# statistical calculation.
|
4477
5304
|
# @return [Array<String>]
|
4478
5305
|
#
|
4479
5306
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricDataRequest AWS API Documentation
|
@@ -4490,98 +5317,11 @@ module Aws::Lightsail
|
|
4490
5317
|
end
|
4491
5318
|
|
4492
5319
|
# @!attribute [rw] metric_name
|
4493
|
-
# The
|
4494
|
-
# are listed below, along with the most useful `statistics` to include
|
4495
|
-
# in your request.
|
4496
|
-
#
|
4497
|
-
# * <b> <code>ClientTLSNegotiationErrorCount</code> </b> - The number
|
4498
|
-
# of TLS connections initiated by the client that did not establish
|
4499
|
-
# a session with the load balancer. Possible causes include a
|
4500
|
-
# mismatch of ciphers or protocols.
|
4501
|
-
#
|
4502
|
-
# `Statistics`\: The most useful statistic is `Sum`.
|
4503
|
-
#
|
4504
|
-
# * <b> <code>HealthyHostCount</code> </b> - The number of target
|
4505
|
-
# instances that are considered healthy.
|
4506
|
-
#
|
4507
|
-
# `Statistics`\: The most useful statistic are `Average`, `Minimum`,
|
4508
|
-
# and `Maximum`.
|
4509
|
-
#
|
4510
|
-
# * <b> <code>UnhealthyHostCount</code> </b> - The number of target
|
4511
|
-
# instances that are considered unhealthy.
|
4512
|
-
#
|
4513
|
-
# `Statistics`\: The most useful statistic are `Average`, `Minimum`,
|
4514
|
-
# and `Maximum`.
|
4515
|
-
#
|
4516
|
-
# * <b> <code>HTTPCode_LB_4XX_Count</code> </b> - The number of HTTP
|
4517
|
-
# 4XX client error codes that originate from the load balancer.
|
4518
|
-
# Client errors are generated when requests are malformed or
|
4519
|
-
# incomplete. These requests have not been received by the target
|
4520
|
-
# instance. This count does not include any response codes generated
|
4521
|
-
# by the target instances.
|
4522
|
-
#
|
4523
|
-
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4524
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4525
|
-
#
|
4526
|
-
# * <b> <code>HTTPCode_LB_5XX_Count</code> </b> - The number of HTTP
|
4527
|
-
# 5XX server error codes that originate from the load balancer. This
|
4528
|
-
# count does not include any response codes generated by the target
|
4529
|
-
# instances.
|
4530
|
-
#
|
4531
|
-
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4532
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`. Note that
|
4533
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4534
|
-
#
|
4535
|
-
# * <b> <code>HTTPCode_Instance_2XX_Count</code> </b> - The number of
|
4536
|
-
# HTTP response codes generated by the target instances. This does
|
4537
|
-
# not include any response codes generated by the load balancer.
|
4538
|
-
#
|
4539
|
-
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4540
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4541
|
-
#
|
4542
|
-
# * <b> <code>HTTPCode_Instance_3XX_Count</code> </b> - The number of
|
4543
|
-
# HTTP response codes generated by the target instances. This does
|
4544
|
-
# not include any response codes generated by the load balancer.
|
4545
|
-
#
|
4546
|
-
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4547
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4548
|
-
#
|
4549
|
-
# * <b> <code>HTTPCode_Instance_4XX_Count</code> </b> - The number of
|
4550
|
-
# HTTP response codes generated by the target instances. This does
|
4551
|
-
# not include any response codes generated by the load balancer.
|
4552
|
-
#
|
4553
|
-
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4554
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4555
|
-
#
|
4556
|
-
# * <b> <code>HTTPCode_Instance_5XX_Count</code> </b> - The number of
|
4557
|
-
# HTTP response codes generated by the target instances. This does
|
4558
|
-
# not include any response codes generated by the load balancer.
|
4559
|
-
#
|
4560
|
-
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4561
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
4562
|
-
#
|
4563
|
-
# * <b> <code>InstanceResponseTime</code> </b> - The time elapsed, in
|
4564
|
-
# seconds, after the request leaves the load balancer until a
|
4565
|
-
# response from the target instance is received.
|
4566
|
-
#
|
4567
|
-
# `Statistics`\: The most useful statistic is `Average`.
|
4568
|
-
#
|
4569
|
-
# * <b> <code>RejectedConnectionCount</code> </b> - The number of
|
4570
|
-
# connections that were rejected because the load balancer had
|
4571
|
-
# reached its maximum number of connections.
|
4572
|
-
#
|
4573
|
-
# `Statistics`\: The most useful statistic is `Sum`.
|
4574
|
-
#
|
4575
|
-
# * <b> <code>RequestCount</code> </b> - The number of requests
|
4576
|
-
# processed over IPv4. This count includes only the requests with a
|
4577
|
-
# response generated by a target instance of the load balancer.
|
4578
|
-
#
|
4579
|
-
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
4580
|
-
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
5320
|
+
# The name of the metric returned.
|
4581
5321
|
# @return [String]
|
4582
5322
|
#
|
4583
5323
|
# @!attribute [rw] metric_data
|
4584
|
-
# An array of metric
|
5324
|
+
# An array of objects that describe the metric data returned.
|
4585
5325
|
# @return [Array<Types::MetricDatapoint>]
|
4586
5326
|
#
|
4587
5327
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricDataResult AWS API Documentation
|
@@ -4660,7 +5400,11 @@ module Aws::Lightsail
|
|
4660
5400
|
# }
|
4661
5401
|
#
|
4662
5402
|
# @!attribute [rw] page_token
|
4663
|
-
#
|
5403
|
+
# The token to advance to the next page of results from your request.
|
5404
|
+
#
|
5405
|
+
# To get a page token, perform an initial `GetLoadBalancers` request.
|
5406
|
+
# If your results are paginated, the response will return a next page
|
5407
|
+
# token that you can specify as the page token in a subsequent
|
4664
5408
|
# request.
|
4665
5409
|
# @return [String]
|
4666
5410
|
#
|
@@ -4676,8 +5420,14 @@ module Aws::Lightsail
|
|
4676
5420
|
# @return [Array<Types::LoadBalancer>]
|
4677
5421
|
#
|
4678
5422
|
# @!attribute [rw] next_page_token
|
4679
|
-
#
|
4680
|
-
#
|
5423
|
+
# The token to advance to the next page of resutls from your request.
|
5424
|
+
#
|
5425
|
+
# A next page token is not returned if there are no more results to
|
5426
|
+
# display.
|
5427
|
+
#
|
5428
|
+
# To get the next page of results, perform another `GetLoadBalancers`
|
5429
|
+
# request and specify the next page token using the `pageToken`
|
5430
|
+
# parameter.
|
4681
5431
|
# @return [String]
|
4682
5432
|
#
|
4683
5433
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancersResult AWS API Documentation
|
@@ -4707,8 +5457,9 @@ module Aws::Lightsail
|
|
4707
5457
|
end
|
4708
5458
|
|
4709
5459
|
# @!attribute [rw] operation
|
4710
|
-
# An array of
|
4711
|
-
# of
|
5460
|
+
# An array of objects that describe the result of the action, such as
|
5461
|
+
# the status of the request, the timestamp of the request, and the
|
5462
|
+
# resources affected by the request.
|
4712
5463
|
# @return [Types::Operation]
|
4713
5464
|
#
|
4714
5465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationResult AWS API Documentation
|
@@ -4731,8 +5482,12 @@ module Aws::Lightsail
|
|
4731
5482
|
# @return [String]
|
4732
5483
|
#
|
4733
5484
|
# @!attribute [rw] page_token
|
4734
|
-
#
|
4735
|
-
#
|
5485
|
+
# The token to advance to the next page of results from your request.
|
5486
|
+
#
|
5487
|
+
# To get a page token, perform an initial `GetOperationsForResource`
|
5488
|
+
# request. If your results are paginated, the response will return a
|
5489
|
+
# next page token that you can specify as the page token in a
|
5490
|
+
# subsequent request.
|
4736
5491
|
# @return [String]
|
4737
5492
|
#
|
4738
5493
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResourceRequest AWS API Documentation
|
@@ -4744,8 +5499,9 @@ module Aws::Lightsail
|
|
4744
5499
|
end
|
4745
5500
|
|
4746
5501
|
# @!attribute [rw] operations
|
4747
|
-
# An array of
|
4748
|
-
# of
|
5502
|
+
# An array of objects that describe the result of the action, such as
|
5503
|
+
# the status of the request, the timestamp of the request, and the
|
5504
|
+
# resources affected by the request.
|
4749
5505
|
# @return [Array<Types::Operation>]
|
4750
5506
|
#
|
4751
5507
|
# @!attribute [rw] next_page_count
|
@@ -4759,9 +5515,14 @@ module Aws::Lightsail
|
|
4759
5515
|
# @return [String]
|
4760
5516
|
#
|
4761
5517
|
# @!attribute [rw] next_page_token
|
4762
|
-
#
|
4763
|
-
#
|
4764
|
-
#
|
5518
|
+
# The token to advance to the next page of resutls from your request.
|
5519
|
+
#
|
5520
|
+
# A next page token is not returned if there are no more results to
|
5521
|
+
# display.
|
5522
|
+
#
|
5523
|
+
# To get the next page of results, perform another
|
5524
|
+
# `GetOperationsForResource` request and specify the next page token
|
5525
|
+
# using the `pageToken` parameter.
|
4765
5526
|
# @return [String]
|
4766
5527
|
#
|
4767
5528
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResourceResult AWS API Documentation
|
@@ -4781,8 +5542,12 @@ module Aws::Lightsail
|
|
4781
5542
|
# }
|
4782
5543
|
#
|
4783
5544
|
# @!attribute [rw] page_token
|
4784
|
-
#
|
4785
|
-
#
|
5545
|
+
# The token to advance to the next page of results from your request.
|
5546
|
+
#
|
5547
|
+
# To get a page token, perform an initial `GetOperations` request. If
|
5548
|
+
# your results are paginated, the response will return a next page
|
5549
|
+
# token that you can specify as the page token in a subsequent
|
5550
|
+
# request.
|
4786
5551
|
# @return [String]
|
4787
5552
|
#
|
4788
5553
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsRequest AWS API Documentation
|
@@ -4793,13 +5558,20 @@ module Aws::Lightsail
|
|
4793
5558
|
end
|
4794
5559
|
|
4795
5560
|
# @!attribute [rw] operations
|
4796
|
-
# An array of
|
4797
|
-
# of
|
5561
|
+
# An array of objects that describe the result of the action, such as
|
5562
|
+
# the status of the request, the timestamp of the request, and the
|
5563
|
+
# resources affected by the request.
|
4798
5564
|
# @return [Array<Types::Operation>]
|
4799
5565
|
#
|
4800
5566
|
# @!attribute [rw] next_page_token
|
4801
|
-
#
|
4802
|
-
#
|
5567
|
+
# The token to advance to the next page of resutls from your request.
|
5568
|
+
#
|
5569
|
+
# A next page token is not returned if there are no more results to
|
5570
|
+
# display.
|
5571
|
+
#
|
5572
|
+
# To get the next page of results, perform another `GetOperations`
|
5573
|
+
# request and specify the next page token using the `pageToken`
|
5574
|
+
# parameter.
|
4803
5575
|
# @return [String]
|
4804
5576
|
#
|
4805
5577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsResult AWS API Documentation
|
@@ -4858,8 +5630,12 @@ module Aws::Lightsail
|
|
4858
5630
|
# }
|
4859
5631
|
#
|
4860
5632
|
# @!attribute [rw] page_token
|
4861
|
-
#
|
4862
|
-
#
|
5633
|
+
# The token to advance to the next page of results from your request.
|
5634
|
+
#
|
5635
|
+
# To get a page token, perform an initial
|
5636
|
+
# `GetRelationalDatabaseBlueprints` request. If your results are
|
5637
|
+
# paginated, the response will return a next page token that you can
|
5638
|
+
# specify as the page token in a subsequent request.
|
4863
5639
|
# @return [String]
|
4864
5640
|
#
|
4865
5641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprintsRequest AWS API Documentation
|
@@ -4875,8 +5651,14 @@ module Aws::Lightsail
|
|
4875
5651
|
# @return [Array<Types::RelationalDatabaseBlueprint>]
|
4876
5652
|
#
|
4877
5653
|
# @!attribute [rw] next_page_token
|
4878
|
-
#
|
4879
|
-
#
|
5654
|
+
# The token to advance to the next page of resutls from your request.
|
5655
|
+
#
|
5656
|
+
# A next page token is not returned if there are no more results to
|
5657
|
+
# display.
|
5658
|
+
#
|
5659
|
+
# To get the next page of results, perform another
|
5660
|
+
# `GetRelationalDatabaseBlueprints` request and specify the next page
|
5661
|
+
# token using the `pageToken` parameter.
|
4880
5662
|
# @return [String]
|
4881
5663
|
#
|
4882
5664
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprintsResult AWS API Documentation
|
@@ -4895,8 +5677,12 @@ module Aws::Lightsail
|
|
4895
5677
|
# }
|
4896
5678
|
#
|
4897
5679
|
# @!attribute [rw] page_token
|
4898
|
-
#
|
4899
|
-
#
|
5680
|
+
# The token to advance to the next page of results from your request.
|
5681
|
+
#
|
5682
|
+
# To get a page token, perform an initial
|
5683
|
+
# `GetRelationalDatabaseBundles` request. If your results are
|
5684
|
+
# paginated, the response will return a next page token that you can
|
5685
|
+
# specify as the page token in a subsequent request.
|
4900
5686
|
# @return [String]
|
4901
5687
|
#
|
4902
5688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundlesRequest AWS API Documentation
|
@@ -4912,8 +5698,14 @@ module Aws::Lightsail
|
|
4912
5698
|
# @return [Array<Types::RelationalDatabaseBundle>]
|
4913
5699
|
#
|
4914
5700
|
# @!attribute [rw] next_page_token
|
4915
|
-
#
|
4916
|
-
#
|
5701
|
+
# The token to advance to the next page of resutls from your request.
|
5702
|
+
#
|
5703
|
+
# A next page token is not returned if there are no more results to
|
5704
|
+
# display.
|
5705
|
+
#
|
5706
|
+
# To get the next page of results, perform another
|
5707
|
+
# `GetRelationalDatabaseBundles` request and specify the next page
|
5708
|
+
# token using the `pageToken` parameter.
|
4917
5709
|
# @return [String]
|
4918
5710
|
#
|
4919
5711
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundlesResult AWS API Documentation
|
@@ -4947,8 +5739,12 @@ module Aws::Lightsail
|
|
4947
5739
|
# @return [Integer]
|
4948
5740
|
#
|
4949
5741
|
# @!attribute [rw] page_token
|
4950
|
-
#
|
4951
|
-
#
|
5742
|
+
# The token to advance to the next page of results from your request.
|
5743
|
+
#
|
5744
|
+
# To get a page token, perform an initial
|
5745
|
+
# `GetRelationalDatabaseEvents` request. If your results are
|
5746
|
+
# paginated, the response will return a next page token that you can
|
5747
|
+
# specify as the page token in a subsequent request.
|
4952
5748
|
# @return [String]
|
4953
5749
|
#
|
4954
5750
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEventsRequest AWS API Documentation
|
@@ -4966,8 +5762,14 @@ module Aws::Lightsail
|
|
4966
5762
|
# @return [Array<Types::RelationalDatabaseEvent>]
|
4967
5763
|
#
|
4968
5764
|
# @!attribute [rw] next_page_token
|
4969
|
-
#
|
4970
|
-
#
|
5765
|
+
# The token to advance to the next page of resutls from your request.
|
5766
|
+
#
|
5767
|
+
# A next page token is not returned if there are no more results to
|
5768
|
+
# display.
|
5769
|
+
#
|
5770
|
+
# To get the next page of results, perform another
|
5771
|
+
# `GetRelationalDatabaseEvents` request and specify the next page
|
5772
|
+
# token using the `pageToken` parameter.
|
4971
5773
|
# @return [String]
|
4972
5774
|
#
|
4973
5775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEventsResult AWS API Documentation
|
@@ -5040,8 +5842,14 @@ module Aws::Lightsail
|
|
5040
5842
|
# @return [Boolean]
|
5041
5843
|
#
|
5042
5844
|
# @!attribute [rw] page_token
|
5043
|
-
#
|
5044
|
-
#
|
5845
|
+
# The token to advance to the next or previous page of results from
|
5846
|
+
# your request.
|
5847
|
+
#
|
5848
|
+
# To get a page token, perform an initial
|
5849
|
+
# `GetRelationalDatabaseLogEvents` request. If your results are
|
5850
|
+
# paginated, the response will return a next forward token and/or next
|
5851
|
+
# backward token that you can specify as the page token in a
|
5852
|
+
# subsequent request.
|
5045
5853
|
# @return [String]
|
5046
5854
|
#
|
5047
5855
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEventsRequest AWS API Documentation
|
@@ -5177,11 +5985,66 @@ module Aws::Lightsail
|
|
5177
5985
|
# @return [String]
|
5178
5986
|
#
|
5179
5987
|
# @!attribute [rw] metric_name
|
5180
|
-
# The
|
5988
|
+
# The metric for which you want to return information.
|
5989
|
+
#
|
5990
|
+
# Valid relational database metric names are listed below, along with
|
5991
|
+
# the most useful `statistics` to include in your request, and the
|
5992
|
+
# published `unit` value. All relational database metric data is
|
5993
|
+
# available in 1-minute (60 seconds) granularity.
|
5994
|
+
#
|
5995
|
+
# * <b> <code>CPUUtilization</code> </b> - The percentage of CPU
|
5996
|
+
# utilization currently in use on the database.
|
5997
|
+
#
|
5998
|
+
# `Statistics`\: The most useful statistics are `Maximum` and
|
5999
|
+
# `Average`.
|
6000
|
+
#
|
6001
|
+
# `Unit`\: The published unit is `Percent`.
|
6002
|
+
#
|
6003
|
+
# * <b> <code>DatabaseConnections</code> </b> - The number of database
|
6004
|
+
# connections in use.
|
6005
|
+
#
|
6006
|
+
# `Statistics`\: The most useful statistics are `Maximum` and `Sum`.
|
6007
|
+
#
|
6008
|
+
# `Unit`\: The published unit is `Count`.
|
6009
|
+
#
|
6010
|
+
# * <b> <code>DiskQueueDepth</code> </b> - The number of outstanding
|
6011
|
+
# IOs (read/write requests) that are waiting to access the disk.
|
6012
|
+
#
|
6013
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
6014
|
+
#
|
6015
|
+
# `Unit`\: The published unit is `Count`.
|
6016
|
+
#
|
6017
|
+
# * <b> <code>FreeStorageSpace</code> </b> - The amount of available
|
6018
|
+
# storage space.
|
6019
|
+
#
|
6020
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
6021
|
+
#
|
6022
|
+
# `Unit`\: The published unit is `Bytes`.
|
6023
|
+
#
|
6024
|
+
# * <b> <code>NetworkReceiveThroughput</code> </b> - The incoming
|
6025
|
+
# (Receive) network traffic on the database, including both customer
|
6026
|
+
# database traffic and AWS traffic used for monitoring and
|
6027
|
+
# replication.
|
6028
|
+
#
|
6029
|
+
# `Statistics`\: The most useful statistic is `Average`.
|
6030
|
+
#
|
6031
|
+
# `Unit`\: The published unit is `Bytes/Second`.
|
6032
|
+
#
|
6033
|
+
# * <b> <code>NetworkTransmitThroughput</code> </b> - The outgoing
|
6034
|
+
# (Transmit) network traffic on the database, including both
|
6035
|
+
# customer database traffic and AWS traffic used for monitoring and
|
6036
|
+
# replication.
|
6037
|
+
#
|
6038
|
+
# `Statistics`\: The most useful statistic is `Average`.
|
6039
|
+
#
|
6040
|
+
# `Unit`\: The published unit is `Bytes/Second`.
|
5181
6041
|
# @return [String]
|
5182
6042
|
#
|
5183
6043
|
# @!attribute [rw] period
|
5184
6044
|
# The granularity, in seconds, of the returned data points.
|
6045
|
+
#
|
6046
|
+
# All relational database metric data is available in 1-minute (60
|
6047
|
+
# seconds) granularity.
|
5185
6048
|
# @return [Integer]
|
5186
6049
|
#
|
5187
6050
|
# @!attribute [rw] start_time
|
@@ -5211,11 +6074,37 @@ module Aws::Lightsail
|
|
5211
6074
|
# @return [Time]
|
5212
6075
|
#
|
5213
6076
|
# @!attribute [rw] unit
|
5214
|
-
# The unit for the metric data request.
|
6077
|
+
# The unit for the metric data request. Valid units depend on the
|
6078
|
+
# metric data being requested. For the valid units with each available
|
6079
|
+
# metric, see the `metricName` parameter.
|
5215
6080
|
# @return [String]
|
5216
6081
|
#
|
5217
6082
|
# @!attribute [rw] statistics
|
5218
|
-
# The
|
6083
|
+
# The statistic for the metric.
|
6084
|
+
#
|
6085
|
+
# The following statistics are available:
|
6086
|
+
#
|
6087
|
+
# * `Minimum` - The lowest value observed during the specified period.
|
6088
|
+
# Use this value to determine low volumes of activity for your
|
6089
|
+
# application.
|
6090
|
+
#
|
6091
|
+
# * `Maximum` - The highest value observed during the specified
|
6092
|
+
# period. Use this value to determine high volumes of activity for
|
6093
|
+
# your application.
|
6094
|
+
#
|
6095
|
+
# * `Sum` - All values submitted for the matching metric added
|
6096
|
+
# together. You can use this statistic to determine the total volume
|
6097
|
+
# of a metric.
|
6098
|
+
#
|
6099
|
+
# * `Average` - The value of Sum / SampleCount during the specified
|
6100
|
+
# period. By comparing this statistic with the Minimum and Maximum
|
6101
|
+
# values, you can determine the full scope of a metric and how close
|
6102
|
+
# the average use is to the Minimum and Maximum values. This
|
6103
|
+
# comparison helps you to know when to increase or decrease your
|
6104
|
+
# resources.
|
6105
|
+
#
|
6106
|
+
# * `SampleCount` - The count, or number, of data points used for the
|
6107
|
+
# statistical calculation.
|
5219
6108
|
# @return [Array<String>]
|
5220
6109
|
#
|
5221
6110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricDataRequest AWS API Documentation
|
@@ -5232,12 +6121,11 @@ module Aws::Lightsail
|
|
5232
6121
|
end
|
5233
6122
|
|
5234
6123
|
# @!attribute [rw] metric_name
|
5235
|
-
# The name of the metric.
|
6124
|
+
# The name of the metric returned.
|
5236
6125
|
# @return [String]
|
5237
6126
|
#
|
5238
6127
|
# @!attribute [rw] metric_data
|
5239
|
-
# An
|
5240
|
-
# metric data request.
|
6128
|
+
# An array of objects that describe the metric data returned.
|
5241
6129
|
# @return [Array<Types::MetricDatapoint>]
|
5242
6130
|
#
|
5243
6131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricDataResult AWS API Documentation
|
@@ -5261,8 +6149,12 @@ module Aws::Lightsail
|
|
5261
6149
|
# @return [String]
|
5262
6150
|
#
|
5263
6151
|
# @!attribute [rw] page_token
|
5264
|
-
#
|
5265
|
-
#
|
6152
|
+
# The token to advance to the next page of results from your request.
|
6153
|
+
#
|
6154
|
+
# To get a page token, perform an initial
|
6155
|
+
# `GetRelationalDatabaseParameters` request. If your results are
|
6156
|
+
# paginated, the response will return a next page token that you can
|
6157
|
+
# specify as the page token in a subsequent request.
|
5266
6158
|
# @return [String]
|
5267
6159
|
#
|
5268
6160
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParametersRequest AWS API Documentation
|
@@ -5279,8 +6171,14 @@ module Aws::Lightsail
|
|
5279
6171
|
# @return [Array<Types::RelationalDatabaseParameter>]
|
5280
6172
|
#
|
5281
6173
|
# @!attribute [rw] next_page_token
|
5282
|
-
#
|
5283
|
-
#
|
6174
|
+
# The token to advance to the next page of resutls from your request.
|
6175
|
+
#
|
6176
|
+
# A next page token is not returned if there are no more results to
|
6177
|
+
# display.
|
6178
|
+
#
|
6179
|
+
# To get the next page of results, perform another
|
6180
|
+
# `GetRelationalDatabaseParameters` request and specify the next page
|
6181
|
+
# token using the `pageToken` parameter.
|
5284
6182
|
# @return [String]
|
5285
6183
|
#
|
5286
6184
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParametersResult AWS API Documentation
|
@@ -5357,8 +6255,12 @@ module Aws::Lightsail
|
|
5357
6255
|
# }
|
5358
6256
|
#
|
5359
6257
|
# @!attribute [rw] page_token
|
5360
|
-
#
|
5361
|
-
#
|
6258
|
+
# The token to advance to the next page of results from your request.
|
6259
|
+
#
|
6260
|
+
# To get a page token, perform an initial
|
6261
|
+
# `GetRelationalDatabaseSnapshots` request. If your results are
|
6262
|
+
# paginated, the response will return a next page token that you can
|
6263
|
+
# specify as the page token in a subsequent request.
|
5362
6264
|
# @return [String]
|
5363
6265
|
#
|
5364
6266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotsRequest AWS API Documentation
|
@@ -5374,8 +6276,14 @@ module Aws::Lightsail
|
|
5374
6276
|
# @return [Array<Types::RelationalDatabaseSnapshot>]
|
5375
6277
|
#
|
5376
6278
|
# @!attribute [rw] next_page_token
|
5377
|
-
#
|
5378
|
-
#
|
6279
|
+
# The token to advance to the next page of resutls from your request.
|
6280
|
+
#
|
6281
|
+
# A next page token is not returned if there are no more results to
|
6282
|
+
# display.
|
6283
|
+
#
|
6284
|
+
# To get the next page of results, perform another
|
6285
|
+
# `GetRelationalDatabaseSnapshots` request and specify the next page
|
6286
|
+
# token using the `pageToken` parameter.
|
5379
6287
|
# @return [String]
|
5380
6288
|
#
|
5381
6289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotsResult AWS API Documentation
|
@@ -5394,8 +6302,12 @@ module Aws::Lightsail
|
|
5394
6302
|
# }
|
5395
6303
|
#
|
5396
6304
|
# @!attribute [rw] page_token
|
5397
|
-
#
|
5398
|
-
#
|
6305
|
+
# The token to advance to the next page of results from your request.
|
6306
|
+
#
|
6307
|
+
# To get a page token, perform an initial `GetRelationalDatabases`
|
6308
|
+
# request. If your results are paginated, the response will return a
|
6309
|
+
# next page token that you can specify as the page token in a
|
6310
|
+
# subsequent request.
|
5399
6311
|
# @return [String]
|
5400
6312
|
#
|
5401
6313
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabasesRequest AWS API Documentation
|
@@ -5411,8 +6323,14 @@ module Aws::Lightsail
|
|
5411
6323
|
# @return [Array<Types::RelationalDatabase>]
|
5412
6324
|
#
|
5413
6325
|
# @!attribute [rw] next_page_token
|
5414
|
-
#
|
5415
|
-
#
|
6326
|
+
# The token to advance to the next page of resutls from your request.
|
6327
|
+
#
|
6328
|
+
# A next page token is not returned if there are no more results to
|
6329
|
+
# display.
|
6330
|
+
#
|
6331
|
+
# To get the next page of results, perform another
|
6332
|
+
# `GetRelationalDatabases` request and specify the next page token
|
6333
|
+
# using the `pageToken` parameter.
|
5416
6334
|
# @return [String]
|
5417
6335
|
#
|
5418
6336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabasesResult AWS API Documentation
|
@@ -5461,8 +6379,12 @@ module Aws::Lightsail
|
|
5461
6379
|
# }
|
5462
6380
|
#
|
5463
6381
|
# @!attribute [rw] page_token
|
5464
|
-
#
|
5465
|
-
#
|
6382
|
+
# The token to advance to the next page of results from your request.
|
6383
|
+
#
|
6384
|
+
# To get a page token, perform an initial `GetStaticIps` request. If
|
6385
|
+
# your results are paginated, the response will return a next page
|
6386
|
+
# token that you can specify as the page token in a subsequent
|
6387
|
+
# request.
|
5466
6388
|
# @return [String]
|
5467
6389
|
#
|
5468
6390
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpsRequest AWS API Documentation
|
@@ -5478,8 +6400,14 @@ module Aws::Lightsail
|
|
5478
6400
|
# @return [Array<Types::StaticIp>]
|
5479
6401
|
#
|
5480
6402
|
# @!attribute [rw] next_page_token
|
5481
|
-
#
|
5482
|
-
#
|
6403
|
+
# The token to advance to the next page of resutls from your request.
|
6404
|
+
#
|
6405
|
+
# A next page token is not returned if there are no more results to
|
6406
|
+
# display.
|
6407
|
+
#
|
6408
|
+
# To get the next page of results, perform another `GetStaticIps`
|
6409
|
+
# request and specify the next page token using the `pageToken`
|
6410
|
+
# parameter.
|
5483
6411
|
# @return [String]
|
5484
6412
|
#
|
5485
6413
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpsResult AWS API Documentation
|
@@ -5586,8 +6514,9 @@ module Aws::Lightsail
|
|
5586
6514
|
end
|
5587
6515
|
|
5588
6516
|
# @!attribute [rw] operation
|
5589
|
-
# An array of
|
5590
|
-
#
|
6517
|
+
# An array of objects that describe the result of the action, such as
|
6518
|
+
# the status of the request, the timestamp of the request, and the
|
6519
|
+
# resources affected by the request.
|
5591
6520
|
# @return [Types::Operation]
|
5592
6521
|
#
|
5593
6522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPairResult AWS API Documentation
|
@@ -5836,14 +6765,22 @@ module Aws::Lightsail
|
|
5836
6765
|
#
|
5837
6766
|
# The following configuration options are available:
|
5838
6767
|
#
|
5839
|
-
# * DEFAULT
|
6768
|
+
# * `DEFAULT` - Use the default firewall settings from the Lightsail
|
6769
|
+
# instance blueprint.
|
6770
|
+
#
|
6771
|
+
# * `INSTANCE` - Use the configured firewall settings from the source
|
6772
|
+
# Lightsail instance.
|
6773
|
+
#
|
6774
|
+
# * `NONE` - Use the default Amazon EC2 security group.
|
5840
6775
|
#
|
5841
|
-
# *
|
5842
|
-
# instance.
|
6776
|
+
# * `CLOSED` - All ports closed.
|
5843
6777
|
#
|
5844
|
-
#
|
6778
|
+
# <note markdown="1"> If you configured `lightsail-connect` as a `cidrListAliases` on your
|
6779
|
+
# instance, or if you chose to allow the Lightsail browser-based SSH
|
6780
|
+
# or RDP clients to connect to your instance, that configuration is
|
6781
|
+
# not carried over to your new Amazon EC2 instance.
|
5845
6782
|
#
|
5846
|
-
#
|
6783
|
+
# </note>
|
5847
6784
|
# @return [String]
|
5848
6785
|
#
|
5849
6786
|
# @!attribute [rw] user_data
|
@@ -5998,18 +6935,44 @@ module Aws::Lightsail
|
|
5998
6935
|
include Aws::Structure
|
5999
6936
|
end
|
6000
6937
|
|
6001
|
-
# Describes information about
|
6938
|
+
# Describes information about ports for an Amazon Lightsail instance.
|
6939
|
+
#
|
6940
|
+
# @!attribute [rw] from_port
|
6941
|
+
# The first port in a range of open ports on an instance.
|
6942
|
+
#
|
6943
|
+
# Allowed ports:
|
6944
|
+
#
|
6945
|
+
# * TCP and UDP - `0` to `65535`
|
6002
6946
|
#
|
6003
|
-
#
|
6004
|
-
#
|
6947
|
+
# * ICMP - `8` (to configure Ping)
|
6948
|
+
#
|
6949
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
6950
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
6951
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
6952
|
+
#
|
6953
|
+
# </note>
|
6005
6954
|
# @return [Integer]
|
6006
6955
|
#
|
6007
6956
|
# @!attribute [rw] to_port
|
6008
|
-
# The last port in
|
6957
|
+
# The last port in a range of open ports on an instance.
|
6958
|
+
#
|
6959
|
+
# Allowed ports:
|
6960
|
+
#
|
6961
|
+
# * TCP and UDP - `0` to `65535`
|
6962
|
+
#
|
6963
|
+
# * ICMP - `-1` (to configure Ping)
|
6964
|
+
#
|
6965
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
6966
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
6967
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
6968
|
+
#
|
6969
|
+
# </note>
|
6009
6970
|
# @return [Integer]
|
6010
6971
|
#
|
6011
6972
|
# @!attribute [rw] protocol
|
6012
|
-
# The protocol
|
6973
|
+
# The IP protocol name.
|
6974
|
+
#
|
6975
|
+
# The name can be one of the following:
|
6013
6976
|
#
|
6014
6977
|
# * `tcp` - Transmission Control Protocol (TCP) provides reliable,
|
6015
6978
|
# ordered, and error-checked delivery of streamed data between
|
@@ -6018,7 +6981,7 @@ module Aws::Lightsail
|
|
6018
6981
|
# service, use UDP instead.
|
6019
6982
|
#
|
6020
6983
|
# * `all` - All transport layer protocol types. For more general
|
6021
|
-
# information, see [Transport layer][1] on Wikipedia
|
6984
|
+
# information, see [Transport layer][1] on *Wikipedia*.
|
6022
6985
|
#
|
6023
6986
|
# * `udp` - With User Datagram Protocol (UDP), computer applications
|
6024
6987
|
# can send messages (or datagrams) to other hosts on an Internet
|
@@ -6029,14 +6992,26 @@ module Aws::Lightsail
|
|
6029
6992
|
# latency over reliability. If you do require reliable data stream
|
6030
6993
|
# service, use TCP instead.
|
6031
6994
|
#
|
6995
|
+
# * `icmp` - Internet Control Message Protocol (ICMP) is used to send
|
6996
|
+
# error messages and operational information indicating success or
|
6997
|
+
# failure when communicating with an instance. For example, an error
|
6998
|
+
# is indicated when an instance could not be reached.
|
6999
|
+
#
|
7000
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
7001
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
7002
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
7003
|
+
#
|
7004
|
+
# </note>
|
7005
|
+
#
|
6032
7006
|
#
|
6033
7007
|
#
|
6034
7008
|
# [1]: https://en.wikipedia.org/wiki/Transport_layer
|
6035
7009
|
# @return [String]
|
6036
7010
|
#
|
6037
7011
|
# @!attribute [rw] access_from
|
6038
|
-
# The location from which access is allowed
|
6039
|
-
# (0.0.0.0/0)`
|
7012
|
+
# The location from which access is allowed. For example, `Anywhere
|
7013
|
+
# (0.0.0.0/0)`, or `Custom` if a specific IP address or range of IP
|
7014
|
+
# addresses is allowed.
|
6040
7015
|
# @return [String]
|
6041
7016
|
#
|
6042
7017
|
# @!attribute [rw] access_type
|
@@ -6044,13 +7019,39 @@ module Aws::Lightsail
|
|
6044
7019
|
# @return [String]
|
6045
7020
|
#
|
6046
7021
|
# @!attribute [rw] common_name
|
6047
|
-
# The common name.
|
7022
|
+
# The common name of the port information.
|
6048
7023
|
# @return [String]
|
6049
7024
|
#
|
6050
7025
|
# @!attribute [rw] access_direction
|
6051
7026
|
# The access direction (`inbound` or `outbound`).
|
7027
|
+
#
|
7028
|
+
# <note markdown="1"> Lightsail currently supports only `inbound` access direction.
|
7029
|
+
#
|
7030
|
+
# </note>
|
6052
7031
|
# @return [String]
|
6053
7032
|
#
|
7033
|
+
# @!attribute [rw] cidrs
|
7034
|
+
# The IP address, or range of IP addresses in CIDR notation, that are
|
7035
|
+
# allowed to connect to an instance through the ports, and the
|
7036
|
+
# protocol. Lightsail supports IPv4 addresses.
|
7037
|
+
#
|
7038
|
+
# For more information about CIDR block notation, see [Classless
|
7039
|
+
# Inter-Domain Routing][1] on *Wikipedia*.
|
7040
|
+
#
|
7041
|
+
#
|
7042
|
+
#
|
7043
|
+
# [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation
|
7044
|
+
# @return [Array<String>]
|
7045
|
+
#
|
7046
|
+
# @!attribute [rw] cidr_list_aliases
|
7047
|
+
# An alias that defines access for a preconfigured range of IP
|
7048
|
+
# addresses.
|
7049
|
+
#
|
7050
|
+
# The only alias currently supported is `lightsail-connect`, which
|
7051
|
+
# allows IP addresses of the browser-based RDP/SSH client in the
|
7052
|
+
# Lightsail console to connect to your instance.
|
7053
|
+
# @return [Array<String>]
|
7054
|
+
#
|
6054
7055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstancePortInfo AWS API Documentation
|
6055
7056
|
#
|
6056
7057
|
class InstancePortInfo < Struct.new(
|
@@ -6060,22 +7061,51 @@ module Aws::Lightsail
|
|
6060
7061
|
:access_from,
|
6061
7062
|
:access_type,
|
6062
7063
|
:common_name,
|
6063
|
-
:access_direction
|
7064
|
+
:access_direction,
|
7065
|
+
:cidrs,
|
7066
|
+
:cidr_list_aliases)
|
6064
7067
|
include Aws::Structure
|
6065
7068
|
end
|
6066
7069
|
|
6067
|
-
# Describes the
|
7070
|
+
# Describes open ports on an instance, the IP addresses allowed to
|
7071
|
+
# connect to the instance through the ports, and the protocol.
|
6068
7072
|
#
|
6069
7073
|
# @!attribute [rw] from_port
|
6070
|
-
# The first port in
|
7074
|
+
# The first port in a range of open ports on an instance.
|
7075
|
+
#
|
7076
|
+
# Allowed ports:
|
7077
|
+
#
|
7078
|
+
# * TCP and UDP - `0` to `65535`
|
7079
|
+
#
|
7080
|
+
# * ICMP - `8` (to configure Ping)
|
7081
|
+
#
|
7082
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
7083
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
7084
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
7085
|
+
#
|
7086
|
+
# </note>
|
6071
7087
|
# @return [Integer]
|
6072
7088
|
#
|
6073
7089
|
# @!attribute [rw] to_port
|
6074
|
-
# The last port in
|
7090
|
+
# The last port in a range of open ports on an instance.
|
7091
|
+
#
|
7092
|
+
# Allowed ports:
|
7093
|
+
#
|
7094
|
+
# * TCP and UDP - `0` to `65535`
|
7095
|
+
#
|
7096
|
+
# * ICMP - `-1` (to configure Ping)
|
7097
|
+
#
|
7098
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
7099
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
7100
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
7101
|
+
#
|
7102
|
+
# </note>
|
6075
7103
|
# @return [Integer]
|
6076
7104
|
#
|
6077
7105
|
# @!attribute [rw] protocol
|
6078
|
-
# The protocol
|
7106
|
+
# The IP protocol name.
|
7107
|
+
#
|
7108
|
+
# The name can be one of the following:
|
6079
7109
|
#
|
6080
7110
|
# * `tcp` - Transmission Control Protocol (TCP) provides reliable,
|
6081
7111
|
# ordered, and error-checked delivery of streamed data between
|
@@ -6084,7 +7114,7 @@ module Aws::Lightsail
|
|
6084
7114
|
# service, use UDP instead.
|
6085
7115
|
#
|
6086
7116
|
# * `all` - All transport layer protocol types. For more general
|
6087
|
-
# information, see [Transport layer][1] on Wikipedia
|
7117
|
+
# information, see [Transport layer][1] on *Wikipedia*.
|
6088
7118
|
#
|
6089
7119
|
# * `udp` - With User Datagram Protocol (UDP), computer applications
|
6090
7120
|
# can send messages (or datagrams) to other hosts on an Internet
|
@@ -6095,6 +7125,17 @@ module Aws::Lightsail
|
|
6095
7125
|
# latency over reliability. If you do require reliable data stream
|
6096
7126
|
# service, use TCP instead.
|
6097
7127
|
#
|
7128
|
+
# * `icmp` - Internet Control Message Protocol (ICMP) is used to send
|
7129
|
+
# error messages and operational information indicating success or
|
7130
|
+
# failure when communicating with an instance. For example, an error
|
7131
|
+
# is indicated when an instance could not be reached.
|
7132
|
+
#
|
7133
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
7134
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
7135
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
7136
|
+
#
|
7137
|
+
# </note>
|
7138
|
+
#
|
6098
7139
|
#
|
6099
7140
|
#
|
6100
7141
|
# [1]: https://en.wikipedia.org/wiki/Transport_layer
|
@@ -6102,15 +7143,43 @@ module Aws::Lightsail
|
|
6102
7143
|
#
|
6103
7144
|
# @!attribute [rw] state
|
6104
7145
|
# Specifies whether the instance port is `open` or `closed`.
|
7146
|
+
#
|
7147
|
+
# <note markdown="1"> The port state for Lightsail instances is always `open`.
|
7148
|
+
#
|
7149
|
+
# </note>
|
6105
7150
|
# @return [String]
|
6106
7151
|
#
|
7152
|
+
# @!attribute [rw] cidrs
|
7153
|
+
# The IP address, or range of IP addresses in CIDR notation, that are
|
7154
|
+
# allowed to connect to an instance through the ports, and the
|
7155
|
+
# protocol. Lightsail supports IPv4 addresses.
|
7156
|
+
#
|
7157
|
+
# For more information about CIDR block notation, see [Classless
|
7158
|
+
# Inter-Domain Routing][1] on *Wikipedia*.
|
7159
|
+
#
|
7160
|
+
#
|
7161
|
+
#
|
7162
|
+
# [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation
|
7163
|
+
# @return [Array<String>]
|
7164
|
+
#
|
7165
|
+
# @!attribute [rw] cidr_list_aliases
|
7166
|
+
# An alias that defines access for a preconfigured range of IP
|
7167
|
+
# addresses.
|
7168
|
+
#
|
7169
|
+
# The only alias currently supported is `lightsail-connect`, which
|
7170
|
+
# allows IP addresses of the browser-based RDP/SSH client in the
|
7171
|
+
# Lightsail console to connect to your instance.
|
7172
|
+
# @return [Array<String>]
|
7173
|
+
#
|
6107
7174
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstancePortState AWS API Documentation
|
6108
7175
|
#
|
6109
7176
|
class InstancePortState < Struct.new(
|
6110
7177
|
:from_port,
|
6111
7178
|
:to_port,
|
6112
7179
|
:protocol,
|
6113
|
-
:state
|
7180
|
+
:state,
|
7181
|
+
:cidrs,
|
7182
|
+
:cidr_list_aliases)
|
6114
7183
|
include Aws::Structure
|
6115
7184
|
end
|
6116
7185
|
|
@@ -6561,7 +7630,8 @@ module Aws::Lightsail
|
|
6561
7630
|
# @return [Boolean]
|
6562
7631
|
#
|
6563
7632
|
# @!attribute [rw] status
|
6564
|
-
# The status of the SSL/TLS certificate. Valid values are
|
7633
|
+
# The validation status of the SSL/TLS certificate. Valid values are
|
7634
|
+
# below.
|
6565
7635
|
# @return [String]
|
6566
7636
|
#
|
6567
7637
|
# @!attribute [rw] domain_name
|
@@ -6823,6 +7893,39 @@ module Aws::Lightsail
|
|
6823
7893
|
include Aws::Structure
|
6824
7894
|
end
|
6825
7895
|
|
7896
|
+
# Describes resource being monitored by an alarm.
|
7897
|
+
#
|
7898
|
+
# An alarm is a way to monitor your Amazon Lightsail resource metrics.
|
7899
|
+
# For more information, see [Alarms in Amazon Lightsail][1].
|
7900
|
+
#
|
7901
|
+
#
|
7902
|
+
#
|
7903
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms
|
7904
|
+
#
|
7905
|
+
# @!attribute [rw] arn
|
7906
|
+
# The Amazon Resource Name (ARN) of the resource being monitored.
|
7907
|
+
# @return [String]
|
7908
|
+
#
|
7909
|
+
# @!attribute [rw] name
|
7910
|
+
# The name of the Lightsail resource being monitored.
|
7911
|
+
# @return [String]
|
7912
|
+
#
|
7913
|
+
# @!attribute [rw] resource_type
|
7914
|
+
# The Lightsail resource type of the resource being monitored.
|
7915
|
+
#
|
7916
|
+
# Instances, load balancers, and relational databases are the only
|
7917
|
+
# Lightsail resources that can currently be monitored by alarms.
|
7918
|
+
# @return [String]
|
7919
|
+
#
|
7920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/MonitoredResourceInfo AWS API Documentation
|
7921
|
+
#
|
7922
|
+
class MonitoredResourceInfo < Struct.new(
|
7923
|
+
:arn,
|
7924
|
+
:name,
|
7925
|
+
:resource_type)
|
7926
|
+
include Aws::Structure
|
7927
|
+
end
|
7928
|
+
|
6826
7929
|
# Describes the monthly data transfer in and out of your virtual private
|
6827
7930
|
# server (or *instance*).
|
6828
7931
|
#
|
@@ -6868,19 +7971,19 @@ module Aws::Lightsail
|
|
6868
7971
|
# port_info: { # required
|
6869
7972
|
# from_port: 1,
|
6870
7973
|
# to_port: 1,
|
6871
|
-
# protocol: "tcp", # accepts tcp, all, udp
|
7974
|
+
# protocol: "tcp", # accepts tcp, all, udp, icmp
|
7975
|
+
# cidrs: ["string"],
|
7976
|
+
# cidr_list_aliases: ["string"],
|
6872
7977
|
# },
|
6873
7978
|
# instance_name: "ResourceName", # required
|
6874
7979
|
# }
|
6875
7980
|
#
|
6876
7981
|
# @!attribute [rw] port_info
|
6877
|
-
# An
|
6878
|
-
# mappings.
|
7982
|
+
# An object to describe the ports to open for the specified instance.
|
6879
7983
|
# @return [Types::PortInfo]
|
6880
7984
|
#
|
6881
7985
|
# @!attribute [rw] instance_name
|
6882
|
-
# The name of the instance for which
|
6883
|
-
# ports.
|
7986
|
+
# The name of the instance for which to open ports.
|
6884
7987
|
# @return [String]
|
6885
7988
|
#
|
6886
7989
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPortsRequest AWS API Documentation
|
@@ -6892,8 +7995,9 @@ module Aws::Lightsail
|
|
6892
7995
|
end
|
6893
7996
|
|
6894
7997
|
# @!attribute [rw] operation
|
6895
|
-
# An array of
|
6896
|
-
#
|
7998
|
+
# An array of objects that describe the result of the action, such as
|
7999
|
+
# the status of the request, the timestamp of the request, and the
|
8000
|
+
# resources affected by the request.
|
6897
8001
|
# @return [Types::Operation]
|
6898
8002
|
#
|
6899
8003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPortsResult AWS API Documentation
|
@@ -7044,8 +8148,9 @@ module Aws::Lightsail
|
|
7044
8148
|
class PeerVpcRequest < Aws::EmptyStructure; end
|
7045
8149
|
|
7046
8150
|
# @!attribute [rw] operation
|
7047
|
-
# An array of
|
7048
|
-
#
|
8151
|
+
# An array of objects that describe the result of the action, such as
|
8152
|
+
# the status of the request, the timestamp of the request, and the
|
8153
|
+
# resources affected by the request.
|
7049
8154
|
# @return [Types::Operation]
|
7050
8155
|
#
|
7051
8156
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpcResult AWS API Documentation
|
@@ -7102,8 +8207,8 @@ module Aws::Lightsail
|
|
7102
8207
|
include Aws::Structure
|
7103
8208
|
end
|
7104
8209
|
|
7105
|
-
# Describes
|
7106
|
-
#
|
8210
|
+
# Describes ports to open on an instance, the IP addresses allowed to
|
8211
|
+
# connect to the instance through the ports, and the protocol.
|
7107
8212
|
#
|
7108
8213
|
# @note When making an API call, you may pass PortInfo
|
7109
8214
|
# data as a hash:
|
@@ -7111,27 +8216,319 @@ module Aws::Lightsail
|
|
7111
8216
|
# {
|
7112
8217
|
# from_port: 1,
|
7113
8218
|
# to_port: 1,
|
7114
|
-
# protocol: "tcp", # accepts tcp, all, udp
|
8219
|
+
# protocol: "tcp", # accepts tcp, all, udp, icmp
|
8220
|
+
# cidrs: ["string"],
|
8221
|
+
# cidr_list_aliases: ["string"],
|
7115
8222
|
# }
|
7116
8223
|
#
|
7117
8224
|
# @!attribute [rw] from_port
|
7118
|
-
# The first port in
|
8225
|
+
# The first port in a range of open ports on an instance.
|
8226
|
+
#
|
8227
|
+
# Allowed ports:
|
8228
|
+
#
|
8229
|
+
# * TCP and UDP - `0` to `65535`
|
8230
|
+
#
|
8231
|
+
# * ICMP - `8` (to configure Ping)
|
8232
|
+
#
|
8233
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
8234
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
8235
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
8236
|
+
#
|
8237
|
+
# </note>
|
7119
8238
|
# @return [Integer]
|
7120
8239
|
#
|
7121
8240
|
# @!attribute [rw] to_port
|
7122
|
-
# The last port in
|
8241
|
+
# The last port in a range of open ports on an instance.
|
8242
|
+
#
|
8243
|
+
# Allowed ports:
|
8244
|
+
#
|
8245
|
+
# * TCP and UDP - `0` to `65535`
|
8246
|
+
#
|
8247
|
+
# * ICMP - `-1` (to configure Ping)
|
8248
|
+
#
|
8249
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
8250
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
8251
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
8252
|
+
#
|
8253
|
+
# </note>
|
7123
8254
|
# @return [Integer]
|
7124
8255
|
#
|
7125
8256
|
# @!attribute [rw] protocol
|
7126
|
-
# The protocol.
|
8257
|
+
# The IP protocol name.
|
8258
|
+
#
|
8259
|
+
# The name can be one of the following:
|
8260
|
+
#
|
8261
|
+
# * `tcp` - Transmission Control Protocol (TCP) provides reliable,
|
8262
|
+
# ordered, and error-checked delivery of streamed data between
|
8263
|
+
# applications running on hosts communicating by an IP network. If
|
8264
|
+
# you have an application that doesn't require reliable data stream
|
8265
|
+
# service, use UDP instead.
|
8266
|
+
#
|
8267
|
+
# * `all` - All transport layer protocol types. For more general
|
8268
|
+
# information, see [Transport layer][1] on *Wikipedia*.
|
8269
|
+
#
|
8270
|
+
# * `udp` - With User Datagram Protocol (UDP), computer applications
|
8271
|
+
# can send messages (or datagrams) to other hosts on an Internet
|
8272
|
+
# Protocol (IP) network. Prior communications are not required to
|
8273
|
+
# set up transmission channels or data paths. Applications that
|
8274
|
+
# don't require reliable data stream service can use UDP, which
|
8275
|
+
# provides a connectionless datagram service that emphasizes reduced
|
8276
|
+
# latency over reliability. If you do require reliable data stream
|
8277
|
+
# service, use TCP instead.
|
8278
|
+
#
|
8279
|
+
# * `icmp` - Internet Control Message Protocol (ICMP) is used to send
|
8280
|
+
# error messages and operational information indicating success or
|
8281
|
+
# failure when communicating with an instance. For example, an error
|
8282
|
+
# is indicated when an instance could not be reached.
|
8283
|
+
#
|
8284
|
+
# <note markdown="1"> Ping is the only communication supported through the ICMP protocol
|
8285
|
+
# in Lightsail. To configure ping, specify the `fromPort` parameter
|
8286
|
+
# as `8`, and the `toPort` parameter as `-1`.
|
8287
|
+
#
|
8288
|
+
# </note>
|
8289
|
+
#
|
8290
|
+
#
|
8291
|
+
#
|
8292
|
+
# [1]: https://en.wikipedia.org/wiki/Transport_layer
|
7127
8293
|
# @return [String]
|
7128
8294
|
#
|
8295
|
+
# @!attribute [rw] cidrs
|
8296
|
+
# The IP address, or range of IP addresses in CIDR notation, that are
|
8297
|
+
# allowed to connect to an instance through the ports, and the
|
8298
|
+
# protocol. Lightsail supports IPv4 addresses.
|
8299
|
+
#
|
8300
|
+
# Examples:
|
8301
|
+
#
|
8302
|
+
# * To allow the IP address `192.0.2.44`, specify `192.0.2.44` or
|
8303
|
+
# `192.0.2.44/32`.
|
8304
|
+
#
|
8305
|
+
# * To allow the IP addresses `192.0.2.0` to `192.0.2.255`, specify
|
8306
|
+
# `192.0.2.0/24`.
|
8307
|
+
#
|
8308
|
+
# For more information about CIDR block notation, see [Classless
|
8309
|
+
# Inter-Domain Routing][1] on *Wikipedia*.
|
8310
|
+
#
|
8311
|
+
#
|
8312
|
+
#
|
8313
|
+
# [1]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation
|
8314
|
+
# @return [Array<String>]
|
8315
|
+
#
|
8316
|
+
# @!attribute [rw] cidr_list_aliases
|
8317
|
+
# An alias that defines access for a preconfigured range of IP
|
8318
|
+
# addresses.
|
8319
|
+
#
|
8320
|
+
# The only alias currently supported is `lightsail-connect`, which
|
8321
|
+
# allows IP addresses of the browser-based RDP/SSH client in the
|
8322
|
+
# Lightsail console to connect to your instance.
|
8323
|
+
# @return [Array<String>]
|
8324
|
+
#
|
7129
8325
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PortInfo AWS API Documentation
|
7130
8326
|
#
|
7131
8327
|
class PortInfo < Struct.new(
|
7132
8328
|
:from_port,
|
7133
8329
|
:to_port,
|
7134
|
-
:protocol
|
8330
|
+
:protocol,
|
8331
|
+
:cidrs,
|
8332
|
+
:cidr_list_aliases)
|
8333
|
+
include Aws::Structure
|
8334
|
+
end
|
8335
|
+
|
8336
|
+
# @note When making an API call, you may pass PutAlarmRequest
|
8337
|
+
# data as a hash:
|
8338
|
+
#
|
8339
|
+
# {
|
8340
|
+
# alarm_name: "ResourceName", # required
|
8341
|
+
# 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
|
8342
|
+
# monitored_resource_name: "ResourceName", # required
|
8343
|
+
# comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
|
8344
|
+
# threshold: 1.0, # required
|
8345
|
+
# evaluation_periods: 1, # required
|
8346
|
+
# datapoints_to_alarm: 1,
|
8347
|
+
# treat_missing_data: "breaching", # accepts breaching, notBreaching, ignore, missing
|
8348
|
+
# contact_protocols: ["Email"], # accepts Email, SMS
|
8349
|
+
# notification_triggers: ["OK"], # accepts OK, ALARM, INSUFFICIENT_DATA
|
8350
|
+
# notification_enabled: false,
|
8351
|
+
# }
|
8352
|
+
#
|
8353
|
+
# @!attribute [rw] alarm_name
|
8354
|
+
# The name for the alarm. Specify the name of an existing alarm to
|
8355
|
+
# update, and overwrite the previous configuration of the alarm.
|
8356
|
+
# @return [String]
|
8357
|
+
#
|
8358
|
+
# @!attribute [rw] metric_name
|
8359
|
+
# The name of the metric to associate with the alarm.
|
8360
|
+
#
|
8361
|
+
# You can configure up to two alarms per metric.
|
8362
|
+
#
|
8363
|
+
# The following metrics are available for each resource type:
|
8364
|
+
#
|
8365
|
+
# * **Instances**\: `BurstCapacityPercentage`, `BurstCapacityTime`,
|
8366
|
+
# `CPUUtilization`, `NetworkIn`, `NetworkOut`, `StatusCheckFailed`,
|
8367
|
+
# `StatusCheckFailed_Instance`, and `StatusCheckFailed_System`.
|
8368
|
+
#
|
8369
|
+
# * **Load balancers**\: `ClientTLSNegotiationErrorCount`,
|
8370
|
+
# `HealthyHostCount`, `UnhealthyHostCount`, `HTTPCode_LB_4XX_Count`,
|
8371
|
+
# `HTTPCode_LB_5XX_Count`, `HTTPCode_Instance_2XX_Count`,
|
8372
|
+
# `HTTPCode_Instance_3XX_Count`, `HTTPCode_Instance_4XX_Count`,
|
8373
|
+
# `HTTPCode_Instance_5XX_Count`, `InstanceResponseTime`,
|
8374
|
+
# `RejectedConnectionCount`, and `RequestCount`.
|
8375
|
+
#
|
8376
|
+
# * **Relational databases**\: `CPUUtilization`,
|
8377
|
+
# `DatabaseConnections`, `DiskQueueDepth`, `FreeStorageSpace`,
|
8378
|
+
# `NetworkReceiveThroughput`, and `NetworkTransmitThroughput`.
|
8379
|
+
#
|
8380
|
+
# For more information about these metrics, see [Metrics available in
|
8381
|
+
# Lightsail][1].
|
8382
|
+
#
|
8383
|
+
#
|
8384
|
+
#
|
8385
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics
|
8386
|
+
# @return [String]
|
8387
|
+
#
|
8388
|
+
# @!attribute [rw] monitored_resource_name
|
8389
|
+
# The name of the Lightsail resource that will be monitored.
|
8390
|
+
#
|
8391
|
+
# Instances, load balancers, and relational databases are the only
|
8392
|
+
# Lightsail resources that can currently be monitored by alarms.
|
8393
|
+
# @return [String]
|
8394
|
+
#
|
8395
|
+
# @!attribute [rw] comparison_operator
|
8396
|
+
# The arithmetic operation to use when comparing the specified
|
8397
|
+
# statistic to the threshold. The specified statistic value is used as
|
8398
|
+
# the first operand.
|
8399
|
+
# @return [String]
|
8400
|
+
#
|
8401
|
+
# @!attribute [rw] threshold
|
8402
|
+
# The value against which the specified statistic is compared.
|
8403
|
+
# @return [Float]
|
8404
|
+
#
|
8405
|
+
# @!attribute [rw] evaluation_periods
|
8406
|
+
# The number of most recent periods over which data is compared to the
|
8407
|
+
# specified threshold. If you are setting an "M out of N" alarm,
|
8408
|
+
# this value (`evaluationPeriods`) is the N.
|
8409
|
+
#
|
8410
|
+
# If you are setting an alarm that requires that a number of
|
8411
|
+
# consecutive data points be breaching to trigger the alarm, this
|
8412
|
+
# value specifies the rolling period of time in which data points are
|
8413
|
+
# evaluated.
|
8414
|
+
#
|
8415
|
+
# Each evaluation period is five minutes long. For example, specify an
|
8416
|
+
# evaluation period of 24 to evaluate a metric over a rolling period
|
8417
|
+
# of two hours.
|
8418
|
+
#
|
8419
|
+
# You can specify a minimum valuation period of 1 (5 minutes), and a
|
8420
|
+
# maximum evaluation period of 288 (24 hours).
|
8421
|
+
# @return [Integer]
|
8422
|
+
#
|
8423
|
+
# @!attribute [rw] datapoints_to_alarm
|
8424
|
+
# The number of data points that must be not within the specified
|
8425
|
+
# threshold to trigger the alarm. If you are setting an "M out of N"
|
8426
|
+
# alarm, this value (`datapointsToAlarm`) is the M.
|
8427
|
+
# @return [Integer]
|
8428
|
+
#
|
8429
|
+
# @!attribute [rw] treat_missing_data
|
8430
|
+
# Sets how this alarm will handle missing data points.
|
8431
|
+
#
|
8432
|
+
# An alarm can treat missing data in the following ways:
|
8433
|
+
#
|
8434
|
+
# * `breaching` - Assume the missing data is not within the threshold.
|
8435
|
+
# Missing data counts towards the number of times the metric is not
|
8436
|
+
# within the threshold.
|
8437
|
+
#
|
8438
|
+
# * `notBreaching` - Assume the missing data is within the threshold.
|
8439
|
+
# Missing data does not count towards the number of times the metric
|
8440
|
+
# is not within the threshold.
|
8441
|
+
#
|
8442
|
+
# * `ignore` - Ignore the missing data. Maintains the current alarm
|
8443
|
+
# state.
|
8444
|
+
#
|
8445
|
+
# * `missing` - Missing data is treated as missing.
|
8446
|
+
#
|
8447
|
+
# If `treatMissingData` is not specified, the default behavior of
|
8448
|
+
# `missing` is used.
|
8449
|
+
# @return [String]
|
8450
|
+
#
|
8451
|
+
# @!attribute [rw] contact_protocols
|
8452
|
+
# The contact protocols to use for the alarm, such as `Email`, `SMS`
|
8453
|
+
# (text messaging), or both.
|
8454
|
+
#
|
8455
|
+
# A notification is sent via the specified contact protocol if
|
8456
|
+
# notifications are enabled for the alarm, and when the alarm is
|
8457
|
+
# triggered.
|
8458
|
+
#
|
8459
|
+
# A notification is not sent if a contact protocol is not specified,
|
8460
|
+
# if the specified contact protocol is not configured in the AWS
|
8461
|
+
# Region, or if notifications are not enabled for the alarm using the
|
8462
|
+
# `notificationEnabled` paramater.
|
8463
|
+
#
|
8464
|
+
# Use the `CreateContactMethod` action to configure a contact protocol
|
8465
|
+
# in an AWS Region.
|
8466
|
+
# @return [Array<String>]
|
8467
|
+
#
|
8468
|
+
# @!attribute [rw] notification_triggers
|
8469
|
+
# The alarm states that trigger a notification.
|
8470
|
+
#
|
8471
|
+
# An alarm has the following possible states:
|
8472
|
+
#
|
8473
|
+
# * `ALARM` - The metric is outside of the defined threshold.
|
8474
|
+
#
|
8475
|
+
# * `INSUFFICIENT_DATA` - The alarm has just started, the metric is
|
8476
|
+
# not available, or not enough data is available for the metric to
|
8477
|
+
# determine the alarm state.
|
8478
|
+
#
|
8479
|
+
# * `OK` - The metric is within the defined threshold.
|
8480
|
+
#
|
8481
|
+
# When you specify a notification trigger, the `ALARM` state must be
|
8482
|
+
# specified. The `INSUFFICIENT_DATA` and `OK` states can be specified
|
8483
|
+
# in addition to the `ALARM` state.
|
8484
|
+
#
|
8485
|
+
# * If you specify `OK` as an alarm trigger, a notification is sent
|
8486
|
+
# when the alarm switches from an `ALARM` or `INSUFFICIENT_DATA`
|
8487
|
+
# alarm state to an `OK` state. This can be thought of as an *all
|
8488
|
+
# clear* alarm notification.
|
8489
|
+
#
|
8490
|
+
# * If you specify `INSUFFICIENT_DATA` as the alarm trigger, a
|
8491
|
+
# notification is sent when the alarm switches from an `OK` or
|
8492
|
+
# `ALARM` alarm state to an `INSUFFICIENT_DATA` state.
|
8493
|
+
#
|
8494
|
+
# The notification trigger defaults to `ALARM` if you don't specify
|
8495
|
+
# this parameter.
|
8496
|
+
# @return [Array<String>]
|
8497
|
+
#
|
8498
|
+
# @!attribute [rw] notification_enabled
|
8499
|
+
# Indicates whether the alarm is enabled.
|
8500
|
+
#
|
8501
|
+
# Notifications are enabled by default if you don't specify this
|
8502
|
+
# parameter.
|
8503
|
+
# @return [Boolean]
|
8504
|
+
#
|
8505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutAlarmRequest AWS API Documentation
|
8506
|
+
#
|
8507
|
+
class PutAlarmRequest < Struct.new(
|
8508
|
+
:alarm_name,
|
8509
|
+
:metric_name,
|
8510
|
+
:monitored_resource_name,
|
8511
|
+
:comparison_operator,
|
8512
|
+
:threshold,
|
8513
|
+
:evaluation_periods,
|
8514
|
+
:datapoints_to_alarm,
|
8515
|
+
:treat_missing_data,
|
8516
|
+
:contact_protocols,
|
8517
|
+
:notification_triggers,
|
8518
|
+
:notification_enabled)
|
8519
|
+
include Aws::Structure
|
8520
|
+
end
|
8521
|
+
|
8522
|
+
# @!attribute [rw] operations
|
8523
|
+
# An array of objects that describe the result of the action, such as
|
8524
|
+
# the status of the request, the timestamp of the request, and the
|
8525
|
+
# resources affected by the request.
|
8526
|
+
# @return [Array<Types::Operation>]
|
8527
|
+
#
|
8528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutAlarmResult AWS API Documentation
|
8529
|
+
#
|
8530
|
+
class PutAlarmResult < Struct.new(
|
8531
|
+
:operations)
|
7135
8532
|
include Aws::Structure
|
7136
8533
|
end
|
7137
8534
|
|
@@ -7143,18 +8540,21 @@ module Aws::Lightsail
|
|
7143
8540
|
# {
|
7144
8541
|
# from_port: 1,
|
7145
8542
|
# to_port: 1,
|
7146
|
-
# protocol: "tcp", # accepts tcp, all, udp
|
8543
|
+
# protocol: "tcp", # accepts tcp, all, udp, icmp
|
8544
|
+
# cidrs: ["string"],
|
8545
|
+
# cidr_list_aliases: ["string"],
|
7147
8546
|
# },
|
7148
8547
|
# ],
|
7149
8548
|
# instance_name: "ResourceName", # required
|
7150
8549
|
# }
|
7151
8550
|
#
|
7152
8551
|
# @!attribute [rw] port_infos
|
7153
|
-
#
|
8552
|
+
# An array of objects to describe the ports to open for the specified
|
8553
|
+
# instance.
|
7154
8554
|
# @return [Array<Types::PortInfo>]
|
7155
8555
|
#
|
7156
8556
|
# @!attribute [rw] instance_name
|
7157
|
-
# The
|
8557
|
+
# The name of the instance for which to open ports.
|
7158
8558
|
# @return [String]
|
7159
8559
|
#
|
7160
8560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPortsRequest AWS API Documentation
|
@@ -7166,7 +8566,9 @@ module Aws::Lightsail
|
|
7166
8566
|
end
|
7167
8567
|
|
7168
8568
|
# @!attribute [rw] operation
|
7169
|
-
#
|
8569
|
+
# An array of objects that describe the result of the action, such as
|
8570
|
+
# the status of the request, the timestamp of the request, and the
|
8571
|
+
# resources affected by the request.
|
7170
8572
|
# @return [Types::Operation]
|
7171
8573
|
#
|
7172
8574
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPortsResult AWS API Documentation
|
@@ -7195,8 +8597,9 @@ module Aws::Lightsail
|
|
7195
8597
|
end
|
7196
8598
|
|
7197
8599
|
# @!attribute [rw] operations
|
7198
|
-
# An array of
|
7199
|
-
#
|
8600
|
+
# An array of objects that describe the result of the action, such as
|
8601
|
+
# the status of the request, the timestamp of the request, and the
|
8602
|
+
# resources affected by the request.
|
7200
8603
|
# @return [Array<Types::Operation>]
|
7201
8604
|
#
|
7202
8605
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstanceResult AWS API Documentation
|
@@ -7225,8 +8628,9 @@ module Aws::Lightsail
|
|
7225
8628
|
end
|
7226
8629
|
|
7227
8630
|
# @!attribute [rw] operations
|
7228
|
-
# An
|
7229
|
-
# request
|
8631
|
+
# An array of objects that describe the result of the action, such as
|
8632
|
+
# the status of the request, the timestamp of the request, and the
|
8633
|
+
# resources affected by the request.
|
7230
8634
|
# @return [Array<Types::Operation>]
|
7231
8635
|
#
|
7232
8636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabaseResult AWS API Documentation
|
@@ -7790,8 +9194,9 @@ module Aws::Lightsail
|
|
7790
9194
|
end
|
7791
9195
|
|
7792
9196
|
# @!attribute [rw] operations
|
7793
|
-
# An array of
|
7794
|
-
#
|
9197
|
+
# An array of objects that describe the result of the action, such as
|
9198
|
+
# the status of the request, the timestamp of the request, and the
|
9199
|
+
# resources affected by the request.
|
7795
9200
|
# @return [Array<Types::Operation>]
|
7796
9201
|
#
|
7797
9202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ReleaseStaticIpResult AWS API Documentation
|
@@ -7820,6 +9225,37 @@ module Aws::Lightsail
|
|
7820
9225
|
include Aws::Structure
|
7821
9226
|
end
|
7822
9227
|
|
9228
|
+
# @note When making an API call, you may pass SendContactMethodVerificationRequest
|
9229
|
+
# data as a hash:
|
9230
|
+
#
|
9231
|
+
# {
|
9232
|
+
# protocol: "Email", # required, accepts Email
|
9233
|
+
# }
|
9234
|
+
#
|
9235
|
+
# @!attribute [rw] protocol
|
9236
|
+
# The protocol to verify, such as `Email` or `SMS` (text messaging).
|
9237
|
+
# @return [String]
|
9238
|
+
#
|
9239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SendContactMethodVerificationRequest AWS API Documentation
|
9240
|
+
#
|
9241
|
+
class SendContactMethodVerificationRequest < Struct.new(
|
9242
|
+
:protocol)
|
9243
|
+
include Aws::Structure
|
9244
|
+
end
|
9245
|
+
|
9246
|
+
# @!attribute [rw] operations
|
9247
|
+
# An array of objects that describe the result of the action, such as
|
9248
|
+
# the status of the request, the timestamp of the request, and the
|
9249
|
+
# resources affected by the request.
|
9250
|
+
# @return [Array<Types::Operation>]
|
9251
|
+
#
|
9252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SendContactMethodVerificationResult AWS API Documentation
|
9253
|
+
#
|
9254
|
+
class SendContactMethodVerificationResult < Struct.new(
|
9255
|
+
:operations)
|
9256
|
+
include Aws::Structure
|
9257
|
+
end
|
9258
|
+
|
7823
9259
|
# A general service exception.
|
7824
9260
|
#
|
7825
9261
|
# @!attribute [rw] code
|
@@ -7863,8 +9299,9 @@ module Aws::Lightsail
|
|
7863
9299
|
end
|
7864
9300
|
|
7865
9301
|
# @!attribute [rw] operations
|
7866
|
-
# An array of
|
7867
|
-
#
|
9302
|
+
# An array of objects that describe the result of the action, such as
|
9303
|
+
# the status of the request, the timestamp of the request, and the
|
9304
|
+
# resources affected by the request.
|
7868
9305
|
# @return [Array<Types::Operation>]
|
7869
9306
|
#
|
7870
9307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartInstanceResult AWS API Documentation
|
@@ -7893,8 +9330,9 @@ module Aws::Lightsail
|
|
7893
9330
|
end
|
7894
9331
|
|
7895
9332
|
# @!attribute [rw] operations
|
7896
|
-
# An
|
7897
|
-
# request
|
9333
|
+
# An array of objects that describe the result of the action, such as
|
9334
|
+
# the status of the request, the timestamp of the request, and the
|
9335
|
+
# resources affected by the request.
|
7898
9336
|
# @return [Array<Types::Operation>]
|
7899
9337
|
#
|
7900
9338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartRelationalDatabaseResult AWS API Documentation
|
@@ -7993,8 +9431,9 @@ module Aws::Lightsail
|
|
7993
9431
|
end
|
7994
9432
|
|
7995
9433
|
# @!attribute [rw] operations
|
7996
|
-
# An array of
|
7997
|
-
#
|
9434
|
+
# An array of objects that describe the result of the action, such as
|
9435
|
+
# the status of the request, the timestamp of the request, and the
|
9436
|
+
# resources affected by the request.
|
7998
9437
|
# @return [Array<Types::Operation>]
|
7999
9438
|
#
|
8000
9439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopInstanceResult AWS API Documentation
|
@@ -8030,8 +9469,9 @@ module Aws::Lightsail
|
|
8030
9469
|
end
|
8031
9470
|
|
8032
9471
|
# @!attribute [rw] operations
|
8033
|
-
# An
|
8034
|
-
# request
|
9472
|
+
# An array of objects that describe the result of the action, such as
|
9473
|
+
# the status of the request, the timestamp of the request, and the
|
9474
|
+
# resources affected by the request.
|
8035
9475
|
# @return [Array<Types::Operation>]
|
8036
9476
|
#
|
8037
9477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopRelationalDatabaseResult AWS API Documentation
|
@@ -8118,7 +9558,9 @@ module Aws::Lightsail
|
|
8118
9558
|
end
|
8119
9559
|
|
8120
9560
|
# @!attribute [rw] operations
|
8121
|
-
#
|
9561
|
+
# An array of objects that describe the result of the action, such as
|
9562
|
+
# the status of the request, the timestamp of the request, and the
|
9563
|
+
# resources affected by the request.
|
8122
9564
|
# @return [Array<Types::Operation>]
|
8123
9565
|
#
|
8124
9566
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TagResourceResult AWS API Documentation
|
@@ -8128,6 +9570,53 @@ module Aws::Lightsail
|
|
8128
9570
|
include Aws::Structure
|
8129
9571
|
end
|
8130
9572
|
|
9573
|
+
# @note When making an API call, you may pass TestAlarmRequest
|
9574
|
+
# data as a hash:
|
9575
|
+
#
|
9576
|
+
# {
|
9577
|
+
# alarm_name: "ResourceName", # required
|
9578
|
+
# state: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
|
9579
|
+
# }
|
9580
|
+
#
|
9581
|
+
# @!attribute [rw] alarm_name
|
9582
|
+
# The name of the alarm to test.
|
9583
|
+
# @return [String]
|
9584
|
+
#
|
9585
|
+
# @!attribute [rw] state
|
9586
|
+
# The alarm state to test.
|
9587
|
+
#
|
9588
|
+
# An alarm has the following possible states that can be tested:
|
9589
|
+
#
|
9590
|
+
# * `ALARM` - The metric is outside of the defined threshold.
|
9591
|
+
#
|
9592
|
+
# * `INSUFFICIENT_DATA` - The alarm has just started, the metric is
|
9593
|
+
# not available, or not enough data is available for the metric to
|
9594
|
+
# determine the alarm state.
|
9595
|
+
#
|
9596
|
+
# * `OK` - The metric is within the defined threshold.
|
9597
|
+
# @return [String]
|
9598
|
+
#
|
9599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TestAlarmRequest AWS API Documentation
|
9600
|
+
#
|
9601
|
+
class TestAlarmRequest < Struct.new(
|
9602
|
+
:alarm_name,
|
9603
|
+
:state)
|
9604
|
+
include Aws::Structure
|
9605
|
+
end
|
9606
|
+
|
9607
|
+
# @!attribute [rw] operations
|
9608
|
+
# An array of objects that describe the result of the action, such as
|
9609
|
+
# the status of the request, the timestamp of the request, and the
|
9610
|
+
# resources affected by the request.
|
9611
|
+
# @return [Array<Types::Operation>]
|
9612
|
+
#
|
9613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/TestAlarmResult AWS API Documentation
|
9614
|
+
#
|
9615
|
+
class TestAlarmResult < Struct.new(
|
9616
|
+
:operations)
|
9617
|
+
include Aws::Structure
|
9618
|
+
end
|
9619
|
+
|
8131
9620
|
# Lightsail throws this exception when the user has not been
|
8132
9621
|
# authenticated.
|
8133
9622
|
#
|
@@ -8160,8 +9649,9 @@ module Aws::Lightsail
|
|
8160
9649
|
class UnpeerVpcRequest < Aws::EmptyStructure; end
|
8161
9650
|
|
8162
9651
|
# @!attribute [rw] operation
|
8163
|
-
# An array of
|
8164
|
-
#
|
9652
|
+
# An array of objects that describe the result of the action, such as
|
9653
|
+
# the status of the request, the timestamp of the request, and the
|
9654
|
+
# resources affected by the request.
|
8165
9655
|
# @return [Types::Operation]
|
8166
9656
|
#
|
8167
9657
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UnpeerVpcResult AWS API Documentation
|
@@ -8203,7 +9693,9 @@ module Aws::Lightsail
|
|
8203
9693
|
end
|
8204
9694
|
|
8205
9695
|
# @!attribute [rw] operations
|
8206
|
-
#
|
9696
|
+
# An array of objects that describe the result of the action, such as
|
9697
|
+
# the status of the request, the timestamp of the request, and the
|
9698
|
+
# resources affected by the request.
|
8207
9699
|
# @return [Array<Types::Operation>]
|
8208
9700
|
#
|
8209
9701
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UntagResourceResult AWS API Documentation
|
@@ -8248,8 +9740,9 @@ module Aws::Lightsail
|
|
8248
9740
|
end
|
8249
9741
|
|
8250
9742
|
# @!attribute [rw] operations
|
8251
|
-
# An array of
|
8252
|
-
#
|
9743
|
+
# An array of objects that describe the result of the action, such as
|
9744
|
+
# the status of the request, the timestamp of the request, and the
|
9745
|
+
# resources affected by the request.
|
8253
9746
|
# @return [Array<Types::Operation>]
|
8254
9747
|
#
|
8255
9748
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateDomainEntryResult AWS API Documentation
|
@@ -8292,7 +9785,9 @@ module Aws::Lightsail
|
|
8292
9785
|
end
|
8293
9786
|
|
8294
9787
|
# @!attribute [rw] operations
|
8295
|
-
# An
|
9788
|
+
# An array of objects that describe the result of the action, such as
|
9789
|
+
# the status of the request, the timestamp of the request, and the
|
9790
|
+
# resources affected by the request.
|
8296
9791
|
# @return [Array<Types::Operation>]
|
8297
9792
|
#
|
8298
9793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateLoadBalancerAttributeResult AWS API Documentation
|
@@ -8338,8 +9833,9 @@ module Aws::Lightsail
|
|
8338
9833
|
end
|
8339
9834
|
|
8340
9835
|
# @!attribute [rw] operations
|
8341
|
-
# An
|
8342
|
-
#
|
9836
|
+
# An array of objects that describe the result of the action, such as
|
9837
|
+
# the status of the request, the timestamp of the request, and the
|
9838
|
+
# resources affected by the request.
|
8343
9839
|
# @return [Array<Types::Operation>]
|
8344
9840
|
#
|
8345
9841
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseParametersResult AWS API Documentation
|
@@ -8479,8 +9975,9 @@ module Aws::Lightsail
|
|
8479
9975
|
end
|
8480
9976
|
|
8481
9977
|
# @!attribute [rw] operations
|
8482
|
-
# An
|
8483
|
-
# request
|
9978
|
+
# An array of objects that describe the result of the action, such as
|
9979
|
+
# the status of the request, the timestamp of the request, and the
|
9980
|
+
# resources affected by the request.
|
8484
9981
|
# @return [Array<Types::Operation>]
|
8485
9982
|
#
|
8486
9983
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseResult AWS API Documentation
|