aws-sdk-lightsail 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-lightsail.rb +47 -0
- data/lib/aws-sdk-lightsail/client.rb +1963 -0
- data/lib/aws-sdk-lightsail/client_api.rb +1459 -0
- data/lib/aws-sdk-lightsail/customizations.rb +0 -0
- data/lib/aws-sdk-lightsail/errors.rb +23 -0
- data/lib/aws-sdk-lightsail/resource.rb +25 -0
- data/lib/aws-sdk-lightsail/types.rb +2307 -0
- metadata +80 -0
File without changes
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Lightsail
|
10
|
+
module Errors
|
11
|
+
|
12
|
+
extend Aws::Errors::DynamicErrors
|
13
|
+
|
14
|
+
# Raised when calling #load or #data on a resource class that can not be
|
15
|
+
# loaded. This can happen when:
|
16
|
+
#
|
17
|
+
# * A resource class has identifiers, but no data attributes.
|
18
|
+
# * Resource data is only available when making an API call that
|
19
|
+
# enumerates all resources of that type.
|
20
|
+
class ResourceNotLoadable < RuntimeError; end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Lightsail
|
10
|
+
class Resource
|
11
|
+
|
12
|
+
# @param options ({})
|
13
|
+
# @option options [Client] :client
|
14
|
+
def initialize(options = {})
|
15
|
+
@client = options[:client] || Client.new(options)
|
16
|
+
end
|
17
|
+
|
18
|
+
# @return [Client]
|
19
|
+
def client
|
20
|
+
@client
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,2307 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Lightsail
|
10
|
+
module Types
|
11
|
+
|
12
|
+
# @note When making an API call, pass AllocateStaticIpRequest
|
13
|
+
# data as a hash:
|
14
|
+
#
|
15
|
+
# {
|
16
|
+
# static_ip_name: "ResourceName", # required
|
17
|
+
# }
|
18
|
+
# @!attribute [rw] static_ip_name
|
19
|
+
# The name of the static IP address.
|
20
|
+
# @return [String]
|
21
|
+
class AllocateStaticIpRequest < Struct.new(
|
22
|
+
:static_ip_name)
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# @!attribute [rw] operations
|
27
|
+
# An array of key-value pairs containing information about the static
|
28
|
+
# IP address you allocated.
|
29
|
+
# @return [Array<Types::Operation>]
|
30
|
+
class AllocateStaticIpResult < Struct.new(
|
31
|
+
:operations)
|
32
|
+
include Aws::Structure
|
33
|
+
end
|
34
|
+
|
35
|
+
# @note When making an API call, pass AttachStaticIpRequest
|
36
|
+
# data as a hash:
|
37
|
+
#
|
38
|
+
# {
|
39
|
+
# static_ip_name: "ResourceName", # required
|
40
|
+
# instance_name: "ResourceName", # required
|
41
|
+
# }
|
42
|
+
# @!attribute [rw] static_ip_name
|
43
|
+
# The name of the static IP.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @!attribute [rw] instance_name
|
47
|
+
# The instance name to which you want to attach the static IP address.
|
48
|
+
# @return [String]
|
49
|
+
class AttachStaticIpRequest < Struct.new(
|
50
|
+
:static_ip_name,
|
51
|
+
:instance_name)
|
52
|
+
include Aws::Structure
|
53
|
+
end
|
54
|
+
|
55
|
+
# @!attribute [rw] operations
|
56
|
+
# An array of key-value pairs containing information about your API
|
57
|
+
# operations.
|
58
|
+
# @return [Array<Types::Operation>]
|
59
|
+
class AttachStaticIpResult < Struct.new(
|
60
|
+
:operations)
|
61
|
+
include Aws::Structure
|
62
|
+
end
|
63
|
+
|
64
|
+
# Describes an Availability Zone.
|
65
|
+
# @!attribute [rw] zone_name
|
66
|
+
# The name of the Availability Zone.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] state
|
70
|
+
# The state of the Availability Zone.
|
71
|
+
# @return [String]
|
72
|
+
class AvailabilityZone < Struct.new(
|
73
|
+
:zone_name,
|
74
|
+
:state)
|
75
|
+
include Aws::Structure
|
76
|
+
end
|
77
|
+
|
78
|
+
# Describes a blueprint (a virtual private server image).
|
79
|
+
# @!attribute [rw] blueprint_id
|
80
|
+
# The ID for the virtual private server image (e.g.,
|
81
|
+
# `app_wordpress_4_4` or `app_lamp_7_0`).
|
82
|
+
# @return [String]
|
83
|
+
#
|
84
|
+
# @!attribute [rw] name
|
85
|
+
# The friendly name of the blueprint (e.g., `Amazon Linux`).
|
86
|
+
# @return [String]
|
87
|
+
#
|
88
|
+
# @!attribute [rw] group
|
89
|
+
# The group name of the blueprint (e.g., `amazon-linux`).
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] type
|
93
|
+
# The type of the blueprint (e.g., `os` or `app`).
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] description
|
97
|
+
# The description of the blueprint.
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] is_active
|
101
|
+
# A Boolean value indicating whether the blueprint is active. When you
|
102
|
+
# update your blueprints, you will inactivate old blueprints and keep
|
103
|
+
# the most recent versions active.
|
104
|
+
# @return [Boolean]
|
105
|
+
#
|
106
|
+
# @!attribute [rw] min_power
|
107
|
+
# The minimum machine size required to run this blueprint. `0`
|
108
|
+
# indicates that the blueprint runs on all instances.
|
109
|
+
# @return [Integer]
|
110
|
+
#
|
111
|
+
# @!attribute [rw] version
|
112
|
+
# The version number of the operating system, application, or stack
|
113
|
+
# (e.g., `2016.03.0`).
|
114
|
+
# @return [String]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] version_code
|
117
|
+
# The version code.
|
118
|
+
# @return [String]
|
119
|
+
#
|
120
|
+
# @!attribute [rw] product_url
|
121
|
+
# The product URL to learn more about the image or blueprint.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] license_url
|
125
|
+
# The end-user license agreement URL for the image or blueprint.
|
126
|
+
# @return [String]
|
127
|
+
class Blueprint < Struct.new(
|
128
|
+
:blueprint_id,
|
129
|
+
:name,
|
130
|
+
:group,
|
131
|
+
:type,
|
132
|
+
:description,
|
133
|
+
:is_active,
|
134
|
+
:min_power,
|
135
|
+
:version,
|
136
|
+
:version_code,
|
137
|
+
:product_url,
|
138
|
+
:license_url)
|
139
|
+
include Aws::Structure
|
140
|
+
end
|
141
|
+
|
142
|
+
# Describes a bundle, which is a set of specs describing your virtual
|
143
|
+
# private server (or *instance*).
|
144
|
+
# @!attribute [rw] price
|
145
|
+
# The price in US dollars (e.g., `5.0`).
|
146
|
+
# @return [Float]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] cpu_count
|
149
|
+
# The number of vCPUs included in the bundle (e.g., `2`).
|
150
|
+
# @return [Integer]
|
151
|
+
#
|
152
|
+
# @!attribute [rw] disk_size_in_gb
|
153
|
+
# The size of the SSD (e.g., `30`).
|
154
|
+
# @return [Integer]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] bundle_id
|
157
|
+
# The bundle ID (e.g., `micro_1_0`).
|
158
|
+
# @return [String]
|
159
|
+
#
|
160
|
+
# @!attribute [rw] instance_type
|
161
|
+
# The Amazon EC2 instance type (e.g., `t2.micro`).
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] is_active
|
165
|
+
# A Boolean value indicating whether the bundle is active.
|
166
|
+
# @return [Boolean]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] name
|
169
|
+
# A friendly name for the bundle (e.g., `Micro`).
|
170
|
+
# @return [String]
|
171
|
+
#
|
172
|
+
# @!attribute [rw] power
|
173
|
+
# The power of the bundle (e.g., `500`).
|
174
|
+
# @return [Integer]
|
175
|
+
#
|
176
|
+
# @!attribute [rw] ram_size_in_gb
|
177
|
+
# The amount of RAM in GB (e.g., `2.0`).
|
178
|
+
# @return [Float]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] transfer_per_month_in_gb
|
181
|
+
# The data transfer rate per month in GB (e.g., `2000`).
|
182
|
+
# @return [Integer]
|
183
|
+
class Bundle < Struct.new(
|
184
|
+
:price,
|
185
|
+
:cpu_count,
|
186
|
+
:disk_size_in_gb,
|
187
|
+
:bundle_id,
|
188
|
+
:instance_type,
|
189
|
+
:is_active,
|
190
|
+
:name,
|
191
|
+
:power,
|
192
|
+
:ram_size_in_gb,
|
193
|
+
:transfer_per_month_in_gb)
|
194
|
+
include Aws::Structure
|
195
|
+
end
|
196
|
+
|
197
|
+
# @note When making an API call, pass CloseInstancePublicPortsRequest
|
198
|
+
# data as a hash:
|
199
|
+
#
|
200
|
+
# {
|
201
|
+
# port_info: { # required
|
202
|
+
# from_port: 1,
|
203
|
+
# to_port: 1,
|
204
|
+
# protocol: "tcp", # accepts tcp, all, udp
|
205
|
+
# },
|
206
|
+
# instance_name: "ResourceName", # required
|
207
|
+
# }
|
208
|
+
# @!attribute [rw] port_info
|
209
|
+
# Information about the public port you are trying to close.
|
210
|
+
# @return [Types::PortInfo]
|
211
|
+
#
|
212
|
+
# @!attribute [rw] instance_name
|
213
|
+
# The name of the instance on which you're attempting to close the
|
214
|
+
# public ports.
|
215
|
+
# @return [String]
|
216
|
+
class CloseInstancePublicPortsRequest < Struct.new(
|
217
|
+
:port_info,
|
218
|
+
:instance_name)
|
219
|
+
include Aws::Structure
|
220
|
+
end
|
221
|
+
|
222
|
+
# @!attribute [rw] operation
|
223
|
+
# An array of key-value pairs that contains information about the
|
224
|
+
# operation.
|
225
|
+
# @return [Types::Operation]
|
226
|
+
class CloseInstancePublicPortsResult < Struct.new(
|
227
|
+
:operation)
|
228
|
+
include Aws::Structure
|
229
|
+
end
|
230
|
+
|
231
|
+
# @note When making an API call, pass CreateDomainEntryRequest
|
232
|
+
# data as a hash:
|
233
|
+
#
|
234
|
+
# {
|
235
|
+
# domain_name: "DomainName", # required
|
236
|
+
# domain_entry: { # required
|
237
|
+
# id: "NonEmptyString",
|
238
|
+
# name: "DomainName",
|
239
|
+
# target: "string",
|
240
|
+
# type: "DomainEntryType",
|
241
|
+
# options: {
|
242
|
+
# "DomainEntryOptionsKeys" => "string",
|
243
|
+
# },
|
244
|
+
# },
|
245
|
+
# }
|
246
|
+
# @!attribute [rw] domain_name
|
247
|
+
# The domain name (e.g., `example.com`) for which you want to create
|
248
|
+
# the domain entry.
|
249
|
+
# @return [String]
|
250
|
+
#
|
251
|
+
# @!attribute [rw] domain_entry
|
252
|
+
# An array of key-value pairs containing information about the domain
|
253
|
+
# entry request.
|
254
|
+
# @return [Types::DomainEntry]
|
255
|
+
class CreateDomainEntryRequest < Struct.new(
|
256
|
+
:domain_name,
|
257
|
+
:domain_entry)
|
258
|
+
include Aws::Structure
|
259
|
+
end
|
260
|
+
|
261
|
+
# @!attribute [rw] operation
|
262
|
+
# An array of key-value pairs containing information about the
|
263
|
+
# operation.
|
264
|
+
# @return [Types::Operation]
|
265
|
+
class CreateDomainEntryResult < Struct.new(
|
266
|
+
:operation)
|
267
|
+
include Aws::Structure
|
268
|
+
end
|
269
|
+
|
270
|
+
# @note When making an API call, pass CreateDomainRequest
|
271
|
+
# data as a hash:
|
272
|
+
#
|
273
|
+
# {
|
274
|
+
# domain_name: "DomainName", # required
|
275
|
+
# }
|
276
|
+
# @!attribute [rw] domain_name
|
277
|
+
# The domain name to manage (e.g., `example.com`).
|
278
|
+
#
|
279
|
+
# <note markdown="1"> You cannot register a new domain name using Lightsail. You must
|
280
|
+
# register a domain name using Amazon Route 53 or another domain name
|
281
|
+
# registrar. If you have already registered your domain, you can enter
|
282
|
+
# its name in this parameter to manage the DNS records for that
|
283
|
+
# domain.
|
284
|
+
#
|
285
|
+
# </note>
|
286
|
+
# @return [String]
|
287
|
+
class CreateDomainRequest < Struct.new(
|
288
|
+
:domain_name)
|
289
|
+
include Aws::Structure
|
290
|
+
end
|
291
|
+
|
292
|
+
# @!attribute [rw] operation
|
293
|
+
# An array of key-value pairs containing information about the domain
|
294
|
+
# resource you created.
|
295
|
+
# @return [Types::Operation]
|
296
|
+
class CreateDomainResult < Struct.new(
|
297
|
+
:operation)
|
298
|
+
include Aws::Structure
|
299
|
+
end
|
300
|
+
|
301
|
+
# @note When making an API call, pass CreateInstanceSnapshotRequest
|
302
|
+
# data as a hash:
|
303
|
+
#
|
304
|
+
# {
|
305
|
+
# instance_snapshot_name: "ResourceName", # required
|
306
|
+
# instance_name: "ResourceName", # required
|
307
|
+
# }
|
308
|
+
# @!attribute [rw] instance_snapshot_name
|
309
|
+
# The name for your new snapshot.
|
310
|
+
# @return [String]
|
311
|
+
#
|
312
|
+
# @!attribute [rw] instance_name
|
313
|
+
# The Lightsail instance on which to base your snapshot.
|
314
|
+
# @return [String]
|
315
|
+
class CreateInstanceSnapshotRequest < Struct.new(
|
316
|
+
:instance_snapshot_name,
|
317
|
+
:instance_name)
|
318
|
+
include Aws::Structure
|
319
|
+
end
|
320
|
+
|
321
|
+
# @!attribute [rw] operations
|
322
|
+
# An array of key-value pairs containing information about the results
|
323
|
+
# of your create instances snapshot request.
|
324
|
+
# @return [Array<Types::Operation>]
|
325
|
+
class CreateInstanceSnapshotResult < Struct.new(
|
326
|
+
:operations)
|
327
|
+
include Aws::Structure
|
328
|
+
end
|
329
|
+
|
330
|
+
# @note When making an API call, pass CreateInstancesFromSnapshotRequest
|
331
|
+
# data as a hash:
|
332
|
+
#
|
333
|
+
# {
|
334
|
+
# instance_names: ["string"], # required
|
335
|
+
# availability_zone: "string", # required
|
336
|
+
# instance_snapshot_name: "ResourceName", # required
|
337
|
+
# bundle_id: "NonEmptyString", # required
|
338
|
+
# user_data: "string",
|
339
|
+
# key_pair_name: "ResourceName",
|
340
|
+
# }
|
341
|
+
# @!attribute [rw] instance_names
|
342
|
+
# The names for your new instances.
|
343
|
+
# @return [Array<String>]
|
344
|
+
#
|
345
|
+
# @!attribute [rw] availability_zone
|
346
|
+
# The Availability Zone where you want to create your instances. Use
|
347
|
+
# the following formatting: `us-east-1a` (case sensitive).
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] instance_snapshot_name
|
351
|
+
# The name of the instance snapshot on which you are basing your new
|
352
|
+
# instances. Use the get instance snapshots operation to return
|
353
|
+
# information about your existing snapshots.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] bundle_id
|
357
|
+
# The bundle of specification information for your virtual private
|
358
|
+
# server (or *instance*), including the pricing plan (e.g.,
|
359
|
+
# `micro_1_0`).
|
360
|
+
# @return [String]
|
361
|
+
#
|
362
|
+
# @!attribute [rw] user_data
|
363
|
+
# You can create a launch script that configures a server with
|
364
|
+
# additional user data. For example, `apt-get –y update`.
|
365
|
+
#
|
366
|
+
# <note markdown="1"> Depending on the machine image you choose, the command to get
|
367
|
+
# software on your instance varies. Amazon Linux and CentOS use `yum`,
|
368
|
+
# Debian and Ubuntu use `apt-get`, and FreeBSD uses `pkg`. For a
|
369
|
+
# complete list, see the [Dev Guide][1].
|
370
|
+
#
|
371
|
+
# </note>
|
372
|
+
#
|
373
|
+
#
|
374
|
+
#
|
375
|
+
# [1]: http://lightsail.aws.amazon.com/ls/docs/getting-started/articles/pre-installed-apps
|
376
|
+
# @return [String]
|
377
|
+
#
|
378
|
+
# @!attribute [rw] key_pair_name
|
379
|
+
# The name for your key pair.
|
380
|
+
# @return [String]
|
381
|
+
class CreateInstancesFromSnapshotRequest < Struct.new(
|
382
|
+
:instance_names,
|
383
|
+
:availability_zone,
|
384
|
+
:instance_snapshot_name,
|
385
|
+
:bundle_id,
|
386
|
+
:user_data,
|
387
|
+
:key_pair_name)
|
388
|
+
include Aws::Structure
|
389
|
+
end
|
390
|
+
|
391
|
+
# @!attribute [rw] operations
|
392
|
+
# An array of key-value pairs containing information about the results
|
393
|
+
# of your create instances from snapshot request.
|
394
|
+
# @return [Array<Types::Operation>]
|
395
|
+
class CreateInstancesFromSnapshotResult < Struct.new(
|
396
|
+
:operations)
|
397
|
+
include Aws::Structure
|
398
|
+
end
|
399
|
+
|
400
|
+
# @note When making an API call, pass CreateInstancesRequest
|
401
|
+
# data as a hash:
|
402
|
+
#
|
403
|
+
# {
|
404
|
+
# instance_names: ["string"], # required
|
405
|
+
# availability_zone: "string", # required
|
406
|
+
# custom_image_name: "ResourceName",
|
407
|
+
# blueprint_id: "NonEmptyString", # required
|
408
|
+
# bundle_id: "NonEmptyString", # required
|
409
|
+
# user_data: "string",
|
410
|
+
# key_pair_name: "ResourceName",
|
411
|
+
# }
|
412
|
+
# @!attribute [rw] instance_names
|
413
|
+
# The names to use for your new Lightsail instances. Separate multiple
|
414
|
+
# values using quotation marks and commas, for example:
|
415
|
+
# `["MyFirstInstance","MySecondInstance"]`
|
416
|
+
# @return [Array<String>]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] availability_zone
|
419
|
+
# The Availability Zone in which to create your instance. Use the
|
420
|
+
# following format: `us-east-1a` (case sensitive).
|
421
|
+
# @return [String]
|
422
|
+
#
|
423
|
+
# @!attribute [rw] custom_image_name
|
424
|
+
# The name for your custom image.
|
425
|
+
# @return [String]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] blueprint_id
|
428
|
+
# The ID for a virtual private server image (e.g., `app_wordpress_4_4`
|
429
|
+
# or `app_lamp_7_0`). Use the get blueprints operation to return a
|
430
|
+
# list of available images (or *blueprints*).
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @!attribute [rw] bundle_id
|
434
|
+
# The bundle of specification information for your virtual private
|
435
|
+
# server (or *instance*), including the pricing plan (e.g.,
|
436
|
+
# `micro_1_0`).
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] user_data
|
440
|
+
# A launch script you can create that configures a server with
|
441
|
+
# additional user data. For example, you might want to run `apt-get –y
|
442
|
+
# update`.
|
443
|
+
#
|
444
|
+
# <note markdown="1"> Depending on the machine image you choose, the command to get
|
445
|
+
# software on your instance varies. Amazon Linux and CentOS use `yum`,
|
446
|
+
# Debian and Ubuntu use `apt-get`, and FreeBSD uses `pkg`. For a
|
447
|
+
# complete list, see the [Dev Guide][1].
|
448
|
+
#
|
449
|
+
# </note>
|
450
|
+
#
|
451
|
+
#
|
452
|
+
#
|
453
|
+
# [1]: http://lightsail.aws.amazon.com/ls/docs/getting-started/articles/pre-installed-apps
|
454
|
+
# @return [String]
|
455
|
+
#
|
456
|
+
# @!attribute [rw] key_pair_name
|
457
|
+
# The name of your key pair.
|
458
|
+
# @return [String]
|
459
|
+
class CreateInstancesRequest < Struct.new(
|
460
|
+
:instance_names,
|
461
|
+
:availability_zone,
|
462
|
+
:custom_image_name,
|
463
|
+
:blueprint_id,
|
464
|
+
:bundle_id,
|
465
|
+
:user_data,
|
466
|
+
:key_pair_name)
|
467
|
+
include Aws::Structure
|
468
|
+
end
|
469
|
+
|
470
|
+
# @!attribute [rw] operations
|
471
|
+
# An array of key-value pairs containing information about the results
|
472
|
+
# of your create instances request.
|
473
|
+
# @return [Array<Types::Operation>]
|
474
|
+
class CreateInstancesResult < Struct.new(
|
475
|
+
:operations)
|
476
|
+
include Aws::Structure
|
477
|
+
end
|
478
|
+
|
479
|
+
# @note When making an API call, pass CreateKeyPairRequest
|
480
|
+
# data as a hash:
|
481
|
+
#
|
482
|
+
# {
|
483
|
+
# key_pair_name: "ResourceName", # required
|
484
|
+
# }
|
485
|
+
# @!attribute [rw] key_pair_name
|
486
|
+
# The name for your new key pair.
|
487
|
+
# @return [String]
|
488
|
+
class CreateKeyPairRequest < Struct.new(
|
489
|
+
:key_pair_name)
|
490
|
+
include Aws::Structure
|
491
|
+
end
|
492
|
+
|
493
|
+
# @!attribute [rw] key_pair
|
494
|
+
# An array of key-value pairs containing information about the new key
|
495
|
+
# pair you just created.
|
496
|
+
# @return [Types::KeyPair]
|
497
|
+
#
|
498
|
+
# @!attribute [rw] public_key_base_64
|
499
|
+
# A base64-encoded public key of the `ssh-rsa` type.
|
500
|
+
# @return [String]
|
501
|
+
#
|
502
|
+
# @!attribute [rw] private_key_base_64
|
503
|
+
# A base64-encoded RSA private key.
|
504
|
+
# @return [String]
|
505
|
+
#
|
506
|
+
# @!attribute [rw] operation
|
507
|
+
# An array of key-value pairs containing information about the results
|
508
|
+
# of your create key pair request.
|
509
|
+
# @return [Types::Operation]
|
510
|
+
class CreateKeyPairResult < Struct.new(
|
511
|
+
:key_pair,
|
512
|
+
:public_key_base_64,
|
513
|
+
:private_key_base_64,
|
514
|
+
:operation)
|
515
|
+
include Aws::Structure
|
516
|
+
end
|
517
|
+
|
518
|
+
# @note When making an API call, pass DeleteDomainEntryRequest
|
519
|
+
# data as a hash:
|
520
|
+
#
|
521
|
+
# {
|
522
|
+
# domain_name: "DomainName", # required
|
523
|
+
# domain_entry: { # required
|
524
|
+
# id: "NonEmptyString",
|
525
|
+
# name: "DomainName",
|
526
|
+
# target: "string",
|
527
|
+
# type: "DomainEntryType",
|
528
|
+
# options: {
|
529
|
+
# "DomainEntryOptionsKeys" => "string",
|
530
|
+
# },
|
531
|
+
# },
|
532
|
+
# }
|
533
|
+
# @!attribute [rw] domain_name
|
534
|
+
# The name of the domain entry to delete.
|
535
|
+
# @return [String]
|
536
|
+
#
|
537
|
+
# @!attribute [rw] domain_entry
|
538
|
+
# An array of key-value pairs containing information about your domain
|
539
|
+
# entries.
|
540
|
+
# @return [Types::DomainEntry]
|
541
|
+
class DeleteDomainEntryRequest < Struct.new(
|
542
|
+
:domain_name,
|
543
|
+
:domain_entry)
|
544
|
+
include Aws::Structure
|
545
|
+
end
|
546
|
+
|
547
|
+
# @!attribute [rw] operation
|
548
|
+
# An array of key-value pairs containing information about the results
|
549
|
+
# of your delete domain entry request.
|
550
|
+
# @return [Types::Operation]
|
551
|
+
class DeleteDomainEntryResult < Struct.new(
|
552
|
+
:operation)
|
553
|
+
include Aws::Structure
|
554
|
+
end
|
555
|
+
|
556
|
+
# @note When making an API call, pass DeleteDomainRequest
|
557
|
+
# data as a hash:
|
558
|
+
#
|
559
|
+
# {
|
560
|
+
# domain_name: "DomainName", # required
|
561
|
+
# }
|
562
|
+
# @!attribute [rw] domain_name
|
563
|
+
# The specific domain name to delete.
|
564
|
+
# @return [String]
|
565
|
+
class DeleteDomainRequest < Struct.new(
|
566
|
+
:domain_name)
|
567
|
+
include Aws::Structure
|
568
|
+
end
|
569
|
+
|
570
|
+
# @!attribute [rw] operation
|
571
|
+
# An array of key-value pairs containing information about the results
|
572
|
+
# of your delete domain request.
|
573
|
+
# @return [Types::Operation]
|
574
|
+
class DeleteDomainResult < Struct.new(
|
575
|
+
:operation)
|
576
|
+
include Aws::Structure
|
577
|
+
end
|
578
|
+
|
579
|
+
# @note When making an API call, pass DeleteInstanceRequest
|
580
|
+
# data as a hash:
|
581
|
+
#
|
582
|
+
# {
|
583
|
+
# instance_name: "ResourceName", # required
|
584
|
+
# }
|
585
|
+
# @!attribute [rw] instance_name
|
586
|
+
# The name of the instance to delete.
|
587
|
+
# @return [String]
|
588
|
+
class DeleteInstanceRequest < Struct.new(
|
589
|
+
:instance_name)
|
590
|
+
include Aws::Structure
|
591
|
+
end
|
592
|
+
|
593
|
+
# @!attribute [rw] operations
|
594
|
+
# An array of key-value pairs containing information about the results
|
595
|
+
# of your delete instance request.
|
596
|
+
# @return [Array<Types::Operation>]
|
597
|
+
class DeleteInstanceResult < Struct.new(
|
598
|
+
:operations)
|
599
|
+
include Aws::Structure
|
600
|
+
end
|
601
|
+
|
602
|
+
# @note When making an API call, pass DeleteInstanceSnapshotRequest
|
603
|
+
# data as a hash:
|
604
|
+
#
|
605
|
+
# {
|
606
|
+
# instance_snapshot_name: "ResourceName", # required
|
607
|
+
# }
|
608
|
+
# @!attribute [rw] instance_snapshot_name
|
609
|
+
# The name of the snapshot to delete.
|
610
|
+
# @return [String]
|
611
|
+
class DeleteInstanceSnapshotRequest < Struct.new(
|
612
|
+
:instance_snapshot_name)
|
613
|
+
include Aws::Structure
|
614
|
+
end
|
615
|
+
|
616
|
+
# @!attribute [rw] operations
|
617
|
+
# An array of key-value pairs containing information about the results
|
618
|
+
# of your delete instance snapshot request.
|
619
|
+
# @return [Array<Types::Operation>]
|
620
|
+
class DeleteInstanceSnapshotResult < Struct.new(
|
621
|
+
:operations)
|
622
|
+
include Aws::Structure
|
623
|
+
end
|
624
|
+
|
625
|
+
# @note When making an API call, pass DeleteKeyPairRequest
|
626
|
+
# data as a hash:
|
627
|
+
#
|
628
|
+
# {
|
629
|
+
# key_pair_name: "ResourceName", # required
|
630
|
+
# }
|
631
|
+
# @!attribute [rw] key_pair_name
|
632
|
+
# The name of the key pair to delete.
|
633
|
+
# @return [String]
|
634
|
+
class DeleteKeyPairRequest < Struct.new(
|
635
|
+
:key_pair_name)
|
636
|
+
include Aws::Structure
|
637
|
+
end
|
638
|
+
|
639
|
+
# @!attribute [rw] operation
|
640
|
+
# An array of key-value pairs containing information about the results
|
641
|
+
# of your delete key pair request.
|
642
|
+
# @return [Types::Operation]
|
643
|
+
class DeleteKeyPairResult < Struct.new(
|
644
|
+
:operation)
|
645
|
+
include Aws::Structure
|
646
|
+
end
|
647
|
+
|
648
|
+
# @note When making an API call, pass DetachStaticIpRequest
|
649
|
+
# data as a hash:
|
650
|
+
#
|
651
|
+
# {
|
652
|
+
# static_ip_name: "ResourceName", # required
|
653
|
+
# }
|
654
|
+
# @!attribute [rw] static_ip_name
|
655
|
+
# The name of the static IP to detach from the instance.
|
656
|
+
# @return [String]
|
657
|
+
class DetachStaticIpRequest < Struct.new(
|
658
|
+
:static_ip_name)
|
659
|
+
include Aws::Structure
|
660
|
+
end
|
661
|
+
|
662
|
+
# @!attribute [rw] operations
|
663
|
+
# An array of key-value pairs containing information about the results
|
664
|
+
# of your detach static IP request.
|
665
|
+
# @return [Array<Types::Operation>]
|
666
|
+
class DetachStaticIpResult < Struct.new(
|
667
|
+
:operations)
|
668
|
+
include Aws::Structure
|
669
|
+
end
|
670
|
+
|
671
|
+
# Describes the hard disk (an SSD).
|
672
|
+
# @!attribute [rw] name
|
673
|
+
# The name of the disk.
|
674
|
+
# @return [String]
|
675
|
+
#
|
676
|
+
# @!attribute [rw] arn
|
677
|
+
# The Amazon Resource Name (ARN) of the disk.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] support_code
|
681
|
+
# The support code. Include this code in your email to support when
|
682
|
+
# you have questions about an instance or another resource in
|
683
|
+
# Lightsail. This code enables our support team to look up your
|
684
|
+
# Lightsail information more easily.
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] created_at
|
688
|
+
# The date when the disk was created.
|
689
|
+
# @return [Time]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] location
|
692
|
+
# The region and Availability Zone where the disk is located.
|
693
|
+
# @return [Types::ResourceLocation]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] resource_type
|
696
|
+
# The resource type of the disk.
|
697
|
+
# @return [String]
|
698
|
+
#
|
699
|
+
# @!attribute [rw] size_in_gb
|
700
|
+
# The size of the disk in GB.
|
701
|
+
# @return [Integer]
|
702
|
+
#
|
703
|
+
# @!attribute [rw] gb_in_use
|
704
|
+
# The number of GB in use by the disk.
|
705
|
+
# @return [Integer]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] is_system_disk
|
708
|
+
# A Boolean value indicating whether this disk is a system disk (has
|
709
|
+
# an operating system loaded on it).
|
710
|
+
# @return [Boolean]
|
711
|
+
#
|
712
|
+
# @!attribute [rw] iops
|
713
|
+
# The input/output operations per second (IOPS) of the disk.
|
714
|
+
# @return [Integer]
|
715
|
+
#
|
716
|
+
# @!attribute [rw] path
|
717
|
+
# The disk path.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] attached_to
|
721
|
+
# The resources to which the disk is attached.
|
722
|
+
# @return [String]
|
723
|
+
#
|
724
|
+
# @!attribute [rw] is_attached
|
725
|
+
# A Boolean value indicating whether the disk is attached.
|
726
|
+
# @return [Boolean]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] attachment_state
|
729
|
+
# The attachment state of the disk.
|
730
|
+
# @return [String]
|
731
|
+
class Disk < Struct.new(
|
732
|
+
:name,
|
733
|
+
:arn,
|
734
|
+
:support_code,
|
735
|
+
:created_at,
|
736
|
+
:location,
|
737
|
+
:resource_type,
|
738
|
+
:size_in_gb,
|
739
|
+
:gb_in_use,
|
740
|
+
:is_system_disk,
|
741
|
+
:iops,
|
742
|
+
:path,
|
743
|
+
:attached_to,
|
744
|
+
:is_attached,
|
745
|
+
:attachment_state)
|
746
|
+
include Aws::Structure
|
747
|
+
end
|
748
|
+
|
749
|
+
# Describes a domain where you are storing recordsets in Lightsail.
|
750
|
+
# @!attribute [rw] name
|
751
|
+
# The name of the domain.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] arn
|
755
|
+
# The Amazon Resource Name (ARN) of the domain recordset (e.g.,
|
756
|
+
# `arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE`).
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] support_code
|
760
|
+
# The support code. Include this code in your email to support when
|
761
|
+
# you have questions about an instance or another resource in
|
762
|
+
# Lightsail. This code enables our support team to look up your
|
763
|
+
# Lightsail information more easily.
|
764
|
+
# @return [String]
|
765
|
+
#
|
766
|
+
# @!attribute [rw] created_at
|
767
|
+
# The date when the domain recordset was created.
|
768
|
+
# @return [Time]
|
769
|
+
#
|
770
|
+
# @!attribute [rw] location
|
771
|
+
# The AWS Region and Availability Zones where the domain recordset was
|
772
|
+
# created.
|
773
|
+
# @return [Types::ResourceLocation]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] resource_type
|
776
|
+
# The resource type.
|
777
|
+
# @return [String]
|
778
|
+
#
|
779
|
+
# @!attribute [rw] domain_entries
|
780
|
+
# An array of key-value pairs containing information about the domain
|
781
|
+
# entries.
|
782
|
+
# @return [Array<Types::DomainEntry>]
|
783
|
+
class Domain < Struct.new(
|
784
|
+
:name,
|
785
|
+
:arn,
|
786
|
+
:support_code,
|
787
|
+
:created_at,
|
788
|
+
:location,
|
789
|
+
:resource_type,
|
790
|
+
:domain_entries)
|
791
|
+
include Aws::Structure
|
792
|
+
end
|
793
|
+
|
794
|
+
# Describes a domain recordset entry.
|
795
|
+
# @note When making an API call, pass DomainEntry
|
796
|
+
# data as a hash:
|
797
|
+
#
|
798
|
+
# {
|
799
|
+
# id: "NonEmptyString",
|
800
|
+
# name: "DomainName",
|
801
|
+
# target: "string",
|
802
|
+
# type: "DomainEntryType",
|
803
|
+
# options: {
|
804
|
+
# "DomainEntryOptionsKeys" => "string",
|
805
|
+
# },
|
806
|
+
# }
|
807
|
+
# @!attribute [rw] id
|
808
|
+
# The ID of the domain recordset entry.
|
809
|
+
# @return [String]
|
810
|
+
#
|
811
|
+
# @!attribute [rw] name
|
812
|
+
# The name of the domain.
|
813
|
+
# @return [String]
|
814
|
+
#
|
815
|
+
# @!attribute [rw] target
|
816
|
+
# The target AWS name server (e.g., `ns-111.awsdns-22.com.`).
|
817
|
+
# @return [String]
|
818
|
+
#
|
819
|
+
# @!attribute [rw] type
|
820
|
+
# The type of domain entry (e.g., `SOA` or `NS`).
|
821
|
+
# @return [String]
|
822
|
+
#
|
823
|
+
# @!attribute [rw] options
|
824
|
+
# The options for the domain entry.
|
825
|
+
# @return [Hash<String,String>]
|
826
|
+
class DomainEntry < Struct.new(
|
827
|
+
:id,
|
828
|
+
:name,
|
829
|
+
:target,
|
830
|
+
:type,
|
831
|
+
:options)
|
832
|
+
include Aws::Structure
|
833
|
+
end
|
834
|
+
|
835
|
+
# @api private
|
836
|
+
class DownloadDefaultKeyPairRequest < Aws::EmptyStructure; end
|
837
|
+
|
838
|
+
# @!attribute [rw] public_key_base_64
|
839
|
+
# A base64-encoded public key of the `ssh-rsa` type.
|
840
|
+
# @return [String]
|
841
|
+
#
|
842
|
+
# @!attribute [rw] private_key_base_64
|
843
|
+
# A base64-encoded RSA private key.
|
844
|
+
# @return [String]
|
845
|
+
class DownloadDefaultKeyPairResult < Struct.new(
|
846
|
+
:public_key_base_64,
|
847
|
+
:private_key_base_64)
|
848
|
+
include Aws::Structure
|
849
|
+
end
|
850
|
+
|
851
|
+
# @note When making an API call, pass GetActiveNamesRequest
|
852
|
+
# data as a hash:
|
853
|
+
#
|
854
|
+
# {
|
855
|
+
# page_token: "string",
|
856
|
+
# }
|
857
|
+
# @!attribute [rw] page_token
|
858
|
+
# A token used for paginating results from your get active names
|
859
|
+
# request.
|
860
|
+
# @return [String]
|
861
|
+
class GetActiveNamesRequest < Struct.new(
|
862
|
+
:page_token)
|
863
|
+
include Aws::Structure
|
864
|
+
end
|
865
|
+
|
866
|
+
# @!attribute [rw] active_names
|
867
|
+
# The list of active names returned by the get active names request.
|
868
|
+
# @return [Array<String>]
|
869
|
+
#
|
870
|
+
# @!attribute [rw] next_page_token
|
871
|
+
# A token used for advancing to the next page of results from your get
|
872
|
+
# active names request.
|
873
|
+
# @return [String]
|
874
|
+
class GetActiveNamesResult < Struct.new(
|
875
|
+
:active_names,
|
876
|
+
:next_page_token)
|
877
|
+
include Aws::Structure
|
878
|
+
end
|
879
|
+
|
880
|
+
# @note When making an API call, pass GetBlueprintsRequest
|
881
|
+
# data as a hash:
|
882
|
+
#
|
883
|
+
# {
|
884
|
+
# include_inactive: false,
|
885
|
+
# page_token: "string",
|
886
|
+
# }
|
887
|
+
# @!attribute [rw] include_inactive
|
888
|
+
# A Boolean value indicating whether to include inactive results in
|
889
|
+
# your request.
|
890
|
+
# @return [Boolean]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] page_token
|
893
|
+
# A token used for advancing to the next page of results from your get
|
894
|
+
# blueprints request.
|
895
|
+
# @return [String]
|
896
|
+
class GetBlueprintsRequest < Struct.new(
|
897
|
+
:include_inactive,
|
898
|
+
:page_token)
|
899
|
+
include Aws::Structure
|
900
|
+
end
|
901
|
+
|
902
|
+
# @!attribute [rw] blueprints
|
903
|
+
# An array of key-value pairs that contains information about the
|
904
|
+
# available blueprints.
|
905
|
+
# @return [Array<Types::Blueprint>]
|
906
|
+
#
|
907
|
+
# @!attribute [rw] next_page_token
|
908
|
+
# A token used for advancing to the next page of results from your get
|
909
|
+
# blueprints request.
|
910
|
+
# @return [String]
|
911
|
+
class GetBlueprintsResult < Struct.new(
|
912
|
+
:blueprints,
|
913
|
+
:next_page_token)
|
914
|
+
include Aws::Structure
|
915
|
+
end
|
916
|
+
|
917
|
+
# @note When making an API call, pass GetBundlesRequest
|
918
|
+
# data as a hash:
|
919
|
+
#
|
920
|
+
# {
|
921
|
+
# include_inactive: false,
|
922
|
+
# page_token: "string",
|
923
|
+
# }
|
924
|
+
# @!attribute [rw] include_inactive
|
925
|
+
# A Boolean value that indicates whether to include inactive bundle
|
926
|
+
# results in your request.
|
927
|
+
# @return [Boolean]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] page_token
|
930
|
+
# A token used for advancing to the next page of results from your get
|
931
|
+
# bundles request.
|
932
|
+
# @return [String]
|
933
|
+
class GetBundlesRequest < Struct.new(
|
934
|
+
:include_inactive,
|
935
|
+
:page_token)
|
936
|
+
include Aws::Structure
|
937
|
+
end
|
938
|
+
|
939
|
+
# @!attribute [rw] bundles
|
940
|
+
# An array of key-value pairs that contains information about the
|
941
|
+
# available bundles.
|
942
|
+
# @return [Array<Types::Bundle>]
|
943
|
+
#
|
944
|
+
# @!attribute [rw] next_page_token
|
945
|
+
# A token used for advancing to the next page of results from your get
|
946
|
+
# active names request.
|
947
|
+
# @return [String]
|
948
|
+
class GetBundlesResult < Struct.new(
|
949
|
+
:bundles,
|
950
|
+
:next_page_token)
|
951
|
+
include Aws::Structure
|
952
|
+
end
|
953
|
+
|
954
|
+
# @note When making an API call, pass GetDomainRequest
|
955
|
+
# data as a hash:
|
956
|
+
#
|
957
|
+
# {
|
958
|
+
# domain_name: "DomainName", # required
|
959
|
+
# }
|
960
|
+
# @!attribute [rw] domain_name
|
961
|
+
# The domain name for which your want to return information about.
|
962
|
+
# @return [String]
|
963
|
+
class GetDomainRequest < Struct.new(
|
964
|
+
:domain_name)
|
965
|
+
include Aws::Structure
|
966
|
+
end
|
967
|
+
|
968
|
+
# @!attribute [rw] domain
|
969
|
+
# An array of key-value pairs containing information about your get
|
970
|
+
# domain request.
|
971
|
+
# @return [Types::Domain]
|
972
|
+
class GetDomainResult < Struct.new(
|
973
|
+
:domain)
|
974
|
+
include Aws::Structure
|
975
|
+
end
|
976
|
+
|
977
|
+
# @note When making an API call, pass GetDomainsRequest
|
978
|
+
# data as a hash:
|
979
|
+
#
|
980
|
+
# {
|
981
|
+
# page_token: "string",
|
982
|
+
# }
|
983
|
+
# @!attribute [rw] page_token
|
984
|
+
# A token used for advancing to the next page of results from your get
|
985
|
+
# domains request.
|
986
|
+
# @return [String]
|
987
|
+
class GetDomainsRequest < Struct.new(
|
988
|
+
:page_token)
|
989
|
+
include Aws::Structure
|
990
|
+
end
|
991
|
+
|
992
|
+
# @!attribute [rw] domains
|
993
|
+
# An array of key-value pairs containing information about each of the
|
994
|
+
# domain entries in the user's account.
|
995
|
+
# @return [Array<Types::Domain>]
|
996
|
+
#
|
997
|
+
# @!attribute [rw] next_page_token
|
998
|
+
# A token used for advancing to the next page of results from your get
|
999
|
+
# active names request.
|
1000
|
+
# @return [String]
|
1001
|
+
class GetDomainsResult < Struct.new(
|
1002
|
+
:domains,
|
1003
|
+
:next_page_token)
|
1004
|
+
include Aws::Structure
|
1005
|
+
end
|
1006
|
+
|
1007
|
+
# @note When making an API call, pass GetInstanceAccessDetailsRequest
|
1008
|
+
# data as a hash:
|
1009
|
+
#
|
1010
|
+
# {
|
1011
|
+
# instance_name: "ResourceName", # required
|
1012
|
+
# protocol: "ssh", # accepts ssh, rdp
|
1013
|
+
# }
|
1014
|
+
# @!attribute [rw] instance_name
|
1015
|
+
# The name of the instance to access.
|
1016
|
+
# @return [String]
|
1017
|
+
#
|
1018
|
+
# @!attribute [rw] protocol
|
1019
|
+
# The protocol to use to connect to your instance. Defaults to `ssh`.
|
1020
|
+
# @return [String]
|
1021
|
+
class GetInstanceAccessDetailsRequest < Struct.new(
|
1022
|
+
:instance_name,
|
1023
|
+
:protocol)
|
1024
|
+
include Aws::Structure
|
1025
|
+
end
|
1026
|
+
|
1027
|
+
# @!attribute [rw] access_details
|
1028
|
+
# An array of key-value pairs containing information about a get
|
1029
|
+
# instance access request.
|
1030
|
+
# @return [Types::InstanceAccessDetails]
|
1031
|
+
class GetInstanceAccessDetailsResult < Struct.new(
|
1032
|
+
:access_details)
|
1033
|
+
include Aws::Structure
|
1034
|
+
end
|
1035
|
+
|
1036
|
+
# @note When making an API call, pass GetInstanceMetricDataRequest
|
1037
|
+
# data as a hash:
|
1038
|
+
#
|
1039
|
+
# {
|
1040
|
+
# instance_name: "ResourceName", # required
|
1041
|
+
# metric_name: "CPUUtilization", # required, accepts CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System
|
1042
|
+
# period: 1, # required
|
1043
|
+
# start_time: Time.now, # required
|
1044
|
+
# end_time: Time.now, # required
|
1045
|
+
# unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
|
1046
|
+
# statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
|
1047
|
+
# }
|
1048
|
+
# @!attribute [rw] instance_name
|
1049
|
+
# The name of the instance for which you want to get metrics data.
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] metric_name
|
1053
|
+
# The metric name to get data about.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] period
|
1057
|
+
# The time period for which you are requesting data.
|
1058
|
+
# @return [Integer]
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] start_time
|
1061
|
+
# The start time of the time period.
|
1062
|
+
# @return [Time]
|
1063
|
+
#
|
1064
|
+
# @!attribute [rw] end_time
|
1065
|
+
# The end time of the time period.
|
1066
|
+
# @return [Time]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] unit
|
1069
|
+
# The unit. The list of valid values is below.
|
1070
|
+
# @return [String]
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] statistics
|
1073
|
+
# The instance statistics.
|
1074
|
+
# @return [Array<String>]
|
1075
|
+
class GetInstanceMetricDataRequest < Struct.new(
|
1076
|
+
:instance_name,
|
1077
|
+
:metric_name,
|
1078
|
+
:period,
|
1079
|
+
:start_time,
|
1080
|
+
:end_time,
|
1081
|
+
:unit,
|
1082
|
+
:statistics)
|
1083
|
+
include Aws::Structure
|
1084
|
+
end
|
1085
|
+
|
1086
|
+
# @!attribute [rw] metric_name
|
1087
|
+
# The metric name to return data for.
|
1088
|
+
# @return [String]
|
1089
|
+
#
|
1090
|
+
# @!attribute [rw] metric_data
|
1091
|
+
# An array of key-value pairs containing information about the results
|
1092
|
+
# of your get instance metric data request.
|
1093
|
+
# @return [Array<Types::MetricDatapoint>]
|
1094
|
+
class GetInstanceMetricDataResult < Struct.new(
|
1095
|
+
:metric_name,
|
1096
|
+
:metric_data)
|
1097
|
+
include Aws::Structure
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# @note When making an API call, pass GetInstancePortStatesRequest
|
1101
|
+
# data as a hash:
|
1102
|
+
#
|
1103
|
+
# {
|
1104
|
+
# instance_name: "ResourceName", # required
|
1105
|
+
# }
|
1106
|
+
# @!attribute [rw] instance_name
|
1107
|
+
# The name of the instance.
|
1108
|
+
# @return [String]
|
1109
|
+
class GetInstancePortStatesRequest < Struct.new(
|
1110
|
+
:instance_name)
|
1111
|
+
include Aws::Structure
|
1112
|
+
end
|
1113
|
+
|
1114
|
+
# @!attribute [rw] port_states
|
1115
|
+
# Information about the port states resulting from your request.
|
1116
|
+
# @return [Array<String>]
|
1117
|
+
class GetInstancePortStatesResult < Struct.new(
|
1118
|
+
:port_states)
|
1119
|
+
include Aws::Structure
|
1120
|
+
end
|
1121
|
+
|
1122
|
+
# @note When making an API call, pass GetInstanceRequest
|
1123
|
+
# data as a hash:
|
1124
|
+
#
|
1125
|
+
# {
|
1126
|
+
# instance_name: "ResourceName", # required
|
1127
|
+
# }
|
1128
|
+
# @!attribute [rw] instance_name
|
1129
|
+
# The name of the instance.
|
1130
|
+
# @return [String]
|
1131
|
+
class GetInstanceRequest < Struct.new(
|
1132
|
+
:instance_name)
|
1133
|
+
include Aws::Structure
|
1134
|
+
end
|
1135
|
+
|
1136
|
+
# @!attribute [rw] instance
|
1137
|
+
# An array of key-value pairs containing information about the
|
1138
|
+
# specified instance.
|
1139
|
+
# @return [Types::Instance]
|
1140
|
+
class GetInstanceResult < Struct.new(
|
1141
|
+
:instance)
|
1142
|
+
include Aws::Structure
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
# @note When making an API call, pass GetInstanceSnapshotRequest
|
1146
|
+
# data as a hash:
|
1147
|
+
#
|
1148
|
+
# {
|
1149
|
+
# instance_snapshot_name: "ResourceName", # required
|
1150
|
+
# }
|
1151
|
+
# @!attribute [rw] instance_snapshot_name
|
1152
|
+
# The name of the snapshot for which you are requesting information.
|
1153
|
+
# @return [String]
|
1154
|
+
class GetInstanceSnapshotRequest < Struct.new(
|
1155
|
+
:instance_snapshot_name)
|
1156
|
+
include Aws::Structure
|
1157
|
+
end
|
1158
|
+
|
1159
|
+
# @!attribute [rw] instance_snapshot
|
1160
|
+
# An array of key-value pairs containing information about the results
|
1161
|
+
# of your get instance snapshot request.
|
1162
|
+
# @return [Types::InstanceSnapshot]
|
1163
|
+
class GetInstanceSnapshotResult < Struct.new(
|
1164
|
+
:instance_snapshot)
|
1165
|
+
include Aws::Structure
|
1166
|
+
end
|
1167
|
+
|
1168
|
+
# @note When making an API call, pass GetInstanceSnapshotsRequest
|
1169
|
+
# data as a hash:
|
1170
|
+
#
|
1171
|
+
# {
|
1172
|
+
# page_token: "string",
|
1173
|
+
# }
|
1174
|
+
# @!attribute [rw] page_token
|
1175
|
+
# A token used for advancing to the next page of results from your get
|
1176
|
+
# instance snapshots request.
|
1177
|
+
# @return [String]
|
1178
|
+
class GetInstanceSnapshotsRequest < Struct.new(
|
1179
|
+
:page_token)
|
1180
|
+
include Aws::Structure
|
1181
|
+
end
|
1182
|
+
|
1183
|
+
# @!attribute [rw] instance_snapshots
|
1184
|
+
# An array of key-value pairs containing information about the results
|
1185
|
+
# of your get instance snapshots request.
|
1186
|
+
# @return [Array<Types::InstanceSnapshot>]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] next_page_token
|
1189
|
+
# A token used for advancing to the next page of results from your get
|
1190
|
+
# instance snapshots request.
|
1191
|
+
# @return [String]
|
1192
|
+
class GetInstanceSnapshotsResult < Struct.new(
|
1193
|
+
:instance_snapshots,
|
1194
|
+
:next_page_token)
|
1195
|
+
include Aws::Structure
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
# @note When making an API call, pass GetInstanceStateRequest
|
1199
|
+
# data as a hash:
|
1200
|
+
#
|
1201
|
+
# {
|
1202
|
+
# instance_name: "ResourceName", # required
|
1203
|
+
# }
|
1204
|
+
# @!attribute [rw] instance_name
|
1205
|
+
# The name of the instance to get state information about.
|
1206
|
+
# @return [String]
|
1207
|
+
class GetInstanceStateRequest < Struct.new(
|
1208
|
+
:instance_name)
|
1209
|
+
include Aws::Structure
|
1210
|
+
end
|
1211
|
+
|
1212
|
+
# @!attribute [rw] state
|
1213
|
+
# The state of the instance.
|
1214
|
+
# @return [Types::InstanceState]
|
1215
|
+
class GetInstanceStateResult < Struct.new(
|
1216
|
+
:state)
|
1217
|
+
include Aws::Structure
|
1218
|
+
end
|
1219
|
+
|
1220
|
+
# @note When making an API call, pass GetInstancesRequest
|
1221
|
+
# data as a hash:
|
1222
|
+
#
|
1223
|
+
# {
|
1224
|
+
# page_token: "string",
|
1225
|
+
# }
|
1226
|
+
# @!attribute [rw] page_token
|
1227
|
+
# A token used for advancing to the next page of results from your get
|
1228
|
+
# instances request.
|
1229
|
+
# @return [String]
|
1230
|
+
class GetInstancesRequest < Struct.new(
|
1231
|
+
:page_token)
|
1232
|
+
include Aws::Structure
|
1233
|
+
end
|
1234
|
+
|
1235
|
+
# @!attribute [rw] instances
|
1236
|
+
# An array of key-value pairs containing information about your
|
1237
|
+
# instances.
|
1238
|
+
# @return [Array<Types::Instance>]
|
1239
|
+
#
|
1240
|
+
# @!attribute [rw] next_page_token
|
1241
|
+
# A token used for advancing to the next page of results from your get
|
1242
|
+
# instances request.
|
1243
|
+
# @return [String]
|
1244
|
+
class GetInstancesResult < Struct.new(
|
1245
|
+
:instances,
|
1246
|
+
:next_page_token)
|
1247
|
+
include Aws::Structure
|
1248
|
+
end
|
1249
|
+
|
1250
|
+
# @note When making an API call, pass GetKeyPairRequest
|
1251
|
+
# data as a hash:
|
1252
|
+
#
|
1253
|
+
# {
|
1254
|
+
# key_pair_name: "ResourceName", # required
|
1255
|
+
# }
|
1256
|
+
# @!attribute [rw] key_pair_name
|
1257
|
+
# The name of the key pair for which you are requesting information.
|
1258
|
+
# @return [String]
|
1259
|
+
class GetKeyPairRequest < Struct.new(
|
1260
|
+
:key_pair_name)
|
1261
|
+
include Aws::Structure
|
1262
|
+
end
|
1263
|
+
|
1264
|
+
# @!attribute [rw] key_pair
|
1265
|
+
# An array of key-value pairs containing information about the key
|
1266
|
+
# pair.
|
1267
|
+
# @return [Types::KeyPair]
|
1268
|
+
class GetKeyPairResult < Struct.new(
|
1269
|
+
:key_pair)
|
1270
|
+
include Aws::Structure
|
1271
|
+
end
|
1272
|
+
|
1273
|
+
# @note When making an API call, pass GetKeyPairsRequest
|
1274
|
+
# data as a hash:
|
1275
|
+
#
|
1276
|
+
# {
|
1277
|
+
# page_token: "string",
|
1278
|
+
# }
|
1279
|
+
# @!attribute [rw] page_token
|
1280
|
+
# A token used for advancing to the next page of results from your get
|
1281
|
+
# key pairs request.
|
1282
|
+
# @return [String]
|
1283
|
+
class GetKeyPairsRequest < Struct.new(
|
1284
|
+
:page_token)
|
1285
|
+
include Aws::Structure
|
1286
|
+
end
|
1287
|
+
|
1288
|
+
# @!attribute [rw] key_pairs
|
1289
|
+
# An array of key-value pairs containing information about the key
|
1290
|
+
# pairs.
|
1291
|
+
# @return [Array<Types::KeyPair>]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] next_page_token
|
1294
|
+
# A token used for advancing to the next page of results from your get
|
1295
|
+
# key pairs request.
|
1296
|
+
# @return [String]
|
1297
|
+
class GetKeyPairsResult < Struct.new(
|
1298
|
+
:key_pairs,
|
1299
|
+
:next_page_token)
|
1300
|
+
include Aws::Structure
|
1301
|
+
end
|
1302
|
+
|
1303
|
+
# @note When making an API call, pass GetOperationRequest
|
1304
|
+
# data as a hash:
|
1305
|
+
#
|
1306
|
+
# {
|
1307
|
+
# operation_id: "NonEmptyString", # required
|
1308
|
+
# }
|
1309
|
+
# @!attribute [rw] operation_id
|
1310
|
+
# A GUID used to identify the operation.
|
1311
|
+
# @return [String]
|
1312
|
+
class GetOperationRequest < Struct.new(
|
1313
|
+
:operation_id)
|
1314
|
+
include Aws::Structure
|
1315
|
+
end
|
1316
|
+
|
1317
|
+
# @!attribute [rw] operation
|
1318
|
+
# An array of key-value pairs containing information about the results
|
1319
|
+
# of your get operation request.
|
1320
|
+
# @return [Types::Operation]
|
1321
|
+
class GetOperationResult < Struct.new(
|
1322
|
+
:operation)
|
1323
|
+
include Aws::Structure
|
1324
|
+
end
|
1325
|
+
|
1326
|
+
# @note When making an API call, pass GetOperationsForResourceRequest
|
1327
|
+
# data as a hash:
|
1328
|
+
#
|
1329
|
+
# {
|
1330
|
+
# resource_name: "ResourceName", # required
|
1331
|
+
# page_token: "string",
|
1332
|
+
# }
|
1333
|
+
# @!attribute [rw] resource_name
|
1334
|
+
# The name of the resource for which you are requesting information.
|
1335
|
+
# @return [String]
|
1336
|
+
#
|
1337
|
+
# @!attribute [rw] page_token
|
1338
|
+
# A token used for advancing to the next page of results from your get
|
1339
|
+
# operations for resource request.
|
1340
|
+
# @return [String]
|
1341
|
+
class GetOperationsForResourceRequest < Struct.new(
|
1342
|
+
:resource_name,
|
1343
|
+
:page_token)
|
1344
|
+
include Aws::Structure
|
1345
|
+
end
|
1346
|
+
|
1347
|
+
# @!attribute [rw] operations
|
1348
|
+
# An array of key-value pairs containing information about the results
|
1349
|
+
# of your get operations for resource request.
|
1350
|
+
# @return [Array<Types::Operation>]
|
1351
|
+
#
|
1352
|
+
# @!attribute [rw] next_page_count
|
1353
|
+
# Returns the number of pages of results that remain.
|
1354
|
+
# @return [String]
|
1355
|
+
class GetOperationsForResourceResult < Struct.new(
|
1356
|
+
:operations,
|
1357
|
+
:next_page_count)
|
1358
|
+
include Aws::Structure
|
1359
|
+
end
|
1360
|
+
|
1361
|
+
# @note When making an API call, pass GetOperationsRequest
|
1362
|
+
# data as a hash:
|
1363
|
+
#
|
1364
|
+
# {
|
1365
|
+
# page_token: "string",
|
1366
|
+
# }
|
1367
|
+
# @!attribute [rw] page_token
|
1368
|
+
# A token used for advancing to the next page of results from your get
|
1369
|
+
# operations request.
|
1370
|
+
# @return [String]
|
1371
|
+
class GetOperationsRequest < Struct.new(
|
1372
|
+
:page_token)
|
1373
|
+
include Aws::Structure
|
1374
|
+
end
|
1375
|
+
|
1376
|
+
# @!attribute [rw] operations
|
1377
|
+
# An array of key-value pairs containing information about the results
|
1378
|
+
# of your get operations request.
|
1379
|
+
# @return [Array<Types::Operation>]
|
1380
|
+
#
|
1381
|
+
# @!attribute [rw] next_page_token
|
1382
|
+
# A token used for advancing to the next page of results from your get
|
1383
|
+
# operations request.
|
1384
|
+
# @return [String]
|
1385
|
+
class GetOperationsResult < Struct.new(
|
1386
|
+
:operations,
|
1387
|
+
:next_page_token)
|
1388
|
+
include Aws::Structure
|
1389
|
+
end
|
1390
|
+
|
1391
|
+
# @note When making an API call, pass GetRegionsRequest
|
1392
|
+
# data as a hash:
|
1393
|
+
#
|
1394
|
+
# {
|
1395
|
+
# include_availability_zones: false,
|
1396
|
+
# }
|
1397
|
+
# @!attribute [rw] include_availability_zones
|
1398
|
+
# A Boolean value indicating whether to also include Availability
|
1399
|
+
# Zones in your get regions request. Availability Zones are indicated
|
1400
|
+
# with a letter: e.g., `us-east-1a`.
|
1401
|
+
# @return [Boolean]
|
1402
|
+
class GetRegionsRequest < Struct.new(
|
1403
|
+
:include_availability_zones)
|
1404
|
+
include Aws::Structure
|
1405
|
+
end
|
1406
|
+
|
1407
|
+
# @!attribute [rw] regions
|
1408
|
+
# An array of key-value pairs containing information about your get
|
1409
|
+
# regions request.
|
1410
|
+
# @return [Array<Types::Region>]
|
1411
|
+
class GetRegionsResult < Struct.new(
|
1412
|
+
:regions)
|
1413
|
+
include Aws::Structure
|
1414
|
+
end
|
1415
|
+
|
1416
|
+
# @note When making an API call, pass GetStaticIpRequest
|
1417
|
+
# data as a hash:
|
1418
|
+
#
|
1419
|
+
# {
|
1420
|
+
# static_ip_name: "ResourceName", # required
|
1421
|
+
# }
|
1422
|
+
# @!attribute [rw] static_ip_name
|
1423
|
+
# The name of the static IP in Lightsail.
|
1424
|
+
# @return [String]
|
1425
|
+
class GetStaticIpRequest < Struct.new(
|
1426
|
+
:static_ip_name)
|
1427
|
+
include Aws::Structure
|
1428
|
+
end
|
1429
|
+
|
1430
|
+
# @!attribute [rw] static_ip
|
1431
|
+
# An array of key-value pairs containing information about the
|
1432
|
+
# requested static IP.
|
1433
|
+
# @return [Types::StaticIp]
|
1434
|
+
class GetStaticIpResult < Struct.new(
|
1435
|
+
:static_ip)
|
1436
|
+
include Aws::Structure
|
1437
|
+
end
|
1438
|
+
|
1439
|
+
# @note When making an API call, pass GetStaticIpsRequest
|
1440
|
+
# data as a hash:
|
1441
|
+
#
|
1442
|
+
# {
|
1443
|
+
# page_token: "string",
|
1444
|
+
# }
|
1445
|
+
# @!attribute [rw] page_token
|
1446
|
+
# A token used for advancing to the next page of results from your get
|
1447
|
+
# static IPs request.
|
1448
|
+
# @return [String]
|
1449
|
+
class GetStaticIpsRequest < Struct.new(
|
1450
|
+
:page_token)
|
1451
|
+
include Aws::Structure
|
1452
|
+
end
|
1453
|
+
|
1454
|
+
# @!attribute [rw] static_ips
|
1455
|
+
# An array of key-value pairs containing information about your get
|
1456
|
+
# static IPs request.
|
1457
|
+
# @return [Array<Types::StaticIp>]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] next_page_token
|
1460
|
+
# A token used for advancing to the next page of results from your get
|
1461
|
+
# static IPs request.
|
1462
|
+
# @return [String]
|
1463
|
+
class GetStaticIpsResult < Struct.new(
|
1464
|
+
:static_ips,
|
1465
|
+
:next_page_token)
|
1466
|
+
include Aws::Structure
|
1467
|
+
end
|
1468
|
+
|
1469
|
+
# @note When making an API call, pass ImportKeyPairRequest
|
1470
|
+
# data as a hash:
|
1471
|
+
#
|
1472
|
+
# {
|
1473
|
+
# key_pair_name: "ResourceName", # required
|
1474
|
+
# public_key_base_64: "Base64", # required
|
1475
|
+
# }
|
1476
|
+
# @!attribute [rw] key_pair_name
|
1477
|
+
# The name of the key pair for which you want to import the public
|
1478
|
+
# key.
|
1479
|
+
# @return [String]
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] public_key_base_64
|
1482
|
+
# A base64-encoded public key of the `ssh-rsa` type.
|
1483
|
+
# @return [String]
|
1484
|
+
class ImportKeyPairRequest < Struct.new(
|
1485
|
+
:key_pair_name,
|
1486
|
+
:public_key_base_64)
|
1487
|
+
include Aws::Structure
|
1488
|
+
end
|
1489
|
+
|
1490
|
+
# @!attribute [rw] operation
|
1491
|
+
# An array of key-value pairs containing information about the request
|
1492
|
+
# operation.
|
1493
|
+
# @return [Types::Operation]
|
1494
|
+
class ImportKeyPairResult < Struct.new(
|
1495
|
+
:operation)
|
1496
|
+
include Aws::Structure
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# Describes an instance (a virtual private server).
|
1500
|
+
# @!attribute [rw] name
|
1501
|
+
# The name the user gave the instance (e.g.,
|
1502
|
+
# `Amazon_Linux-1GB-Virginia-1`).
|
1503
|
+
# @return [String]
|
1504
|
+
#
|
1505
|
+
# @!attribute [rw] arn
|
1506
|
+
# The Amazon Resource Name (ARN) of the instance (e.g.,
|
1507
|
+
# `arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE`).
|
1508
|
+
# @return [String]
|
1509
|
+
#
|
1510
|
+
# @!attribute [rw] support_code
|
1511
|
+
# The support code. Include this code in your email to support when
|
1512
|
+
# you have questions about an instance or another resource in
|
1513
|
+
# Lightsail. This code enables our support team to look up your
|
1514
|
+
# Lightsail information more easily.
|
1515
|
+
# @return [String]
|
1516
|
+
#
|
1517
|
+
# @!attribute [rw] created_at
|
1518
|
+
# The timestamp when the instance was created (e.g., `1479734909.17`).
|
1519
|
+
# @return [Time]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] location
|
1522
|
+
# The region name and availability zone where the instance is located.
|
1523
|
+
# @return [Types::ResourceLocation]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] resource_type
|
1526
|
+
# The type of resource (usually `Instance`).
|
1527
|
+
# @return [String]
|
1528
|
+
#
|
1529
|
+
# @!attribute [rw] blueprint_id
|
1530
|
+
# The blueprint ID (e.g., `os_amlinux_2016_03`).
|
1531
|
+
# @return [String]
|
1532
|
+
#
|
1533
|
+
# @!attribute [rw] blueprint_name
|
1534
|
+
# The friendly name of the blueprint (e.g., `Amazon Linux`).
|
1535
|
+
# @return [String]
|
1536
|
+
#
|
1537
|
+
# @!attribute [rw] bundle_id
|
1538
|
+
# The bundle for the instance (e.g., `micro_1_0`).
|
1539
|
+
# @return [String]
|
1540
|
+
#
|
1541
|
+
# @!attribute [rw] is_static_ip
|
1542
|
+
# A Boolean value indicating whether this instance has a static IP
|
1543
|
+
# assigned to it.
|
1544
|
+
# @return [Boolean]
|
1545
|
+
#
|
1546
|
+
# @!attribute [rw] private_ip_address
|
1547
|
+
# The private IP address of the instance.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] public_ip_address
|
1551
|
+
# The public IP address of the instance.
|
1552
|
+
# @return [String]
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] ipv6_address
|
1555
|
+
# The IPv6 address of the instance.
|
1556
|
+
# @return [String]
|
1557
|
+
#
|
1558
|
+
# @!attribute [rw] hardware
|
1559
|
+
# The size of the vCPU and the amount of RAM for the instance.
|
1560
|
+
# @return [Types::InstanceHardware]
|
1561
|
+
#
|
1562
|
+
# @!attribute [rw] networking
|
1563
|
+
# Information about the public ports and monthly data transfer rates
|
1564
|
+
# for the instance.
|
1565
|
+
# @return [Types::InstanceNetworking]
|
1566
|
+
#
|
1567
|
+
# @!attribute [rw] state
|
1568
|
+
# The status code and the state (e.g., `running`) for the instance.
|
1569
|
+
# @return [Types::InstanceState]
|
1570
|
+
#
|
1571
|
+
# @!attribute [rw] username
|
1572
|
+
# The user name for connecting to the instance (e.g., `ec2-user`).
|
1573
|
+
# @return [String]
|
1574
|
+
#
|
1575
|
+
# @!attribute [rw] ssh_key_name
|
1576
|
+
# The name of the SSH key being used to connect to the instance (e.g.,
|
1577
|
+
# `LightsailDefaultKeyPair`).
|
1578
|
+
# @return [String]
|
1579
|
+
class Instance < Struct.new(
|
1580
|
+
:name,
|
1581
|
+
:arn,
|
1582
|
+
:support_code,
|
1583
|
+
:created_at,
|
1584
|
+
:location,
|
1585
|
+
:resource_type,
|
1586
|
+
:blueprint_id,
|
1587
|
+
:blueprint_name,
|
1588
|
+
:bundle_id,
|
1589
|
+
:is_static_ip,
|
1590
|
+
:private_ip_address,
|
1591
|
+
:public_ip_address,
|
1592
|
+
:ipv6_address,
|
1593
|
+
:hardware,
|
1594
|
+
:networking,
|
1595
|
+
:state,
|
1596
|
+
:username,
|
1597
|
+
:ssh_key_name)
|
1598
|
+
include Aws::Structure
|
1599
|
+
end
|
1600
|
+
|
1601
|
+
# The parameters for gaining temporary access to one of your Amazon
|
1602
|
+
# Lightsail instances.
|
1603
|
+
# @!attribute [rw] cert_key
|
1604
|
+
# For SSH access, the public key to use when accessing your instance
|
1605
|
+
# For OpenSSH clients (e.g., command line SSH), you should save this
|
1606
|
+
# value to `tempkey-cert.pub`.
|
1607
|
+
# @return [String]
|
1608
|
+
#
|
1609
|
+
# @!attribute [rw] expires_at
|
1610
|
+
# For SSH access, the date on which the temporary keys expire.
|
1611
|
+
# @return [Time]
|
1612
|
+
#
|
1613
|
+
# @!attribute [rw] ip_address
|
1614
|
+
# The public IP address of the Amazon Lightsail instance.
|
1615
|
+
# @return [String]
|
1616
|
+
#
|
1617
|
+
# @!attribute [rw] password
|
1618
|
+
# For RDP access, the temporary password of the Amazon EC2 instance.
|
1619
|
+
# @return [String]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] private_key
|
1622
|
+
# For SSH access, the temporary private key. For OpenSSH clients
|
1623
|
+
# (e.g., command line SSH), you should save this value to `tempkey`).
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1626
|
+
# @!attribute [rw] protocol
|
1627
|
+
# The protocol for these Amazon Lightsail instance access details.
|
1628
|
+
# @return [String]
|
1629
|
+
#
|
1630
|
+
# @!attribute [rw] instance_name
|
1631
|
+
# The name of this Amazon Lightsail instance.
|
1632
|
+
# @return [String]
|
1633
|
+
#
|
1634
|
+
# @!attribute [rw] username
|
1635
|
+
# The user name to use when logging in to the Amazon Lightsail
|
1636
|
+
# instance.
|
1637
|
+
# @return [String]
|
1638
|
+
class InstanceAccessDetails < Struct.new(
|
1639
|
+
:cert_key,
|
1640
|
+
:expires_at,
|
1641
|
+
:ip_address,
|
1642
|
+
:password,
|
1643
|
+
:private_key,
|
1644
|
+
:protocol,
|
1645
|
+
:instance_name,
|
1646
|
+
:username)
|
1647
|
+
include Aws::Structure
|
1648
|
+
end
|
1649
|
+
|
1650
|
+
# Describes the hardware for the instance.
|
1651
|
+
# @!attribute [rw] cpu_count
|
1652
|
+
# The number of vCPUs the instance has.
|
1653
|
+
# @return [Integer]
|
1654
|
+
#
|
1655
|
+
# @!attribute [rw] disks
|
1656
|
+
# The disks attached to the instance.
|
1657
|
+
# @return [Array<Types::Disk>]
|
1658
|
+
#
|
1659
|
+
# @!attribute [rw] ram_size_in_gb
|
1660
|
+
# The amount of RAM in GB on the instance (e.g., `1.0`).
|
1661
|
+
# @return [Float]
|
1662
|
+
class InstanceHardware < Struct.new(
|
1663
|
+
:cpu_count,
|
1664
|
+
:disks,
|
1665
|
+
:ram_size_in_gb)
|
1666
|
+
include Aws::Structure
|
1667
|
+
end
|
1668
|
+
|
1669
|
+
# Describes monthly data transfer rates and port information for an
|
1670
|
+
# instance.
|
1671
|
+
# @!attribute [rw] monthly_transfer
|
1672
|
+
# The amount of data in GB allocated for monthly data transfers.
|
1673
|
+
# @return [Types::MonthlyTransfer]
|
1674
|
+
#
|
1675
|
+
# @!attribute [rw] ports
|
1676
|
+
# An array of key-value pairs containing information about the ports
|
1677
|
+
# on the instance.
|
1678
|
+
# @return [Array<Types::InstancePortInfo>]
|
1679
|
+
class InstanceNetworking < Struct.new(
|
1680
|
+
:monthly_transfer,
|
1681
|
+
:ports)
|
1682
|
+
include Aws::Structure
|
1683
|
+
end
|
1684
|
+
|
1685
|
+
# Describes information about the instance ports.
|
1686
|
+
# @!attribute [rw] from_port
|
1687
|
+
# The first port in the range.
|
1688
|
+
# @return [Integer]
|
1689
|
+
#
|
1690
|
+
# @!attribute [rw] to_port
|
1691
|
+
# The last port in the range.
|
1692
|
+
# @return [Integer]
|
1693
|
+
#
|
1694
|
+
# @!attribute [rw] protocol
|
1695
|
+
# The protocol.
|
1696
|
+
# @return [String]
|
1697
|
+
#
|
1698
|
+
# @!attribute [rw] access_from
|
1699
|
+
# The location from which access is allowed (e.g., `Anywhere
|
1700
|
+
# (0.0.0.0/0)`).
|
1701
|
+
# @return [String]
|
1702
|
+
#
|
1703
|
+
# @!attribute [rw] access_type
|
1704
|
+
# The type of access (`Public` or `Private`).
|
1705
|
+
# @return [String]
|
1706
|
+
#
|
1707
|
+
# @!attribute [rw] common_name
|
1708
|
+
# The common name.
|
1709
|
+
# @return [String]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] access_direction
|
1712
|
+
# The access direction (`inbound` or `outbound`).
|
1713
|
+
# @return [String]
|
1714
|
+
class InstancePortInfo < Struct.new(
|
1715
|
+
:from_port,
|
1716
|
+
:to_port,
|
1717
|
+
:protocol,
|
1718
|
+
:access_from,
|
1719
|
+
:access_type,
|
1720
|
+
:common_name,
|
1721
|
+
:access_direction)
|
1722
|
+
include Aws::Structure
|
1723
|
+
end
|
1724
|
+
|
1725
|
+
# Describes the snapshot of the virtual private server, or *instance*.
|
1726
|
+
# @!attribute [rw] name
|
1727
|
+
# The name of the snapshot.
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] arn
|
1731
|
+
# The Amazon Resource Name (ARN) of the snapshot (e.g.,
|
1732
|
+
# `arn:aws:lightsail:us-east-1:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE`).
|
1733
|
+
# @return [String]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] support_code
|
1736
|
+
# The support code. Include this code in your email to support when
|
1737
|
+
# you have questions about an instance or another resource in
|
1738
|
+
# Lightsail. This code enables our support team to look up your
|
1739
|
+
# Lightsail information more easily.
|
1740
|
+
# @return [String]
|
1741
|
+
#
|
1742
|
+
# @!attribute [rw] created_at
|
1743
|
+
# The timestamp when the snapshot was created (e.g.,
|
1744
|
+
# `1479907467.024`).
|
1745
|
+
# @return [Time]
|
1746
|
+
#
|
1747
|
+
# @!attribute [rw] location
|
1748
|
+
# The region name and availability zone where you created the
|
1749
|
+
# snapshot.
|
1750
|
+
# @return [Types::ResourceLocation]
|
1751
|
+
#
|
1752
|
+
# @!attribute [rw] resource_type
|
1753
|
+
# The type of resource (usually `InstanceSnapshot`).
|
1754
|
+
# @return [String]
|
1755
|
+
#
|
1756
|
+
# @!attribute [rw] state
|
1757
|
+
# The state the snapshot is in.
|
1758
|
+
# @return [String]
|
1759
|
+
#
|
1760
|
+
# @!attribute [rw] progress
|
1761
|
+
# The progress of the snapshot.
|
1762
|
+
# @return [String]
|
1763
|
+
#
|
1764
|
+
# @!attribute [rw] from_instance_name
|
1765
|
+
# The instance from which the snapshot was created.
|
1766
|
+
# @return [String]
|
1767
|
+
#
|
1768
|
+
# @!attribute [rw] from_instance_arn
|
1769
|
+
# The Amazon Resource Name (ARN) of the instance from which the
|
1770
|
+
# snapshot was created (e.g.,
|
1771
|
+
# `arn:aws:lightsail:us-east-1:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE`).
|
1772
|
+
# @return [String]
|
1773
|
+
#
|
1774
|
+
# @!attribute [rw] from_blueprint_id
|
1775
|
+
# The blueprint ID from which you created the snapshot (e.g.,
|
1776
|
+
# `os_debian_8_3`). A blueprint is a virtual private server (or
|
1777
|
+
# *instance*) image used to create instances quickly.
|
1778
|
+
# @return [String]
|
1779
|
+
#
|
1780
|
+
# @!attribute [rw] from_bundle_id
|
1781
|
+
# The bundle ID from which you created the snapshot (e.g.,
|
1782
|
+
# `micro_1_0`).
|
1783
|
+
# @return [String]
|
1784
|
+
#
|
1785
|
+
# @!attribute [rw] size_in_gb
|
1786
|
+
# The size in GB of the SSD.
|
1787
|
+
# @return [Integer]
|
1788
|
+
class InstanceSnapshot < Struct.new(
|
1789
|
+
:name,
|
1790
|
+
:arn,
|
1791
|
+
:support_code,
|
1792
|
+
:created_at,
|
1793
|
+
:location,
|
1794
|
+
:resource_type,
|
1795
|
+
:state,
|
1796
|
+
:progress,
|
1797
|
+
:from_instance_name,
|
1798
|
+
:from_instance_arn,
|
1799
|
+
:from_blueprint_id,
|
1800
|
+
:from_bundle_id,
|
1801
|
+
:size_in_gb)
|
1802
|
+
include Aws::Structure
|
1803
|
+
end
|
1804
|
+
|
1805
|
+
# Describes the virtual private server (or *instance*) status.
|
1806
|
+
# @!attribute [rw] code
|
1807
|
+
# The status code for the instance.
|
1808
|
+
# @return [Integer]
|
1809
|
+
#
|
1810
|
+
# @!attribute [rw] name
|
1811
|
+
# The state of the instance (e.g., `running` or `pending`).
|
1812
|
+
# @return [String]
|
1813
|
+
class InstanceState < Struct.new(
|
1814
|
+
:code,
|
1815
|
+
:name)
|
1816
|
+
include Aws::Structure
|
1817
|
+
end
|
1818
|
+
|
1819
|
+
# @api private
|
1820
|
+
class IsVpcPeeredRequest < Aws::EmptyStructure; end
|
1821
|
+
|
1822
|
+
# @!attribute [rw] is_peered
|
1823
|
+
# Returns `true` if the Lightsail VPC is peered; otherwise, `false`.
|
1824
|
+
# @return [Boolean]
|
1825
|
+
class IsVpcPeeredResult < Struct.new(
|
1826
|
+
:is_peered)
|
1827
|
+
include Aws::Structure
|
1828
|
+
end
|
1829
|
+
|
1830
|
+
# Describes the SSH key pair.
|
1831
|
+
# @!attribute [rw] name
|
1832
|
+
# The friendly name of the SSH key pair.
|
1833
|
+
# @return [String]
|
1834
|
+
#
|
1835
|
+
# @!attribute [rw] arn
|
1836
|
+
# The Amazon Resource Name (ARN) of the key pair (e.g.,
|
1837
|
+
# `arn:aws:lightsail:us-east-1:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE`).
|
1838
|
+
# @return [String]
|
1839
|
+
#
|
1840
|
+
# @!attribute [rw] support_code
|
1841
|
+
# The support code. Include this code in your email to support when
|
1842
|
+
# you have questions about an instance or another resource in
|
1843
|
+
# Lightsail. This code enables our support team to look up your
|
1844
|
+
# Lightsail information more easily.
|
1845
|
+
# @return [String]
|
1846
|
+
#
|
1847
|
+
# @!attribute [rw] created_at
|
1848
|
+
# The timestamp when the key pair was created (e.g.,
|
1849
|
+
# `1479816991.349`).
|
1850
|
+
# @return [Time]
|
1851
|
+
#
|
1852
|
+
# @!attribute [rw] location
|
1853
|
+
# The region name and Availability Zone where the key pair was
|
1854
|
+
# created.
|
1855
|
+
# @return [Types::ResourceLocation]
|
1856
|
+
#
|
1857
|
+
# @!attribute [rw] resource_type
|
1858
|
+
# The resource type (usually `KeyPair`).
|
1859
|
+
# @return [String]
|
1860
|
+
#
|
1861
|
+
# @!attribute [rw] fingerprint
|
1862
|
+
# The RSA fingerprint of the key pair.
|
1863
|
+
# @return [String]
|
1864
|
+
class KeyPair < Struct.new(
|
1865
|
+
:name,
|
1866
|
+
:arn,
|
1867
|
+
:support_code,
|
1868
|
+
:created_at,
|
1869
|
+
:location,
|
1870
|
+
:resource_type,
|
1871
|
+
:fingerprint)
|
1872
|
+
include Aws::Structure
|
1873
|
+
end
|
1874
|
+
|
1875
|
+
# Describes the metric data point.
|
1876
|
+
# @!attribute [rw] average
|
1877
|
+
# The average.
|
1878
|
+
# @return [Float]
|
1879
|
+
#
|
1880
|
+
# @!attribute [rw] maximum
|
1881
|
+
# The maximum.
|
1882
|
+
# @return [Float]
|
1883
|
+
#
|
1884
|
+
# @!attribute [rw] minimum
|
1885
|
+
# The minimum.
|
1886
|
+
# @return [Float]
|
1887
|
+
#
|
1888
|
+
# @!attribute [rw] sample_count
|
1889
|
+
# The sample count.
|
1890
|
+
# @return [Float]
|
1891
|
+
#
|
1892
|
+
# @!attribute [rw] sum
|
1893
|
+
# The sum.
|
1894
|
+
# @return [Float]
|
1895
|
+
#
|
1896
|
+
# @!attribute [rw] timestamp
|
1897
|
+
# The timestamp (e.g., `1479816991.349`).
|
1898
|
+
# @return [Time]
|
1899
|
+
#
|
1900
|
+
# @!attribute [rw] unit
|
1901
|
+
# The unit.
|
1902
|
+
# @return [String]
|
1903
|
+
class MetricDatapoint < Struct.new(
|
1904
|
+
:average,
|
1905
|
+
:maximum,
|
1906
|
+
:minimum,
|
1907
|
+
:sample_count,
|
1908
|
+
:sum,
|
1909
|
+
:timestamp,
|
1910
|
+
:unit)
|
1911
|
+
include Aws::Structure
|
1912
|
+
end
|
1913
|
+
|
1914
|
+
# Describes the monthly data transfer in and out of your virtual private
|
1915
|
+
# server (or *instance*).
|
1916
|
+
# @!attribute [rw] gb_per_month_allocated
|
1917
|
+
# The amount allocated per month (in GB).
|
1918
|
+
# @return [Integer]
|
1919
|
+
class MonthlyTransfer < Struct.new(
|
1920
|
+
:gb_per_month_allocated)
|
1921
|
+
include Aws::Structure
|
1922
|
+
end
|
1923
|
+
|
1924
|
+
# @note When making an API call, pass OpenInstancePublicPortsRequest
|
1925
|
+
# data as a hash:
|
1926
|
+
#
|
1927
|
+
# {
|
1928
|
+
# port_info: { # required
|
1929
|
+
# from_port: 1,
|
1930
|
+
# to_port: 1,
|
1931
|
+
# protocol: "tcp", # accepts tcp, all, udp
|
1932
|
+
# },
|
1933
|
+
# instance_name: "ResourceName", # required
|
1934
|
+
# }
|
1935
|
+
# @!attribute [rw] port_info
|
1936
|
+
# An array of key-value pairs containing information about the port
|
1937
|
+
# mappings.
|
1938
|
+
# @return [Types::PortInfo]
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] instance_name
|
1941
|
+
# The name of the instance for which you want to open the public
|
1942
|
+
# ports.
|
1943
|
+
# @return [String]
|
1944
|
+
class OpenInstancePublicPortsRequest < Struct.new(
|
1945
|
+
:port_info,
|
1946
|
+
:instance_name)
|
1947
|
+
include Aws::Structure
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# @!attribute [rw] operation
|
1951
|
+
# An array of key-value pairs containing information about the request
|
1952
|
+
# operation.
|
1953
|
+
# @return [Types::Operation]
|
1954
|
+
class OpenInstancePublicPortsResult < Struct.new(
|
1955
|
+
:operation)
|
1956
|
+
include Aws::Structure
|
1957
|
+
end
|
1958
|
+
|
1959
|
+
# Describes the API operation.
|
1960
|
+
# @!attribute [rw] id
|
1961
|
+
# The ID of the operation.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] resource_name
|
1965
|
+
# The resource name.
|
1966
|
+
# @return [String]
|
1967
|
+
#
|
1968
|
+
# @!attribute [rw] resource_type
|
1969
|
+
# The resource type.
|
1970
|
+
# @return [String]
|
1971
|
+
#
|
1972
|
+
# @!attribute [rw] created_at
|
1973
|
+
# The timestamp when the operation was initialized (e.g.,
|
1974
|
+
# `1479816991.349`).
|
1975
|
+
# @return [Time]
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] location
|
1978
|
+
# The region and Availability Zone.
|
1979
|
+
# @return [Types::ResourceLocation]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] is_terminal
|
1982
|
+
# A Boolean value indicating whether the operation is terminal.
|
1983
|
+
# @return [Boolean]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] operation_details
|
1986
|
+
# Details about the operation (e.g., `Debian-1GB-Virginia-1`).
|
1987
|
+
# @return [String]
|
1988
|
+
#
|
1989
|
+
# @!attribute [rw] operation_type
|
1990
|
+
# The type of operation.
|
1991
|
+
# @return [String]
|
1992
|
+
#
|
1993
|
+
# @!attribute [rw] status
|
1994
|
+
# The status of the operation.
|
1995
|
+
# @return [String]
|
1996
|
+
#
|
1997
|
+
# @!attribute [rw] status_changed_at
|
1998
|
+
# The timestamp when the status was changed (e.g., `1479816991.349`).
|
1999
|
+
# @return [Time]
|
2000
|
+
#
|
2001
|
+
# @!attribute [rw] error_code
|
2002
|
+
# The error code.
|
2003
|
+
# @return [String]
|
2004
|
+
#
|
2005
|
+
# @!attribute [rw] error_details
|
2006
|
+
# The error details.
|
2007
|
+
# @return [String]
|
2008
|
+
class Operation < Struct.new(
|
2009
|
+
:id,
|
2010
|
+
:resource_name,
|
2011
|
+
:resource_type,
|
2012
|
+
:created_at,
|
2013
|
+
:location,
|
2014
|
+
:is_terminal,
|
2015
|
+
:operation_details,
|
2016
|
+
:operation_type,
|
2017
|
+
:status,
|
2018
|
+
:status_changed_at,
|
2019
|
+
:error_code,
|
2020
|
+
:error_details)
|
2021
|
+
include Aws::Structure
|
2022
|
+
end
|
2023
|
+
|
2024
|
+
# @api private
|
2025
|
+
class PeerVpcRequest < Aws::EmptyStructure; end
|
2026
|
+
|
2027
|
+
# @!attribute [rw] operation
|
2028
|
+
# An array of key-value pairs containing information about the request
|
2029
|
+
# operation.
|
2030
|
+
# @return [Types::Operation]
|
2031
|
+
class PeerVpcResult < Struct.new(
|
2032
|
+
:operation)
|
2033
|
+
include Aws::Structure
|
2034
|
+
end
|
2035
|
+
|
2036
|
+
# Describes information about the ports on your virtual private server
|
2037
|
+
# (or *instance*).
|
2038
|
+
# @note When making an API call, pass PortInfo
|
2039
|
+
# data as a hash:
|
2040
|
+
#
|
2041
|
+
# {
|
2042
|
+
# from_port: 1,
|
2043
|
+
# to_port: 1,
|
2044
|
+
# protocol: "tcp", # accepts tcp, all, udp
|
2045
|
+
# }
|
2046
|
+
# @!attribute [rw] from_port
|
2047
|
+
# The first port in the range.
|
2048
|
+
# @return [Integer]
|
2049
|
+
#
|
2050
|
+
# @!attribute [rw] to_port
|
2051
|
+
# The last port in the range.
|
2052
|
+
# @return [Integer]
|
2053
|
+
#
|
2054
|
+
# @!attribute [rw] protocol
|
2055
|
+
# The protocol.
|
2056
|
+
# @return [String]
|
2057
|
+
class PortInfo < Struct.new(
|
2058
|
+
:from_port,
|
2059
|
+
:to_port,
|
2060
|
+
:protocol)
|
2061
|
+
include Aws::Structure
|
2062
|
+
end
|
2063
|
+
|
2064
|
+
# @note When making an API call, pass RebootInstanceRequest
|
2065
|
+
# data as a hash:
|
2066
|
+
#
|
2067
|
+
# {
|
2068
|
+
# instance_name: "ResourceName", # required
|
2069
|
+
# }
|
2070
|
+
# @!attribute [rw] instance_name
|
2071
|
+
# The name of the instance to reboot.
|
2072
|
+
# @return [String]
|
2073
|
+
class RebootInstanceRequest < Struct.new(
|
2074
|
+
:instance_name)
|
2075
|
+
include Aws::Structure
|
2076
|
+
end
|
2077
|
+
|
2078
|
+
# @!attribute [rw] operations
|
2079
|
+
# An array of key-value pairs containing information about the request
|
2080
|
+
# operation.
|
2081
|
+
# @return [Array<Types::Operation>]
|
2082
|
+
class RebootInstanceResult < Struct.new(
|
2083
|
+
:operations)
|
2084
|
+
include Aws::Structure
|
2085
|
+
end
|
2086
|
+
|
2087
|
+
# Describes the AWS Region.
|
2088
|
+
# @!attribute [rw] continent_code
|
2089
|
+
# The continent code (e.g., `NA`, meaning North America).
|
2090
|
+
# @return [String]
|
2091
|
+
#
|
2092
|
+
# @!attribute [rw] description
|
2093
|
+
# The description of the AWS Region (e.g., `This region is recommended
|
2094
|
+
# to serve users in the eastern United States and eastern Canada`).
|
2095
|
+
# @return [String]
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] display_name
|
2098
|
+
# The display name (e.g., `Virginia`).
|
2099
|
+
# @return [String]
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] name
|
2102
|
+
# The region name (e.g., `us-east-1`).
|
2103
|
+
# @return [String]
|
2104
|
+
#
|
2105
|
+
# @!attribute [rw] availability_zones
|
2106
|
+
# The Availability Zones.
|
2107
|
+
# @return [Array<Types::AvailabilityZone>]
|
2108
|
+
class Region < Struct.new(
|
2109
|
+
:continent_code,
|
2110
|
+
:description,
|
2111
|
+
:display_name,
|
2112
|
+
:name,
|
2113
|
+
:availability_zones)
|
2114
|
+
include Aws::Structure
|
2115
|
+
end
|
2116
|
+
|
2117
|
+
# @note When making an API call, pass ReleaseStaticIpRequest
|
2118
|
+
# data as a hash:
|
2119
|
+
#
|
2120
|
+
# {
|
2121
|
+
# static_ip_name: "ResourceName", # required
|
2122
|
+
# }
|
2123
|
+
# @!attribute [rw] static_ip_name
|
2124
|
+
# The name of the static IP to delete.
|
2125
|
+
# @return [String]
|
2126
|
+
class ReleaseStaticIpRequest < Struct.new(
|
2127
|
+
:static_ip_name)
|
2128
|
+
include Aws::Structure
|
2129
|
+
end
|
2130
|
+
|
2131
|
+
# @!attribute [rw] operations
|
2132
|
+
# An array of key-value pairs containing information about the request
|
2133
|
+
# operation.
|
2134
|
+
# @return [Array<Types::Operation>]
|
2135
|
+
class ReleaseStaticIpResult < Struct.new(
|
2136
|
+
:operations)
|
2137
|
+
include Aws::Structure
|
2138
|
+
end
|
2139
|
+
|
2140
|
+
# Describes the resource location.
|
2141
|
+
# @!attribute [rw] availability_zone
|
2142
|
+
# The Availability Zone.
|
2143
|
+
# @return [String]
|
2144
|
+
#
|
2145
|
+
# @!attribute [rw] region_name
|
2146
|
+
# The AWS Region name.
|
2147
|
+
# @return [String]
|
2148
|
+
class ResourceLocation < Struct.new(
|
2149
|
+
:availability_zone,
|
2150
|
+
:region_name)
|
2151
|
+
include Aws::Structure
|
2152
|
+
end
|
2153
|
+
|
2154
|
+
# @note When making an API call, pass StartInstanceRequest
|
2155
|
+
# data as a hash:
|
2156
|
+
#
|
2157
|
+
# {
|
2158
|
+
# instance_name: "ResourceName", # required
|
2159
|
+
# }
|
2160
|
+
# @!attribute [rw] instance_name
|
2161
|
+
# The name of the instance (a virtual private server) to start.
|
2162
|
+
# @return [String]
|
2163
|
+
class StartInstanceRequest < Struct.new(
|
2164
|
+
:instance_name)
|
2165
|
+
include Aws::Structure
|
2166
|
+
end
|
2167
|
+
|
2168
|
+
# @!attribute [rw] operations
|
2169
|
+
# An array of key-value pairs containing information about the request
|
2170
|
+
# operation.
|
2171
|
+
# @return [Array<Types::Operation>]
|
2172
|
+
class StartInstanceResult < Struct.new(
|
2173
|
+
:operations)
|
2174
|
+
include Aws::Structure
|
2175
|
+
end
|
2176
|
+
|
2177
|
+
# Describes the static IP.
|
2178
|
+
# @!attribute [rw] name
|
2179
|
+
# The name of the static IP (e.g., `StaticIP-Virginia-EXAMPLE`).
|
2180
|
+
# @return [String]
|
2181
|
+
#
|
2182
|
+
# @!attribute [rw] arn
|
2183
|
+
# The Amazon Resource Name (ARN) of the static IP (e.g.,
|
2184
|
+
# `arn:aws:lightsail:us-east-1:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE`).
|
2185
|
+
# @return [String]
|
2186
|
+
#
|
2187
|
+
# @!attribute [rw] support_code
|
2188
|
+
# The support code. Include this code in your email to support when
|
2189
|
+
# you have questions about an instance or another resource in
|
2190
|
+
# Lightsail. This code enables our support team to look up your
|
2191
|
+
# Lightsail information more easily.
|
2192
|
+
# @return [String]
|
2193
|
+
#
|
2194
|
+
# @!attribute [rw] created_at
|
2195
|
+
# The timestamp when the static IP was created (e.g.,
|
2196
|
+
# `1479735304.222`).
|
2197
|
+
# @return [Time]
|
2198
|
+
#
|
2199
|
+
# @!attribute [rw] location
|
2200
|
+
# The region and Availability Zone where the static IP was created.
|
2201
|
+
# @return [Types::ResourceLocation]
|
2202
|
+
#
|
2203
|
+
# @!attribute [rw] resource_type
|
2204
|
+
# The resource type (usually `StaticIp`).
|
2205
|
+
# @return [String]
|
2206
|
+
#
|
2207
|
+
# @!attribute [rw] ip_address
|
2208
|
+
# The static IP address.
|
2209
|
+
# @return [String]
|
2210
|
+
#
|
2211
|
+
# @!attribute [rw] attached_to
|
2212
|
+
# The instance where the static IP is attached (e.g.,
|
2213
|
+
# `Amazon_Linux-1GB-Virginia-1`).
|
2214
|
+
# @return [String]
|
2215
|
+
#
|
2216
|
+
# @!attribute [rw] is_attached
|
2217
|
+
# A Boolean value indicating whether the static IP is attached.
|
2218
|
+
# @return [Boolean]
|
2219
|
+
class StaticIp < Struct.new(
|
2220
|
+
:name,
|
2221
|
+
:arn,
|
2222
|
+
:support_code,
|
2223
|
+
:created_at,
|
2224
|
+
:location,
|
2225
|
+
:resource_type,
|
2226
|
+
:ip_address,
|
2227
|
+
:attached_to,
|
2228
|
+
:is_attached)
|
2229
|
+
include Aws::Structure
|
2230
|
+
end
|
2231
|
+
|
2232
|
+
# @note When making an API call, pass StopInstanceRequest
|
2233
|
+
# data as a hash:
|
2234
|
+
#
|
2235
|
+
# {
|
2236
|
+
# instance_name: "ResourceName", # required
|
2237
|
+
# }
|
2238
|
+
# @!attribute [rw] instance_name
|
2239
|
+
# The name of the instance (a virtual private server) to stop.
|
2240
|
+
# @return [String]
|
2241
|
+
class StopInstanceRequest < Struct.new(
|
2242
|
+
:instance_name)
|
2243
|
+
include Aws::Structure
|
2244
|
+
end
|
2245
|
+
|
2246
|
+
# @!attribute [rw] operations
|
2247
|
+
# An array of key-value pairs containing information about the request
|
2248
|
+
# operation.
|
2249
|
+
# @return [Array<Types::Operation>]
|
2250
|
+
class StopInstanceResult < Struct.new(
|
2251
|
+
:operations)
|
2252
|
+
include Aws::Structure
|
2253
|
+
end
|
2254
|
+
|
2255
|
+
# @api private
|
2256
|
+
class UnpeerVpcRequest < Aws::EmptyStructure; end
|
2257
|
+
|
2258
|
+
# @!attribute [rw] operation
|
2259
|
+
# An array of key-value pairs containing information about the request
|
2260
|
+
# operation.
|
2261
|
+
# @return [Types::Operation]
|
2262
|
+
class UnpeerVpcResult < Struct.new(
|
2263
|
+
:operation)
|
2264
|
+
include Aws::Structure
|
2265
|
+
end
|
2266
|
+
|
2267
|
+
# @note When making an API call, pass UpdateDomainEntryRequest
|
2268
|
+
# data as a hash:
|
2269
|
+
#
|
2270
|
+
# {
|
2271
|
+
# domain_name: "DomainName", # required
|
2272
|
+
# domain_entry: { # required
|
2273
|
+
# id: "NonEmptyString",
|
2274
|
+
# name: "DomainName",
|
2275
|
+
# target: "string",
|
2276
|
+
# type: "DomainEntryType",
|
2277
|
+
# options: {
|
2278
|
+
# "DomainEntryOptionsKeys" => "string",
|
2279
|
+
# },
|
2280
|
+
# },
|
2281
|
+
# }
|
2282
|
+
# @!attribute [rw] domain_name
|
2283
|
+
# The name of the domain recordset to update.
|
2284
|
+
# @return [String]
|
2285
|
+
#
|
2286
|
+
# @!attribute [rw] domain_entry
|
2287
|
+
# An array of key-value pairs containing information about the domain
|
2288
|
+
# entry.
|
2289
|
+
# @return [Types::DomainEntry]
|
2290
|
+
class UpdateDomainEntryRequest < Struct.new(
|
2291
|
+
:domain_name,
|
2292
|
+
:domain_entry)
|
2293
|
+
include Aws::Structure
|
2294
|
+
end
|
2295
|
+
|
2296
|
+
# @!attribute [rw] operations
|
2297
|
+
# An array of key-value pairs containing information about the request
|
2298
|
+
# operation.
|
2299
|
+
# @return [Array<Types::Operation>]
|
2300
|
+
class UpdateDomainEntryResult < Struct.new(
|
2301
|
+
:operations)
|
2302
|
+
include Aws::Structure
|
2303
|
+
end
|
2304
|
+
|
2305
|
+
end
|
2306
|
+
end
|
2307
|
+
end
|