aws-sdk-lightsail 1.7.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -242,9 +242,11 @@ module Aws::Lightsail
242
242
  # @return [String]
243
243
  #
244
244
  # @!attribute [rw] is_active
245
- # A Boolean value indicating whether the blueprint is active. When you
246
- # update your blueprints, you will inactivate old blueprints and keep
247
- # the most recent versions active.
245
+ # A Boolean value indicating whether the blueprint is active. Inactive
246
+ # blueprints are listed to support customers with existing instances
247
+ # but are not necessarily available for launch of new instances.
248
+ # Blueprints are marked inactive when they become outdated due to
249
+ # operating system updates or new application releases.
248
250
  # @return [Boolean]
249
251
  #
250
252
  # @!attribute [rw] min_power
@@ -694,8 +696,8 @@ module Aws::Lightsail
694
696
  # @!attribute [rw] availability_zone
695
697
  # The Availability Zone where you want to create your instances. Use
696
698
  # the following formatting: `us-east-2a` (case sensitive). You can get
697
- # a list of availability zones by using the [get regions][1]
698
- # operation. Be sure to add the `include availability zones` parameter
699
+ # a list of Availability Zones by using the [get regions][1]
700
+ # operation. Be sure to add the `include Availability Zones` parameter
699
701
  # to your request.
700
702
  #
701
703
  #
@@ -728,7 +730,7 @@ module Aws::Lightsail
728
730
  #
729
731
  #
730
732
  #
731
- # [1]: http://lightsail.aws.amazon.com/ls/docs/getting-started/articles/pre-installed-apps
733
+ # [1]: https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image
732
734
  # @return [String]
733
735
  #
734
736
  # @!attribute [rw] key_pair_name
@@ -782,8 +784,8 @@ module Aws::Lightsail
782
784
  # @!attribute [rw] availability_zone
783
785
  # The Availability Zone in which to create your instance. Use the
784
786
  # following format: `us-east-2a` (case sensitive). You can get a list
785
- # of availability zones by using the [get regions][1] operation. Be
786
- # sure to add the `include availability zones` parameter to your
787
+ # of Availability Zones by using the [get regions][1] operation. Be
788
+ # sure to add the `include Availability Zones` parameter to your
787
789
  # request.
788
790
  #
789
791
  #
@@ -1040,6 +1042,340 @@ module Aws::Lightsail
1040
1042
  include Aws::Structure
1041
1043
  end
1042
1044
 
1045
+ # @note When making an API call, you may pass CreateRelationalDatabaseFromSnapshotRequest
1046
+ # data as a hash:
1047
+ #
1048
+ # {
1049
+ # relational_database_name: "ResourceName", # required
1050
+ # availability_zone: "string",
1051
+ # publicly_accessible: false,
1052
+ # relational_database_snapshot_name: "ResourceName",
1053
+ # relational_database_bundle_id: "string",
1054
+ # source_relational_database_name: "ResourceName",
1055
+ # restore_time: Time.now,
1056
+ # use_latest_restorable_time: false,
1057
+ # }
1058
+ #
1059
+ # @!attribute [rw] relational_database_name
1060
+ # The name to use for your new database.
1061
+ #
1062
+ # Constraints:
1063
+ #
1064
+ # * Must contain from 2 to 255 alphanumeric characters, or hyphens.
1065
+ #
1066
+ # * The first and last character must be a letter or number.
1067
+ # @return [String]
1068
+ #
1069
+ # @!attribute [rw] availability_zone
1070
+ # The Availability Zone in which to create your new database. Use the
1071
+ # `us-east-2a` case-sensitive format.
1072
+ #
1073
+ # You can get a list of Availability Zones by using the `get regions`
1074
+ # operation. Be sure to add the `include relational database
1075
+ # Availability Zones` parameter to your request.
1076
+ # @return [String]
1077
+ #
1078
+ # @!attribute [rw] publicly_accessible
1079
+ # Specifies the accessibility options for your new database. A value
1080
+ # of `true` specifies a database that is available to resources
1081
+ # outside of your Lightsail account. A value of `false` specifies a
1082
+ # database that is available only to your Lightsail resources in the
1083
+ # same region as your database.
1084
+ # @return [Boolean]
1085
+ #
1086
+ # @!attribute [rw] relational_database_snapshot_name
1087
+ # The name of the database snapshot from which to create your new
1088
+ # database.
1089
+ # @return [String]
1090
+ #
1091
+ # @!attribute [rw] relational_database_bundle_id
1092
+ # The bundle ID for your new database. A bundle describes the
1093
+ # performance specifications for your database.
1094
+ #
1095
+ # You can get a list of database bundle IDs by using the `get
1096
+ # relational database bundles` operation.
1097
+ #
1098
+ # When creating a new database from a snapshot, you cannot choose a
1099
+ # bundle that is smaller than the bundle of the source database.
1100
+ # @return [String]
1101
+ #
1102
+ # @!attribute [rw] source_relational_database_name
1103
+ # The name of the source database.
1104
+ # @return [String]
1105
+ #
1106
+ # @!attribute [rw] restore_time
1107
+ # The date and time to restore your database from.
1108
+ #
1109
+ # Constraints:
1110
+ #
1111
+ # * Must be before the latest restorable time for the database.
1112
+ #
1113
+ # * Cannot be specified if the `use latest restorable time` parameter
1114
+ # is `true`.
1115
+ #
1116
+ # * Specified in Universal Coordinated Time (UTC).
1117
+ #
1118
+ # * Specified in the Unix time format.
1119
+ #
1120
+ # For example, if you wish to use a restore time of October 1, 2018,
1121
+ # at 8 PM UTC, then you input `1538424000` as the restore time.
1122
+ # @return [Time]
1123
+ #
1124
+ # @!attribute [rw] use_latest_restorable_time
1125
+ # Specifies whether your database is restored from the latest backup
1126
+ # time. A value of `true` restores from the latest backup time.
1127
+ #
1128
+ # Default: `false`
1129
+ #
1130
+ # Constraints: Cannot be specified if the `restore time` parameter is
1131
+ # provided.
1132
+ # @return [Boolean]
1133
+ #
1134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshotRequest AWS API Documentation
1135
+ #
1136
+ class CreateRelationalDatabaseFromSnapshotRequest < Struct.new(
1137
+ :relational_database_name,
1138
+ :availability_zone,
1139
+ :publicly_accessible,
1140
+ :relational_database_snapshot_name,
1141
+ :relational_database_bundle_id,
1142
+ :source_relational_database_name,
1143
+ :restore_time,
1144
+ :use_latest_restorable_time)
1145
+ include Aws::Structure
1146
+ end
1147
+
1148
+ # @!attribute [rw] operations
1149
+ # An object describing the result of your create relational database
1150
+ # from snapshot request.
1151
+ # @return [Array<Types::Operation>]
1152
+ #
1153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshotResult AWS API Documentation
1154
+ #
1155
+ class CreateRelationalDatabaseFromSnapshotResult < Struct.new(
1156
+ :operations)
1157
+ include Aws::Structure
1158
+ end
1159
+
1160
+ # @note When making an API call, you may pass CreateRelationalDatabaseRequest
1161
+ # data as a hash:
1162
+ #
1163
+ # {
1164
+ # relational_database_name: "ResourceName", # required
1165
+ # availability_zone: "string",
1166
+ # relational_database_blueprint_id: "string", # required
1167
+ # relational_database_bundle_id: "string", # required
1168
+ # master_database_name: "string", # required
1169
+ # master_username: "string", # required
1170
+ # master_user_password: "SensitiveString",
1171
+ # preferred_backup_window: "string",
1172
+ # preferred_maintenance_window: "string",
1173
+ # publicly_accessible: false,
1174
+ # }
1175
+ #
1176
+ # @!attribute [rw] relational_database_name
1177
+ # The name to use for your new database.
1178
+ #
1179
+ # Constraints:
1180
+ #
1181
+ # * Must contain from 2 to 255 alphanumeric characters, or hyphens.
1182
+ #
1183
+ # * The first and last character must be a letter or number.
1184
+ # @return [String]
1185
+ #
1186
+ # @!attribute [rw] availability_zone
1187
+ # The Availability Zone in which to create your new database. Use the
1188
+ # `us-east-2a` case-sensitive format.
1189
+ #
1190
+ # You can get a list of Availability Zones by using the `get regions`
1191
+ # operation. Be sure to add the `include relational database
1192
+ # Availability Zones` parameter to your request.
1193
+ # @return [String]
1194
+ #
1195
+ # @!attribute [rw] relational_database_blueprint_id
1196
+ # The blueprint ID for your new database. A blueprint describes the
1197
+ # major engine version of a database.
1198
+ #
1199
+ # You can get a list of database blueprints IDs by using the `get
1200
+ # relational database blueprints` operation.
1201
+ # @return [String]
1202
+ #
1203
+ # @!attribute [rw] relational_database_bundle_id
1204
+ # The bundle ID for your new database. A bundle describes the
1205
+ # performance specifications for your database.
1206
+ #
1207
+ # You can get a list of database bundle IDs by using the `get
1208
+ # relational database bundles` operation.
1209
+ # @return [String]
1210
+ #
1211
+ # @!attribute [rw] master_database_name
1212
+ # The name of the master database created when the Lightsail database
1213
+ # resource is created.
1214
+ #
1215
+ # Constraints:
1216
+ #
1217
+ # * Must contain from 1 to 64 alphanumeric characters.
1218
+ #
1219
+ # * Cannot be a word reserved by the specified database engine
1220
+ # @return [String]
1221
+ #
1222
+ # @!attribute [rw] master_username
1223
+ # The master user name for your new database.
1224
+ #
1225
+ # Constraints:
1226
+ #
1227
+ # * Master user name is required.
1228
+ #
1229
+ # * Must contain from 1 to 16 alphanumeric characters.
1230
+ #
1231
+ # * The first character must be a letter.
1232
+ #
1233
+ # * Cannot be a reserved word for the database engine you choose.
1234
+ #
1235
+ # For more information about reserved words in MySQL 5.6 or 5.7, see
1236
+ # the Keywords and Reserved Words articles for [MySQL 5.6][1] or
1237
+ # [MySQL 5.7][2] respectively.
1238
+ #
1239
+ #
1240
+ #
1241
+ # [1]: https://dev.mysql.com/doc/refman/5.6/en/keywords.html
1242
+ # [2]: https://dev.mysql.com/doc/refman/5.7/en/keywords.html
1243
+ # @return [String]
1244
+ #
1245
+ # @!attribute [rw] master_user_password
1246
+ # The password for the master user of your new database. The password
1247
+ # can include any printable ASCII character except "/", """, or
1248
+ # "@".
1249
+ #
1250
+ # Constraints: Must contain 8 to 41 characters.
1251
+ # @return [String]
1252
+ #
1253
+ # @!attribute [rw] preferred_backup_window
1254
+ # The daily time range during which automated backups are created for
1255
+ # your new database if automated backups are enabled.
1256
+ #
1257
+ # The default is a 30-minute window selected at random from an 8-hour
1258
+ # block of time for each AWS Region. For more information about the
1259
+ # preferred backup window time blocks for each region, see the
1260
+ # [Working With Backups][1] guide in the Amazon Relational Database
1261
+ # Service (Amazon RDS) documentation.
1262
+ #
1263
+ # Constraints:
1264
+ #
1265
+ # * Must be in the `hh24:mi-hh24:mi` format.
1266
+ #
1267
+ # Example: `16:00-16:30`
1268
+ #
1269
+ # * Specified in Universal Coordinated Time (UTC).
1270
+ #
1271
+ # * Must not conflict with the preferred maintenance window.
1272
+ #
1273
+ # * Must be at least 30 minutes.
1274
+ #
1275
+ #
1276
+ #
1277
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
1278
+ # @return [String]
1279
+ #
1280
+ # @!attribute [rw] preferred_maintenance_window
1281
+ # The weekly time range during which system maintenance can occur on
1282
+ # your new database.
1283
+ #
1284
+ # The default is a 30-minute window selected at random from an 8-hour
1285
+ # block of time for each AWS Region, occurring on a random day of the
1286
+ # week.
1287
+ #
1288
+ # Constraints:
1289
+ #
1290
+ # * Must be in the `ddd:hh24:mi-ddd:hh24:mi` format.
1291
+ #
1292
+ # * Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
1293
+ #
1294
+ # * Must be at least 30 minutes.
1295
+ #
1296
+ # * Specified in Universal Coordinated Time (UTC).
1297
+ #
1298
+ # * Example: `Tue:17:00-Tue:17:30`
1299
+ # @return [String]
1300
+ #
1301
+ # @!attribute [rw] publicly_accessible
1302
+ # Specifies the accessibility options for your new database. A value
1303
+ # of `true` specifies a database that is available to resources
1304
+ # outside of your Lightsail account. A value of `false` specifies a
1305
+ # database that is available only to your Lightsail resources in the
1306
+ # same region as your database.
1307
+ # @return [Boolean]
1308
+ #
1309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseRequest AWS API Documentation
1310
+ #
1311
+ class CreateRelationalDatabaseRequest < Struct.new(
1312
+ :relational_database_name,
1313
+ :availability_zone,
1314
+ :relational_database_blueprint_id,
1315
+ :relational_database_bundle_id,
1316
+ :master_database_name,
1317
+ :master_username,
1318
+ :master_user_password,
1319
+ :preferred_backup_window,
1320
+ :preferred_maintenance_window,
1321
+ :publicly_accessible)
1322
+ include Aws::Structure
1323
+ end
1324
+
1325
+ # @!attribute [rw] operations
1326
+ # An object describing the result of your create relational database
1327
+ # request.
1328
+ # @return [Array<Types::Operation>]
1329
+ #
1330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseResult AWS API Documentation
1331
+ #
1332
+ class CreateRelationalDatabaseResult < Struct.new(
1333
+ :operations)
1334
+ include Aws::Structure
1335
+ end
1336
+
1337
+ # @note When making an API call, you may pass CreateRelationalDatabaseSnapshotRequest
1338
+ # data as a hash:
1339
+ #
1340
+ # {
1341
+ # relational_database_name: "ResourceName", # required
1342
+ # relational_database_snapshot_name: "ResourceName", # required
1343
+ # }
1344
+ #
1345
+ # @!attribute [rw] relational_database_name
1346
+ # The name of the database on which to base your new snapshot.
1347
+ # @return [String]
1348
+ #
1349
+ # @!attribute [rw] relational_database_snapshot_name
1350
+ # The name for your new database snapshot.
1351
+ #
1352
+ # Constraints:
1353
+ #
1354
+ # * Must contain from 2 to 255 alphanumeric characters, or hyphens.
1355
+ #
1356
+ # * The first and last character must be a letter or number.
1357
+ # @return [String]
1358
+ #
1359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshotRequest AWS API Documentation
1360
+ #
1361
+ class CreateRelationalDatabaseSnapshotRequest < Struct.new(
1362
+ :relational_database_name,
1363
+ :relational_database_snapshot_name)
1364
+ include Aws::Structure
1365
+ end
1366
+
1367
+ # @!attribute [rw] operations
1368
+ # An object describing the result of your create relational database
1369
+ # snapshot request.
1370
+ # @return [Array<Types::Operation>]
1371
+ #
1372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateRelationalDatabaseSnapshotResult AWS API Documentation
1373
+ #
1374
+ class CreateRelationalDatabaseSnapshotResult < Struct.new(
1375
+ :operations)
1376
+ include Aws::Structure
1377
+ end
1378
+
1043
1379
  # @note When making an API call, you may pass DeleteDiskRequest
1044
1380
  # data as a hash:
1045
1381
  #
@@ -1315,7 +1651,7 @@ module Aws::Lightsail
1315
1651
  # When `true`, forces the deletion of an SSL/TLS certificate.
1316
1652
  #
1317
1653
  # There can be two certificates associated with a Lightsail load
1318
- # balancer: the primary and the backup. The force parameter is
1654
+ # balancer: the primary and the backup. The `force` parameter is
1319
1655
  # required when the primary SSL/TLS certificate is in use by an
1320
1656
  # instance attached to the load balancer.
1321
1657
  # @return [Boolean]
@@ -1340,6 +1676,98 @@ module Aws::Lightsail
1340
1676
  include Aws::Structure
1341
1677
  end
1342
1678
 
1679
+ # @note When making an API call, you may pass DeleteRelationalDatabaseRequest
1680
+ # data as a hash:
1681
+ #
1682
+ # {
1683
+ # relational_database_name: "ResourceName", # required
1684
+ # skip_final_snapshot: false,
1685
+ # final_relational_database_snapshot_name: "ResourceName",
1686
+ # }
1687
+ #
1688
+ # @!attribute [rw] relational_database_name
1689
+ # The name of the database that you are deleting.
1690
+ # @return [String]
1691
+ #
1692
+ # @!attribute [rw] skip_final_snapshot
1693
+ # Determines whether a final database snapshot is created before your
1694
+ # database is deleted. If `true` is specified, no database snapshot is
1695
+ # created. If `false` is specified, a database snapshot is created
1696
+ # before your database is deleted.
1697
+ #
1698
+ # You must specify the `final relational database snapshot name`
1699
+ # parameter if the `skip final snapshot` parameter is `false`.
1700
+ #
1701
+ # Default: `false`
1702
+ # @return [Boolean]
1703
+ #
1704
+ # @!attribute [rw] final_relational_database_snapshot_name
1705
+ # The name of the database snapshot created if `skip final snapshot`
1706
+ # is `false`, which is the default value for that parameter.
1707
+ #
1708
+ # <note markdown="1"> Specifying this parameter and also specifying the `skip final
1709
+ # snapshot` parameter to `true` results in an error.
1710
+ #
1711
+ # </note>
1712
+ #
1713
+ # Constraints:
1714
+ #
1715
+ # * Must contain from 2 to 255 alphanumeric characters, or hyphens.
1716
+ #
1717
+ # * The first and last character must be a letter or number.
1718
+ # @return [String]
1719
+ #
1720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseRequest AWS API Documentation
1721
+ #
1722
+ class DeleteRelationalDatabaseRequest < Struct.new(
1723
+ :relational_database_name,
1724
+ :skip_final_snapshot,
1725
+ :final_relational_database_snapshot_name)
1726
+ include Aws::Structure
1727
+ end
1728
+
1729
+ # @!attribute [rw] operations
1730
+ # An object describing the result of your delete relational database
1731
+ # request.
1732
+ # @return [Array<Types::Operation>]
1733
+ #
1734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseResult AWS API Documentation
1735
+ #
1736
+ class DeleteRelationalDatabaseResult < Struct.new(
1737
+ :operations)
1738
+ include Aws::Structure
1739
+ end
1740
+
1741
+ # @note When making an API call, you may pass DeleteRelationalDatabaseSnapshotRequest
1742
+ # data as a hash:
1743
+ #
1744
+ # {
1745
+ # relational_database_snapshot_name: "ResourceName", # required
1746
+ # }
1747
+ #
1748
+ # @!attribute [rw] relational_database_snapshot_name
1749
+ # The name of the database snapshot that you are deleting.
1750
+ # @return [String]
1751
+ #
1752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshotRequest AWS API Documentation
1753
+ #
1754
+ class DeleteRelationalDatabaseSnapshotRequest < Struct.new(
1755
+ :relational_database_snapshot_name)
1756
+ include Aws::Structure
1757
+ end
1758
+
1759
+ # @!attribute [rw] operations
1760
+ # An object describing the result of your delete relational database
1761
+ # snapshot request.
1762
+ # @return [Array<Types::Operation>]
1763
+ #
1764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshotResult AWS API Documentation
1765
+ #
1766
+ class DeleteRelationalDatabaseSnapshotResult < Struct.new(
1767
+ :operations)
1768
+ include Aws::Structure
1769
+ end
1770
+
1343
1771
  # @note When making an API call, you may pass DetachDiskRequest
1344
1772
  # data as a hash:
1345
1773
  #
@@ -2148,7 +2576,7 @@ module Aws::Lightsail
2148
2576
  # @return [String]
2149
2577
  #
2150
2578
  # @!attribute [rw] period
2151
- # The time period for which you are requesting data.
2579
+ # The granularity, in seconds, of the returned data points.
2152
2580
  # @return [Integer]
2153
2581
  #
2154
2582
  # @!attribute [rw] start_time
@@ -2565,7 +2993,7 @@ module Aws::Lightsail
2565
2993
  # @return [String]
2566
2994
  #
2567
2995
  # @!attribute [rw] period
2568
- # The time period duration for your health data request.
2996
+ # The granularity, in seconds, of the returned data points.
2569
2997
  # @return [Integer]
2570
2998
  #
2571
2999
  # @!attribute [rw] start_time
@@ -2883,8 +3311,8 @@ module Aws::Lightsail
2883
3311
  # (Deprecated) Returns the number of pages of results that remain.
2884
3312
  #
2885
3313
  # <note markdown="1"> In releases prior to June 12, 2017, this parameter returned `null`
2886
- # by the API. It is now deprecated, and the API returns the
2887
- # `nextPageToken` parameter instead.
3314
+ # by the API. It is now deprecated, and the API returns the `next page
3315
+ # token` parameter instead.
2888
3316
  #
2889
3317
  # </note>
2890
3318
  # @return [String]
@@ -2946,6 +3374,7 @@ module Aws::Lightsail
2946
3374
  #
2947
3375
  # {
2948
3376
  # include_availability_zones: false,
3377
+ # include_relational_database_availability_zones: false,
2949
3378
  # }
2950
3379
  #
2951
3380
  # @!attribute [rw] include_availability_zones
@@ -2954,10 +3383,17 @@ module Aws::Lightsail
2954
3383
  # with a letter: e.g., `us-east-2a`.
2955
3384
  # @return [Boolean]
2956
3385
  #
3386
+ # @!attribute [rw] include_relational_database_availability_zones
3387
+ # &gt;A Boolean value indicating whether to also include Availability
3388
+ # Zones for databases in your get regions request. Availability Zones
3389
+ # are indicated with a letter (e.g., `us-east-2a`).
3390
+ # @return [Boolean]
3391
+ #
2957
3392
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRegionsRequest AWS API Documentation
2958
3393
  #
2959
3394
  class GetRegionsRequest < Struct.new(
2960
- :include_availability_zones)
3395
+ :include_availability_zones,
3396
+ :include_relational_database_availability_zones)
2961
3397
  include Aws::Structure
2962
3398
  end
2963
3399
 
@@ -2973,37 +3409,44 @@ module Aws::Lightsail
2973
3409
  include Aws::Structure
2974
3410
  end
2975
3411
 
2976
- # @note When making an API call, you may pass GetStaticIpRequest
3412
+ # @note When making an API call, you may pass GetRelationalDatabaseBlueprintsRequest
2977
3413
  # data as a hash:
2978
3414
  #
2979
3415
  # {
2980
- # static_ip_name: "ResourceName", # required
3416
+ # page_token: "string",
2981
3417
  # }
2982
3418
  #
2983
- # @!attribute [rw] static_ip_name
2984
- # The name of the static IP in Lightsail.
3419
+ # @!attribute [rw] page_token
3420
+ # A token used for advancing to a specific page of results for your
3421
+ # get relational database blueprints request.
2985
3422
  # @return [String]
2986
3423
  #
2987
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpRequest AWS API Documentation
3424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprintsRequest AWS API Documentation
2988
3425
  #
2989
- class GetStaticIpRequest < Struct.new(
2990
- :static_ip_name)
3426
+ class GetRelationalDatabaseBlueprintsRequest < Struct.new(
3427
+ :page_token)
2991
3428
  include Aws::Structure
2992
3429
  end
2993
3430
 
2994
- # @!attribute [rw] static_ip
2995
- # An array of key-value pairs containing information about the
2996
- # requested static IP.
2997
- # @return [Types::StaticIp]
3431
+ # @!attribute [rw] blueprints
3432
+ # An object describing the result of your get relational database
3433
+ # blueprints request.
3434
+ # @return [Array<Types::RelationalDatabaseBlueprint>]
2998
3435
  #
2999
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpResult AWS API Documentation
3436
+ # @!attribute [rw] next_page_token
3437
+ # A token used for advancing to the next page of results of your get
3438
+ # relational database blueprints request.
3439
+ # @return [String]
3000
3440
  #
3001
- class GetStaticIpResult < Struct.new(
3002
- :static_ip)
3441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBlueprintsResult AWS API Documentation
3442
+ #
3443
+ class GetRelationalDatabaseBlueprintsResult < Struct.new(
3444
+ :blueprints,
3445
+ :next_page_token)
3003
3446
  include Aws::Structure
3004
3447
  end
3005
3448
 
3006
- # @note When making an API call, you may pass GetStaticIpsRequest
3449
+ # @note When making an API call, you may pass GetRelationalDatabaseBundlesRequest
3007
3450
  # data as a hash:
3008
3451
  #
3009
3452
  # {
@@ -3011,1399 +3454,2530 @@ module Aws::Lightsail
3011
3454
  # }
3012
3455
  #
3013
3456
  # @!attribute [rw] page_token
3014
- # A token used for advancing to the next page of results from your get
3015
- # static IPs request.
3457
+ # A token used for advancing to a specific page of results for your
3458
+ # get relational database bundles request.
3016
3459
  # @return [String]
3017
3460
  #
3018
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpsRequest AWS API Documentation
3461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundlesRequest AWS API Documentation
3019
3462
  #
3020
- class GetStaticIpsRequest < Struct.new(
3463
+ class GetRelationalDatabaseBundlesRequest < Struct.new(
3021
3464
  :page_token)
3022
3465
  include Aws::Structure
3023
3466
  end
3024
3467
 
3025
- # @!attribute [rw] static_ips
3026
- # An array of key-value pairs containing information about your get
3027
- # static IPs request.
3028
- # @return [Array<Types::StaticIp>]
3468
+ # @!attribute [rw] bundles
3469
+ # An object describing the result of your get relational database
3470
+ # bundles request.
3471
+ # @return [Array<Types::RelationalDatabaseBundle>]
3029
3472
  #
3030
3473
  # @!attribute [rw] next_page_token
3031
- # A token used for advancing to the next page of results from your get
3032
- # static IPs request.
3474
+ # A token used for advancing to the next page of results of your get
3475
+ # relational database bundles request.
3033
3476
  # @return [String]
3034
3477
  #
3035
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpsResult AWS API Documentation
3478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundlesResult AWS API Documentation
3036
3479
  #
3037
- class GetStaticIpsResult < Struct.new(
3038
- :static_ips,
3480
+ class GetRelationalDatabaseBundlesResult < Struct.new(
3481
+ :bundles,
3039
3482
  :next_page_token)
3040
3483
  include Aws::Structure
3041
3484
  end
3042
3485
 
3043
- # @note When making an API call, you may pass ImportKeyPairRequest
3486
+ # @note When making an API call, you may pass GetRelationalDatabaseEventsRequest
3044
3487
  # data as a hash:
3045
3488
  #
3046
3489
  # {
3047
- # key_pair_name: "ResourceName", # required
3048
- # public_key_base_64: "Base64", # required
3490
+ # relational_database_name: "ResourceName", # required
3491
+ # duration_in_minutes: 1,
3492
+ # page_token: "string",
3049
3493
  # }
3050
3494
  #
3051
- # @!attribute [rw] key_pair_name
3052
- # The name of the key pair for which you want to import the public
3053
- # key.
3495
+ # @!attribute [rw] relational_database_name
3496
+ # The name of the database from which to get events.
3054
3497
  # @return [String]
3055
3498
  #
3056
- # @!attribute [rw] public_key_base_64
3057
- # A base64-encoded public key of the `ssh-rsa` type.
3058
- # @return [String]
3499
+ # @!attribute [rw] duration_in_minutes
3500
+ # The number of minutes in the past from which to retrieve events. For
3501
+ # example, to get all events from the past 2 hours, enter 120.
3059
3502
  #
3060
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPairRequest AWS API Documentation
3503
+ # Default: `60`
3061
3504
  #
3062
- class ImportKeyPairRequest < Struct.new(
3063
- :key_pair_name,
3064
- :public_key_base_64)
3505
+ # The minimum is 1 and the maximum is 14 days (20160 minutes).
3506
+ # @return [Integer]
3507
+ #
3508
+ # @!attribute [rw] page_token
3509
+ # A token used for advancing to a specific page of results from for
3510
+ # get relational database events request.
3511
+ # @return [String]
3512
+ #
3513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEventsRequest AWS API Documentation
3514
+ #
3515
+ class GetRelationalDatabaseEventsRequest < Struct.new(
3516
+ :relational_database_name,
3517
+ :duration_in_minutes,
3518
+ :page_token)
3065
3519
  include Aws::Structure
3066
3520
  end
3067
3521
 
3068
- # @!attribute [rw] operation
3069
- # An array of key-value pairs containing information about the request
3070
- # operation.
3071
- # @return [Types::Operation]
3522
+ # @!attribute [rw] relational_database_events
3523
+ # An object describing the result of your get relational database
3524
+ # events request.
3525
+ # @return [Array<Types::RelationalDatabaseEvent>]
3072
3526
  #
3073
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPairResult AWS API Documentation
3527
+ # @!attribute [rw] next_page_token
3528
+ # A token used for advancing to the next page of results from your get
3529
+ # relational database events request.
3530
+ # @return [String]
3074
3531
  #
3075
- class ImportKeyPairResult < Struct.new(
3076
- :operation)
3532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseEventsResult AWS API Documentation
3533
+ #
3534
+ class GetRelationalDatabaseEventsResult < Struct.new(
3535
+ :relational_database_events,
3536
+ :next_page_token)
3077
3537
  include Aws::Structure
3078
3538
  end
3079
3539
 
3080
- # Describes an instance (a virtual private server).
3540
+ # @note When making an API call, you may pass GetRelationalDatabaseLogEventsRequest
3541
+ # data as a hash:
3081
3542
  #
3082
- # @!attribute [rw] name
3083
- # The name the user gave the instance (e.g.,
3084
- # `Amazon_Linux-1GB-Ohio-1`).
3085
- # @return [String]
3543
+ # {
3544
+ # relational_database_name: "ResourceName", # required
3545
+ # log_stream_name: "string", # required
3546
+ # start_time: Time.now,
3547
+ # end_time: Time.now,
3548
+ # start_from_head: false,
3549
+ # page_token: "string",
3550
+ # }
3086
3551
  #
3087
- # @!attribute [rw] arn
3088
- # The Amazon Resource Name (ARN) of the instance (e.g.,
3089
- # `arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE`).
3552
+ # @!attribute [rw] relational_database_name
3553
+ # The name of your database for which to get log events.
3090
3554
  # @return [String]
3091
3555
  #
3092
- # @!attribute [rw] support_code
3093
- # The support code. Include this code in your email to support when
3094
- # you have questions about an instance or another resource in
3095
- # Lightsail. This code enables our support team to look up your
3096
- # Lightsail information more easily.
3556
+ # @!attribute [rw] log_stream_name
3557
+ # The name of the log stream.
3558
+ #
3559
+ # Use the `get relational database log streams` operation to get a
3560
+ # list of available log streams.
3097
3561
  # @return [String]
3098
3562
  #
3099
- # @!attribute [rw] created_at
3100
- # The timestamp when the instance was created (e.g., `1479734909.17`).
3101
- # @return [Time]
3563
+ # @!attribute [rw] start_time
3564
+ # The start of the time interval from which to get log events.
3102
3565
  #
3103
- # @!attribute [rw] location
3104
- # The region name and availability zone where the instance is located.
3105
- # @return [Types::ResourceLocation]
3566
+ # Constraints:
3106
3567
  #
3107
- # @!attribute [rw] resource_type
3108
- # The type of resource (usually `Instance`).
3109
- # @return [String]
3568
+ # * Specified in Universal Coordinated Time (UTC).
3110
3569
  #
3111
- # @!attribute [rw] blueprint_id
3112
- # The blueprint ID (e.g., `os_amlinux_2016_03`).
3113
- # @return [String]
3570
+ # * Specified in the Unix time format.
3114
3571
  #
3115
- # @!attribute [rw] blueprint_name
3116
- # The friendly name of the blueprint (e.g., `Amazon Linux`).
3117
- # @return [String]
3572
+ # For example, if you wish to use a start time of October 1, 2018,
3573
+ # at 8 PM UTC, then you input `1538424000` as the start time.
3574
+ # @return [Time]
3118
3575
  #
3119
- # @!attribute [rw] bundle_id
3120
- # The bundle for the instance (e.g., `micro_1_0`).
3121
- # @return [String]
3576
+ # @!attribute [rw] end_time
3577
+ # The end of the time interval from which to get log events.
3122
3578
  #
3123
- # @!attribute [rw] is_static_ip
3124
- # A Boolean value indicating whether this instance has a static IP
3125
- # assigned to it.
3126
- # @return [Boolean]
3579
+ # Constraints:
3127
3580
  #
3128
- # @!attribute [rw] private_ip_address
3129
- # The private IP address of the instance.
3130
- # @return [String]
3581
+ # * Specified in Universal Coordinated Time (UTC).
3131
3582
  #
3132
- # @!attribute [rw] public_ip_address
3133
- # The public IP address of the instance.
3134
- # @return [String]
3583
+ # * Specified in the Unix time format.
3135
3584
  #
3136
- # @!attribute [rw] ipv6_address
3137
- # The IPv6 address of the instance.
3138
- # @return [String]
3585
+ # For example, if you wish to use an end time of October 1, 2018, at
3586
+ # 8 PM UTC, then you input `1538424000` as the end time.
3587
+ # @return [Time]
3139
3588
  #
3140
- # @!attribute [rw] hardware
3141
- # The size of the vCPU and the amount of RAM for the instance.
3142
- # @return [Types::InstanceHardware]
3589
+ # @!attribute [rw] start_from_head
3590
+ # Parameter to specify if the log should start from head or tail. If
3591
+ # `true` is specified, the log event starts from the head of the log.
3592
+ # If `false` is specified, the log event starts from the tail of the
3593
+ # log.
3143
3594
  #
3144
- # @!attribute [rw] networking
3145
- # Information about the public ports and monthly data transfer rates
3146
- # for the instance.
3147
- # @return [Types::InstanceNetworking]
3595
+ # Default: `false`
3596
+ # @return [Boolean]
3148
3597
  #
3149
- # @!attribute [rw] state
3150
- # The status code and the state (e.g., `running`) for the instance.
3151
- # @return [Types::InstanceState]
3598
+ # @!attribute [rw] page_token
3599
+ # A token used for advancing to a specific page of results for your
3600
+ # get relational database log events request.
3601
+ # @return [String]
3152
3602
  #
3153
- # @!attribute [rw] username
3154
- # The user name for connecting to the instance (e.g., `ec2-user`).
3603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEventsRequest AWS API Documentation
3604
+ #
3605
+ class GetRelationalDatabaseLogEventsRequest < Struct.new(
3606
+ :relational_database_name,
3607
+ :log_stream_name,
3608
+ :start_time,
3609
+ :end_time,
3610
+ :start_from_head,
3611
+ :page_token)
3612
+ include Aws::Structure
3613
+ end
3614
+
3615
+ # @!attribute [rw] resource_log_events
3616
+ # An object describing the result of your get relational database log
3617
+ # events request.
3618
+ # @return [Array<Types::LogEvent>]
3619
+ #
3620
+ # @!attribute [rw] next_backward_token
3621
+ # A token used for advancing to the previous page of results from your
3622
+ # get relational database log events request.
3155
3623
  # @return [String]
3156
3624
  #
3157
- # @!attribute [rw] ssh_key_name
3158
- # The name of the SSH key being used to connect to the instance (e.g.,
3159
- # `LightsailDefaultKeyPair`).
3625
+ # @!attribute [rw] next_forward_token
3626
+ # A token used for advancing to the next page of results from your get
3627
+ # relational database log events request.
3160
3628
  # @return [String]
3161
3629
  #
3162
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Instance AWS API Documentation
3630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogEventsResult AWS API Documentation
3163
3631
  #
3164
- class Instance < Struct.new(
3165
- :name,
3166
- :arn,
3167
- :support_code,
3168
- :created_at,
3169
- :location,
3170
- :resource_type,
3171
- :blueprint_id,
3172
- :blueprint_name,
3173
- :bundle_id,
3174
- :is_static_ip,
3175
- :private_ip_address,
3176
- :public_ip_address,
3177
- :ipv6_address,
3178
- :hardware,
3179
- :networking,
3180
- :state,
3181
- :username,
3182
- :ssh_key_name)
3632
+ class GetRelationalDatabaseLogEventsResult < Struct.new(
3633
+ :resource_log_events,
3634
+ :next_backward_token,
3635
+ :next_forward_token)
3183
3636
  include Aws::Structure
3184
3637
  end
3185
3638
 
3186
- # The parameters for gaining temporary access to one of your Amazon
3187
- # Lightsail instances.
3188
- #
3189
- # @!attribute [rw] cert_key
3190
- # For SSH access, the public key to use when accessing your instance
3191
- # For OpenSSH clients (e.g., command line SSH), you should save this
3192
- # value to `tempkey-cert.pub`.
3193
- # @return [String]
3639
+ # @note When making an API call, you may pass GetRelationalDatabaseLogStreamsRequest
3640
+ # data as a hash:
3194
3641
  #
3195
- # @!attribute [rw] expires_at
3196
- # For SSH access, the date on which the temporary keys expire.
3197
- # @return [Time]
3642
+ # {
3643
+ # relational_database_name: "ResourceName", # required
3644
+ # }
3198
3645
  #
3199
- # @!attribute [rw] ip_address
3200
- # The public IP address of the Amazon Lightsail instance.
3646
+ # @!attribute [rw] relational_database_name
3647
+ # The name of your database for which to get log streams.
3201
3648
  # @return [String]
3202
3649
  #
3203
- # @!attribute [rw] password
3204
- # For RDP access, the password for your Amazon Lightsail instance.
3205
- # Password will be an empty string if the password for your new
3206
- # instance is not ready yet. When you create an instance, it can take
3207
- # up to 15 minutes for the instance to be ready.
3650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogStreamsRequest AWS API Documentation
3208
3651
  #
3209
- # <note markdown="1"> If you create an instance using any key pair other than the default
3210
- # (`LightsailDefaultKeyPair`), `password` will always be an empty
3211
- # string.
3652
+ class GetRelationalDatabaseLogStreamsRequest < Struct.new(
3653
+ :relational_database_name)
3654
+ include Aws::Structure
3655
+ end
3656
+
3657
+ # @!attribute [rw] log_streams
3658
+ # An object describing the result of your get relational database log
3659
+ # streams request.
3660
+ # @return [Array<String>]
3212
3661
  #
3213
- # If you change the Administrator password on the instance, Lightsail
3214
- # will continue to return the original password value. When accessing
3215
- # the instance using RDP, you need to manually enter the Administrator
3216
- # password after changing it from the default.
3662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseLogStreamsResult AWS API Documentation
3217
3663
  #
3218
- # </note>
3219
- # @return [String]
3664
+ class GetRelationalDatabaseLogStreamsResult < Struct.new(
3665
+ :log_streams)
3666
+ include Aws::Structure
3667
+ end
3668
+
3669
+ # @note When making an API call, you may pass GetRelationalDatabaseMasterUserPasswordRequest
3670
+ # data as a hash:
3220
3671
  #
3221
- # @!attribute [rw] password_data
3222
- # For a Windows Server-based instance, an object with the data you can
3223
- # use to retrieve your password. This is only needed if `password` is
3224
- # empty and the instance is not new (and therefore the password is not
3225
- # ready yet). When you create an instance, it can take up to 15
3226
- # minutes for the instance to be ready.
3227
- # @return [Types::PasswordData]
3672
+ # {
3673
+ # relational_database_name: "ResourceName", # required
3674
+ # password_version: "CURRENT", # accepts CURRENT, PREVIOUS, PENDING
3675
+ # }
3228
3676
  #
3229
- # @!attribute [rw] private_key
3230
- # For SSH access, the temporary private key. For OpenSSH clients
3231
- # (e.g., command line SSH), you should save this value to `tempkey`).
3677
+ # @!attribute [rw] relational_database_name
3678
+ # The name of your database for which to get the master user password.
3232
3679
  # @return [String]
3233
3680
  #
3234
- # @!attribute [rw] protocol
3235
- # The protocol for these Amazon Lightsail instance access details.
3236
- # @return [String]
3681
+ # @!attribute [rw] password_version
3682
+ # The password version to return.
3237
3683
  #
3238
- # @!attribute [rw] instance_name
3239
- # The name of this Amazon Lightsail instance.
3240
- # @return [String]
3684
+ # Specifying `CURRENT` or `PREVIOUS` returns the current or previous
3685
+ # passwords respectively. Specifying `PENDING` returns the newest
3686
+ # version of the password that will rotate to `CURRENT`. After the
3687
+ # `PENDING` password rotates to `CURRENT`, the `PENDING` password is
3688
+ # no longer available.
3241
3689
  #
3242
- # @!attribute [rw] username
3243
- # The user name to use when logging in to the Amazon Lightsail
3244
- # instance.
3690
+ # Default: `CURRENT`
3245
3691
  # @return [String]
3246
3692
  #
3247
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceAccessDetails AWS API Documentation
3693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPasswordRequest AWS API Documentation
3248
3694
  #
3249
- class InstanceAccessDetails < Struct.new(
3250
- :cert_key,
3251
- :expires_at,
3252
- :ip_address,
3253
- :password,
3254
- :password_data,
3255
- :private_key,
3256
- :protocol,
3257
- :instance_name,
3258
- :username)
3695
+ class GetRelationalDatabaseMasterUserPasswordRequest < Struct.new(
3696
+ :relational_database_name,
3697
+ :password_version)
3259
3698
  include Aws::Structure
3260
3699
  end
3261
3700
 
3262
- # Describes the hardware for the instance.
3263
- #
3264
- # @!attribute [rw] cpu_count
3265
- # The number of vCPUs the instance has.
3266
- # @return [Integer]
3267
- #
3268
- # @!attribute [rw] disks
3269
- # The disks attached to the instance.
3270
- # @return [Array<Types::Disk>]
3701
+ # @!attribute [rw] master_user_password
3702
+ # The master user password for the `password version` specified.
3703
+ # @return [String]
3271
3704
  #
3272
- # @!attribute [rw] ram_size_in_gb
3273
- # The amount of RAM in GB on the instance (e.g., `1.0`).
3274
- # @return [Float]
3705
+ # @!attribute [rw] created_at
3706
+ # The timestamp when the specified version of the master user password
3707
+ # was created.
3708
+ # @return [Time]
3275
3709
  #
3276
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceHardware AWS API Documentation
3710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPasswordResult AWS API Documentation
3277
3711
  #
3278
- class InstanceHardware < Struct.new(
3279
- :cpu_count,
3280
- :disks,
3281
- :ram_size_in_gb)
3712
+ class GetRelationalDatabaseMasterUserPasswordResult < Struct.new(
3713
+ :master_user_password,
3714
+ :created_at)
3282
3715
  include Aws::Structure
3283
3716
  end
3284
3717
 
3285
- # Describes information about the health of the instance.
3718
+ # @note When making an API call, you may pass GetRelationalDatabaseMetricDataRequest
3719
+ # data as a hash:
3286
3720
  #
3287
- # @!attribute [rw] instance_name
3288
- # The name of the Lightsail instance for which you are requesting
3289
- # health check data.
3721
+ # {
3722
+ # relational_database_name: "ResourceName", # required
3723
+ # metric_name: "CPUUtilization", # required, accepts CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, NetworkTransmitThroughput
3724
+ # period: 1, # required
3725
+ # start_time: Time.now, # required
3726
+ # end_time: Time.now, # required
3727
+ # 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
3728
+ # statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
3729
+ # }
3730
+ #
3731
+ # @!attribute [rw] relational_database_name
3732
+ # The name of your database from which to get metric data.
3290
3733
  # @return [String]
3291
3734
  #
3292
- # @!attribute [rw] instance_health
3293
- # Describes the overall instance health. Valid values are below.
3735
+ # @!attribute [rw] metric_name
3736
+ # The name of the metric data to return.
3294
3737
  # @return [String]
3295
3738
  #
3296
- # @!attribute [rw] instance_health_reason
3297
- # More information about the instance health. If the `instanceHealth`
3298
- # is `healthy`, then an `instanceHealthReason` value is not provided.
3739
+ # @!attribute [rw] period
3740
+ # The granularity, in seconds, of the returned data points.
3741
+ # @return [Integer]
3299
3742
  #
3300
- # If <b> <code>instanceHealth</code> </b> is `initial`, the <b>
3301
- # <code>instanceHealthReason</code> </b> value can be one of the
3302
- # following:
3743
+ # @!attribute [rw] start_time
3744
+ # The start of the time interval from which to get metric data.
3303
3745
  #
3304
- # * <b> <code>Lb.RegistrationInProgress</code> </b> - The target
3305
- # instance is in the process of being registered with the load
3306
- # balancer.
3746
+ # Constraints:
3307
3747
  #
3308
- # * <b> <code>Lb.InitialHealthChecking</code> </b> - The Lightsail
3309
- # load balancer is still sending the target instance the minimum
3310
- # number of health checks required to determine its health status.
3748
+ # * Specified in Universal Coordinated Time (UTC).
3311
3749
  #
3312
- # If <b> <code>instanceHealth</code> </b> is `unhealthy`, the <b>
3313
- # <code>instanceHealthReason</code> </b> value can be one of the
3314
- # following:
3750
+ # * Specified in the Unix time format.
3315
3751
  #
3316
- # * <b> <code>Instance.ResponseCodeMismatch</code> </b> - The health
3317
- # checks did not return an expected HTTP code.
3752
+ # For example, if you wish to use a start time of October 1, 2018,
3753
+ # at 8 PM UTC, then you input `1538424000` as the start time.
3754
+ # @return [Time]
3318
3755
  #
3319
- # * <b> <code>Instance.Timeout</code> </b> - The health check requests
3320
- # timed out.
3756
+ # @!attribute [rw] end_time
3757
+ # The end of the time interval from which to get metric data.
3321
3758
  #
3322
- # * <b> <code>Instance.FailedHealthChecks</code> </b> - The health
3323
- # checks failed because the connection to the target instance timed
3324
- # out, the target instance response was malformed, or the target
3325
- # instance failed the health check for an unknown reason.
3759
+ # Constraints:
3326
3760
  #
3327
- # * <b> <code>Lb.InternalError</code> </b> - The health checks failed
3328
- # due to an internal error.
3761
+ # * Specified in Universal Coordinated Time (UTC).
3329
3762
  #
3330
- # If <b> <code>instanceHealth</code> </b> is `unused`, the <b>
3331
- # <code>instanceHealthReason</code> </b> value can be one of the
3332
- # following:
3333
- #
3334
- # * <b> <code>Instance.NotRegistered</code> </b> - The target instance
3335
- # is not registered with the target group.
3336
- #
3337
- # * <b> <code>Instance.NotInUse</code> </b> - The target group is not
3338
- # used by any load balancer, or the target instance is in an
3339
- # Availability Zone that is not enabled for its load balancer.
3340
- #
3341
- # * <b> <code>Instance.IpUnusable</code> </b> - The target IP address
3342
- # is reserved for use by a Lightsail load balancer.
3343
- #
3344
- # * <b> <code>Instance.InvalidState</code> </b> - The target is in the
3345
- # stopped or terminated state.
3763
+ # * Specified in the Unix time format.
3346
3764
  #
3347
- # If <b> <code>instanceHealth</code> </b> is `draining`, the <b>
3348
- # <code>instanceHealthReason</code> </b> value can be one of the
3349
- # following:
3350
- #
3351
- # * <b> <code>Instance.DeregistrationInProgress</code> </b> - The
3352
- # target instance is in the process of being deregistered and the
3353
- # deregistration delay period has not expired.
3765
+ # For example, if you wish to use an end time of October 1, 2018, at
3766
+ # 8 PM UTC, then you input `1538424000` as the end time.
3767
+ # @return [Time]
3354
3768
  #
3355
- # ^
3769
+ # @!attribute [rw] unit
3770
+ # The unit for the metric data request.
3356
3771
  # @return [String]
3357
3772
  #
3358
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceHealthSummary AWS API Documentation
3773
+ # @!attribute [rw] statistics
3774
+ # The array of statistics for your metric data request.
3775
+ # @return [Array<String>]
3359
3776
  #
3360
- class InstanceHealthSummary < Struct.new(
3361
- :instance_name,
3362
- :instance_health,
3363
- :instance_health_reason)
3777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricDataRequest AWS API Documentation
3778
+ #
3779
+ class GetRelationalDatabaseMetricDataRequest < Struct.new(
3780
+ :relational_database_name,
3781
+ :metric_name,
3782
+ :period,
3783
+ :start_time,
3784
+ :end_time,
3785
+ :unit,
3786
+ :statistics)
3364
3787
  include Aws::Structure
3365
3788
  end
3366
3789
 
3367
- # Describes monthly data transfer rates and port information for an
3368
- # instance.
3369
- #
3370
- # @!attribute [rw] monthly_transfer
3371
- # The amount of data in GB allocated for monthly data transfers.
3372
- # @return [Types::MonthlyTransfer]
3790
+ # @!attribute [rw] metric_name
3791
+ # The name of the metric.
3792
+ # @return [String]
3373
3793
  #
3374
- # @!attribute [rw] ports
3375
- # An array of key-value pairs containing information about the ports
3376
- # on the instance.
3377
- # @return [Array<Types::InstancePortInfo>]
3794
+ # @!attribute [rw] metric_data
3795
+ # An object describing the result of your get relational database
3796
+ # metric data request.
3797
+ # @return [Array<Types::MetricDatapoint>]
3378
3798
  #
3379
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceNetworking AWS API Documentation
3799
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseMetricDataResult AWS API Documentation
3380
3800
  #
3381
- class InstanceNetworking < Struct.new(
3382
- :monthly_transfer,
3383
- :ports)
3801
+ class GetRelationalDatabaseMetricDataResult < Struct.new(
3802
+ :metric_name,
3803
+ :metric_data)
3384
3804
  include Aws::Structure
3385
3805
  end
3386
3806
 
3387
- # Describes information about the instance ports.
3388
- #
3389
- # @!attribute [rw] from_port
3390
- # The first port in the range.
3391
- # @return [Integer]
3392
- #
3393
- # @!attribute [rw] to_port
3394
- # The last port in the range.
3395
- # @return [Integer]
3396
- #
3397
- # @!attribute [rw] protocol
3398
- # The protocol being used. Can be one of the following.
3807
+ # @note When making an API call, you may pass GetRelationalDatabaseParametersRequest
3808
+ # data as a hash:
3399
3809
  #
3400
- # * `tcp` - Transmission Control Protocol (TCP) provides reliable,
3401
- # ordered, and error-checked delivery of streamed data between
3402
- # applications running on hosts communicating by an IP network. If
3403
- # you have an application that doesn't require reliable data stream
3404
- # service, use UDP instead.
3810
+ # {
3811
+ # relational_database_name: "ResourceName", # required
3812
+ # page_token: "string",
3813
+ # }
3405
3814
  #
3406
- # * `all` - All transport layer protocol types. For more general
3407
- # information, see [Transport layer][1] on Wikipedia.
3815
+ # @!attribute [rw] relational_database_name
3816
+ # The name of your database for which to get parameters.
3817
+ # @return [String]
3408
3818
  #
3409
- # * `udp` - With User Datagram Protocol (UDP), computer applications
3410
- # can send messages (or datagrams) to other hosts on an Internet
3411
- # Protocol (IP) network. Prior communications are not required to
3412
- # set up transmission channels or data paths. Applications that
3413
- # don't require reliable data stream service can use UDP, which
3414
- # provides a connectionless datagram service that emphasizes reduced
3415
- # latency over reliability. If you do require reliable data stream
3416
- # service, use TCP instead.
3819
+ # @!attribute [rw] page_token
3820
+ # A token used for advancing to a specific page of results for your
3821
+ # get relational database parameters request.
3822
+ # @return [String]
3417
3823
  #
3824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParametersRequest AWS API Documentation
3418
3825
  #
3826
+ class GetRelationalDatabaseParametersRequest < Struct.new(
3827
+ :relational_database_name,
3828
+ :page_token)
3829
+ include Aws::Structure
3830
+ end
3831
+
3832
+ # @!attribute [rw] parameters
3833
+ # An object describing the result of your get relational database
3834
+ # parameters request.
3835
+ # @return [Array<Types::RelationalDatabaseParameter>]
3419
3836
  #
3420
- # [1]: https://en.wikipedia.org/wiki/Transport_layer
3837
+ # @!attribute [rw] next_page_token
3838
+ # A token used for advancing to the next page of results from your get
3839
+ # static IPs request.
3421
3840
  # @return [String]
3422
3841
  #
3423
- # @!attribute [rw] access_from
3424
- # The location from which access is allowed (e.g., `Anywhere
3425
- # (0.0.0.0/0)`).
3426
- # @return [String]
3842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseParametersResult AWS API Documentation
3427
3843
  #
3428
- # @!attribute [rw] access_type
3429
- # The type of access (`Public` or `Private`).
3430
- # @return [String]
3844
+ class GetRelationalDatabaseParametersResult < Struct.new(
3845
+ :parameters,
3846
+ :next_page_token)
3847
+ include Aws::Structure
3848
+ end
3849
+
3850
+ # @note When making an API call, you may pass GetRelationalDatabaseRequest
3851
+ # data as a hash:
3431
3852
  #
3432
- # @!attribute [rw] common_name
3433
- # The common name.
3434
- # @return [String]
3853
+ # {
3854
+ # relational_database_name: "ResourceName", # required
3855
+ # }
3435
3856
  #
3436
- # @!attribute [rw] access_direction
3437
- # The access direction (`inbound` or `outbound`).
3857
+ # @!attribute [rw] relational_database_name
3858
+ # The name of the database that you are looking up.
3438
3859
  # @return [String]
3439
3860
  #
3440
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstancePortInfo AWS API Documentation
3861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseRequest AWS API Documentation
3441
3862
  #
3442
- class InstancePortInfo < Struct.new(
3443
- :from_port,
3444
- :to_port,
3445
- :protocol,
3446
- :access_from,
3447
- :access_type,
3448
- :common_name,
3449
- :access_direction)
3863
+ class GetRelationalDatabaseRequest < Struct.new(
3864
+ :relational_database_name)
3450
3865
  include Aws::Structure
3451
3866
  end
3452
3867
 
3453
- # Describes the port state.
3868
+ # @!attribute [rw] relational_database
3869
+ # An object describing the specified database.
3870
+ # @return [Types::RelationalDatabase]
3454
3871
  #
3455
- # @!attribute [rw] from_port
3456
- # The first port in the range.
3457
- # @return [Integer]
3872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseResult AWS API Documentation
3458
3873
  #
3459
- # @!attribute [rw] to_port
3460
- # The last port in the range.
3461
- # @return [Integer]
3874
+ class GetRelationalDatabaseResult < Struct.new(
3875
+ :relational_database)
3876
+ include Aws::Structure
3877
+ end
3878
+
3879
+ # @note When making an API call, you may pass GetRelationalDatabaseSnapshotRequest
3880
+ # data as a hash:
3462
3881
  #
3463
- # @!attribute [rw] protocol
3464
- # The protocol being used. Can be one of the following.
3882
+ # {
3883
+ # relational_database_snapshot_name: "ResourceName", # required
3884
+ # }
3465
3885
  #
3466
- # * `tcp` - Transmission Control Protocol (TCP) provides reliable,
3467
- # ordered, and error-checked delivery of streamed data between
3468
- # applications running on hosts communicating by an IP network. If
3469
- # you have an application that doesn't require reliable data stream
3470
- # service, use UDP instead.
3886
+ # @!attribute [rw] relational_database_snapshot_name
3887
+ # The name of the database snapshot for which to get information.
3888
+ # @return [String]
3471
3889
  #
3472
- # * `all` - All transport layer protocol types. For more general
3473
- # information, see [Transport layer][1] on Wikipedia.
3890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotRequest AWS API Documentation
3474
3891
  #
3475
- # * `udp` - With User Datagram Protocol (UDP), computer applications
3476
- # can send messages (or datagrams) to other hosts on an Internet
3477
- # Protocol (IP) network. Prior communications are not required to
3478
- # set up transmission channels or data paths. Applications that
3479
- # don't require reliable data stream service can use UDP, which
3480
- # provides a connectionless datagram service that emphasizes reduced
3481
- # latency over reliability. If you do require reliable data stream
3482
- # service, use TCP instead.
3892
+ class GetRelationalDatabaseSnapshotRequest < Struct.new(
3893
+ :relational_database_snapshot_name)
3894
+ include Aws::Structure
3895
+ end
3896
+
3897
+ # @!attribute [rw] relational_database_snapshot
3898
+ # An object describing the specified database snapshot.
3899
+ # @return [Types::RelationalDatabaseSnapshot]
3483
3900
  #
3901
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotResult AWS API Documentation
3484
3902
  #
3903
+ class GetRelationalDatabaseSnapshotResult < Struct.new(
3904
+ :relational_database_snapshot)
3905
+ include Aws::Structure
3906
+ end
3907
+
3908
+ # @note When making an API call, you may pass GetRelationalDatabaseSnapshotsRequest
3909
+ # data as a hash:
3485
3910
  #
3486
- # [1]: https://en.wikipedia.org/wiki/Transport_layer
3487
- # @return [String]
3911
+ # {
3912
+ # page_token: "string",
3913
+ # }
3488
3914
  #
3489
- # @!attribute [rw] state
3490
- # Specifies whether the instance port is `open` or `closed`.
3915
+ # @!attribute [rw] page_token
3916
+ # A token used for advancing to a specific page of results for your
3917
+ # get relational database snapshots request.
3491
3918
  # @return [String]
3492
3919
  #
3493
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstancePortState AWS API Documentation
3920
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotsRequest AWS API Documentation
3494
3921
  #
3495
- class InstancePortState < Struct.new(
3496
- :from_port,
3497
- :to_port,
3498
- :protocol,
3499
- :state)
3922
+ class GetRelationalDatabaseSnapshotsRequest < Struct.new(
3923
+ :page_token)
3500
3924
  include Aws::Structure
3501
3925
  end
3502
3926
 
3503
- # Describes the snapshot of the virtual private server, or *instance*.
3927
+ # @!attribute [rw] relational_database_snapshots
3928
+ # An object describing the result of your get relational database
3929
+ # snapshots request.
3930
+ # @return [Array<Types::RelationalDatabaseSnapshot>]
3504
3931
  #
3505
- # @!attribute [rw] name
3506
- # The name of the snapshot.
3932
+ # @!attribute [rw] next_page_token
3933
+ # A token used for advancing to the next page of results from your get
3934
+ # relational database snapshots request.
3507
3935
  # @return [String]
3508
3936
  #
3509
- # @!attribute [rw] arn
3510
- # The Amazon Resource Name (ARN) of the snapshot (e.g.,
3511
- # `arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE`).
3512
- # @return [String]
3937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseSnapshotsResult AWS API Documentation
3513
3938
  #
3514
- # @!attribute [rw] support_code
3515
- # The support code. Include this code in your email to support when
3516
- # you have questions about an instance or another resource in
3517
- # Lightsail. This code enables our support team to look up your
3518
- # Lightsail information more easily.
3939
+ class GetRelationalDatabaseSnapshotsResult < Struct.new(
3940
+ :relational_database_snapshots,
3941
+ :next_page_token)
3942
+ include Aws::Structure
3943
+ end
3944
+
3945
+ # @note When making an API call, you may pass GetRelationalDatabasesRequest
3946
+ # data as a hash:
3947
+ #
3948
+ # {
3949
+ # page_token: "string",
3950
+ # }
3951
+ #
3952
+ # @!attribute [rw] page_token
3953
+ # A token used for advancing to a specific page of results for your
3954
+ # get relational database request.
3519
3955
  # @return [String]
3520
3956
  #
3521
- # @!attribute [rw] created_at
3522
- # The timestamp when the snapshot was created (e.g.,
3523
- # `1479907467.024`).
3524
- # @return [Time]
3957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabasesRequest AWS API Documentation
3525
3958
  #
3526
- # @!attribute [rw] location
3527
- # The region name and availability zone where you created the
3528
- # snapshot.
3529
- # @return [Types::ResourceLocation]
3959
+ class GetRelationalDatabasesRequest < Struct.new(
3960
+ :page_token)
3961
+ include Aws::Structure
3962
+ end
3963
+
3964
+ # @!attribute [rw] relational_databases
3965
+ # An object describing the result of your get relational databases
3966
+ # request.
3967
+ # @return [Array<Types::RelationalDatabase>]
3530
3968
  #
3531
- # @!attribute [rw] resource_type
3532
- # The type of resource (usually `InstanceSnapshot`).
3969
+ # @!attribute [rw] next_page_token
3970
+ # A token used for advancing to the next page of results from your get
3971
+ # relational databases request.
3533
3972
  # @return [String]
3534
3973
  #
3535
- # @!attribute [rw] state
3536
- # The state the snapshot is in.
3537
- # @return [String]
3974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabasesResult AWS API Documentation
3538
3975
  #
3539
- # @!attribute [rw] progress
3540
- # The progress of the snapshot.
3541
- # @return [String]
3976
+ class GetRelationalDatabasesResult < Struct.new(
3977
+ :relational_databases,
3978
+ :next_page_token)
3979
+ include Aws::Structure
3980
+ end
3981
+
3982
+ # @note When making an API call, you may pass GetStaticIpRequest
3983
+ # data as a hash:
3542
3984
  #
3543
- # @!attribute [rw] from_attached_disks
3544
- # An array of disk objects containing information about all block
3545
- # storage disks.
3546
- # @return [Array<Types::Disk>]
3985
+ # {
3986
+ # static_ip_name: "ResourceName", # required
3987
+ # }
3547
3988
  #
3548
- # @!attribute [rw] from_instance_name
3549
- # The instance from which the snapshot was created.
3989
+ # @!attribute [rw] static_ip_name
3990
+ # The name of the static IP in Lightsail.
3550
3991
  # @return [String]
3551
3992
  #
3552
- # @!attribute [rw] from_instance_arn
3553
- # The Amazon Resource Name (ARN) of the instance from which the
3554
- # snapshot was created (e.g.,
3555
- # `arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE`).
3556
- # @return [String]
3993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpRequest AWS API Documentation
3557
3994
  #
3558
- # @!attribute [rw] from_blueprint_id
3559
- # The blueprint ID from which you created the snapshot (e.g.,
3560
- # `os_debian_8_3`). A blueprint is a virtual private server (or
3561
- # *instance*) image used to create instances quickly.
3562
- # @return [String]
3563
- #
3564
- # @!attribute [rw] from_bundle_id
3565
- # The bundle ID from which you created the snapshot (e.g.,
3566
- # `micro_1_0`).
3567
- # @return [String]
3568
- #
3569
- # @!attribute [rw] size_in_gb
3570
- # The size in GB of the SSD.
3571
- # @return [Integer]
3995
+ class GetStaticIpRequest < Struct.new(
3996
+ :static_ip_name)
3997
+ include Aws::Structure
3998
+ end
3999
+
4000
+ # @!attribute [rw] static_ip
4001
+ # An array of key-value pairs containing information about the
4002
+ # requested static IP.
4003
+ # @return [Types::StaticIp]
3572
4004
  #
3573
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceSnapshot AWS API Documentation
4005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpResult AWS API Documentation
3574
4006
  #
3575
- class InstanceSnapshot < Struct.new(
3576
- :name,
3577
- :arn,
3578
- :support_code,
3579
- :created_at,
3580
- :location,
3581
- :resource_type,
3582
- :state,
3583
- :progress,
3584
- :from_attached_disks,
3585
- :from_instance_name,
3586
- :from_instance_arn,
3587
- :from_blueprint_id,
3588
- :from_bundle_id,
3589
- :size_in_gb)
4007
+ class GetStaticIpResult < Struct.new(
4008
+ :static_ip)
3590
4009
  include Aws::Structure
3591
4010
  end
3592
4011
 
3593
- # Describes the virtual private server (or *instance*) status.
4012
+ # @note When making an API call, you may pass GetStaticIpsRequest
4013
+ # data as a hash:
3594
4014
  #
3595
- # @!attribute [rw] code
3596
- # The status code for the instance.
3597
- # @return [Integer]
4015
+ # {
4016
+ # page_token: "string",
4017
+ # }
3598
4018
  #
3599
- # @!attribute [rw] name
3600
- # The state of the instance (e.g., `running` or `pending`).
4019
+ # @!attribute [rw] page_token
4020
+ # A token used for advancing to the next page of results from your get
4021
+ # static IPs request.
3601
4022
  # @return [String]
3602
4023
  #
3603
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceState AWS API Documentation
4024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpsRequest AWS API Documentation
3604
4025
  #
3605
- class InstanceState < Struct.new(
3606
- :code,
3607
- :name)
4026
+ class GetStaticIpsRequest < Struct.new(
4027
+ :page_token)
3608
4028
  include Aws::Structure
3609
4029
  end
3610
4030
 
3611
- # @api private
3612
- #
3613
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeeredRequest AWS API Documentation
4031
+ # @!attribute [rw] static_ips
4032
+ # An array of key-value pairs containing information about your get
4033
+ # static IPs request.
4034
+ # @return [Array<Types::StaticIp>]
3614
4035
  #
3615
- class IsVpcPeeredRequest < Aws::EmptyStructure; end
3616
-
3617
- # @!attribute [rw] is_peered
3618
- # Returns `true` if the Lightsail VPC is peered; otherwise, `false`.
3619
- # @return [Boolean]
4036
+ # @!attribute [rw] next_page_token
4037
+ # A token used for advancing to the next page of results from your get
4038
+ # static IPs request.
4039
+ # @return [String]
3620
4040
  #
3621
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeeredResult AWS API Documentation
4041
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetStaticIpsResult AWS API Documentation
3622
4042
  #
3623
- class IsVpcPeeredResult < Struct.new(
3624
- :is_peered)
4043
+ class GetStaticIpsResult < Struct.new(
4044
+ :static_ips,
4045
+ :next_page_token)
3625
4046
  include Aws::Structure
3626
4047
  end
3627
4048
 
3628
- # Describes the SSH key pair.
4049
+ # @note When making an API call, you may pass ImportKeyPairRequest
4050
+ # data as a hash:
3629
4051
  #
3630
- # @!attribute [rw] name
3631
- # The friendly name of the SSH key pair.
3632
- # @return [String]
4052
+ # {
4053
+ # key_pair_name: "ResourceName", # required
4054
+ # public_key_base_64: "Base64", # required
4055
+ # }
3633
4056
  #
3634
- # @!attribute [rw] arn
3635
- # The Amazon Resource Name (ARN) of the key pair (e.g.,
3636
- # `arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE`).
4057
+ # @!attribute [rw] key_pair_name
4058
+ # The name of the key pair for which you want to import the public
4059
+ # key.
3637
4060
  # @return [String]
3638
4061
  #
3639
- # @!attribute [rw] support_code
3640
- # The support code. Include this code in your email to support when
3641
- # you have questions about an instance or another resource in
3642
- # Lightsail. This code enables our support team to look up your
3643
- # Lightsail information more easily.
4062
+ # @!attribute [rw] public_key_base_64
4063
+ # A base64-encoded public key of the `ssh-rsa` type.
3644
4064
  # @return [String]
3645
4065
  #
3646
- # @!attribute [rw] created_at
3647
- # The timestamp when the key pair was created (e.g.,
3648
- # `1479816991.349`).
3649
- # @return [Time]
3650
- #
3651
- # @!attribute [rw] location
3652
- # The region name and Availability Zone where the key pair was
3653
- # created.
3654
- # @return [Types::ResourceLocation]
3655
- #
3656
- # @!attribute [rw] resource_type
3657
- # The resource type (usually `KeyPair`).
3658
- # @return [String]
4066
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPairRequest AWS API Documentation
3659
4067
  #
3660
- # @!attribute [rw] fingerprint
3661
- # The RSA fingerprint of the key pair.
3662
- # @return [String]
4068
+ class ImportKeyPairRequest < Struct.new(
4069
+ :key_pair_name,
4070
+ :public_key_base_64)
4071
+ include Aws::Structure
4072
+ end
4073
+
4074
+ # @!attribute [rw] operation
4075
+ # An array of key-value pairs containing information about the request
4076
+ # operation.
4077
+ # @return [Types::Operation]
3663
4078
  #
3664
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/KeyPair AWS API Documentation
4079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ImportKeyPairResult AWS API Documentation
3665
4080
  #
3666
- class KeyPair < Struct.new(
3667
- :name,
3668
- :arn,
3669
- :support_code,
3670
- :created_at,
3671
- :location,
3672
- :resource_type,
3673
- :fingerprint)
4081
+ class ImportKeyPairResult < Struct.new(
4082
+ :operation)
3674
4083
  include Aws::Structure
3675
4084
  end
3676
4085
 
3677
- # Describes the Lightsail load balancer.
4086
+ # Describes an instance (a virtual private server).
3678
4087
  #
3679
4088
  # @!attribute [rw] name
3680
- # The name of the load balancer (e.g., `my-load-balancer`).
4089
+ # The name the user gave the instance (e.g.,
4090
+ # `Amazon_Linux-1GB-Ohio-1`).
3681
4091
  # @return [String]
3682
4092
  #
3683
4093
  # @!attribute [rw] arn
3684
- # The Amazon Resource Name (ARN) of the load balancer.
4094
+ # The Amazon Resource Name (ARN) of the instance (e.g.,
4095
+ # `arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE`).
3685
4096
  # @return [String]
3686
4097
  #
3687
4098
  # @!attribute [rw] support_code
3688
4099
  # The support code. Include this code in your email to support when
3689
- # you have questions about your Lightsail load balancer. This code
3690
- # enables our support team to look up your Lightsail information more
3691
- # easily.
4100
+ # you have questions about an instance or another resource in
4101
+ # Lightsail. This code enables our support team to look up your
4102
+ # Lightsail information more easily.
3692
4103
  # @return [String]
3693
4104
  #
3694
4105
  # @!attribute [rw] created_at
3695
- # The date when your load balancer was created.
4106
+ # The timestamp when the instance was created (e.g., `1479734909.17`).
3696
4107
  # @return [Time]
3697
4108
  #
3698
4109
  # @!attribute [rw] location
3699
- # The AWS Region where your load balancer was created (e.g.,
3700
- # `us-east-2a`). Lightsail automatically creates your load balancer
3701
- # across Availability Zones.
4110
+ # The region name and Availability Zone where the instance is located.
3702
4111
  # @return [Types::ResourceLocation]
3703
4112
  #
3704
4113
  # @!attribute [rw] resource_type
3705
- # The resource type (e.g., `LoadBalancer`.
4114
+ # The type of resource (usually `Instance`).
3706
4115
  # @return [String]
3707
4116
  #
3708
- # @!attribute [rw] dns_name
3709
- # The DNS name of your Lightsail load balancer.
4117
+ # @!attribute [rw] blueprint_id
4118
+ # The blueprint ID (e.g., `os_amlinux_2016_03`).
3710
4119
  # @return [String]
3711
4120
  #
3712
- # @!attribute [rw] state
3713
- # The status of your load balancer. Valid values are below.
4121
+ # @!attribute [rw] blueprint_name
4122
+ # The friendly name of the blueprint (e.g., `Amazon Linux`).
3714
4123
  # @return [String]
3715
4124
  #
3716
- # @!attribute [rw] protocol
3717
- # The protocol you have enabled for your load balancer. Valid values
3718
- # are below.
4125
+ # @!attribute [rw] bundle_id
4126
+ # The bundle for the instance (e.g., `micro_1_0`).
4127
+ # @return [String]
3719
4128
  #
3720
- # You can't just have `HTTP_HTTPS`, but you can have just `HTTP`.
4129
+ # @!attribute [rw] is_static_ip
4130
+ # A Boolean value indicating whether this instance has a static IP
4131
+ # assigned to it.
4132
+ # @return [Boolean]
4133
+ #
4134
+ # @!attribute [rw] private_ip_address
4135
+ # The private IP address of the instance.
3721
4136
  # @return [String]
3722
4137
  #
3723
- # @!attribute [rw] public_ports
3724
- # An array of public port settings for your load balancer. For HTTP,
3725
- # use port 80. For HTTPS, use port 443.
3726
- # @return [Array<Integer>]
4138
+ # @!attribute [rw] public_ip_address
4139
+ # The public IP address of the instance.
4140
+ # @return [String]
3727
4141
  #
3728
- # @!attribute [rw] health_check_path
3729
- # The path you specified to perform your health checks. If no path is
3730
- # specified, the load balancer tries to make a request to the default
3731
- # (root) page.
4142
+ # @!attribute [rw] ipv6_address
4143
+ # The IPv6 address of the instance.
3732
4144
  # @return [String]
3733
4145
  #
3734
- # @!attribute [rw] instance_port
3735
- # The port where the load balancer will direct traffic to your
3736
- # Lightsail instances. For HTTP traffic, it's port 80. For HTTPS
3737
- # traffic, it's port 443.
3738
- # @return [Integer]
4146
+ # @!attribute [rw] hardware
4147
+ # The size of the vCPU and the amount of RAM for the instance.
4148
+ # @return [Types::InstanceHardware]
3739
4149
  #
3740
- # @!attribute [rw] instance_health_summary
3741
- # An array of InstanceHealthSummary objects describing the health of
3742
- # the load balancer.
3743
- # @return [Array<Types::InstanceHealthSummary>]
4150
+ # @!attribute [rw] networking
4151
+ # Information about the public ports and monthly data transfer rates
4152
+ # for the instance.
4153
+ # @return [Types::InstanceNetworking]
3744
4154
  #
3745
- # @!attribute [rw] tls_certificate_summaries
3746
- # An array of LoadBalancerTlsCertificateSummary objects that provide
3747
- # additional information about the SSL/TLS certificates. For example,
3748
- # if `true`, the certificate is attached to the load balancer.
3749
- # @return [Array<Types::LoadBalancerTlsCertificateSummary>]
4155
+ # @!attribute [rw] state
4156
+ # The status code and the state (e.g., `running`) for the instance.
4157
+ # @return [Types::InstanceState]
3750
4158
  #
3751
- # @!attribute [rw] configuration_options
3752
- # A string to string map of the configuration options for your load
3753
- # balancer. Valid values are listed below.
3754
- # @return [Hash<String,String>]
4159
+ # @!attribute [rw] username
4160
+ # The user name for connecting to the instance (e.g., `ec2-user`).
4161
+ # @return [String]
3755
4162
  #
3756
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancer AWS API Documentation
4163
+ # @!attribute [rw] ssh_key_name
4164
+ # The name of the SSH key being used to connect to the instance (e.g.,
4165
+ # `LightsailDefaultKeyPair`).
4166
+ # @return [String]
3757
4167
  #
3758
- class LoadBalancer < Struct.new(
4168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Instance AWS API Documentation
4169
+ #
4170
+ class Instance < Struct.new(
3759
4171
  :name,
3760
4172
  :arn,
3761
4173
  :support_code,
3762
4174
  :created_at,
3763
4175
  :location,
3764
4176
  :resource_type,
3765
- :dns_name,
4177
+ :blueprint_id,
4178
+ :blueprint_name,
4179
+ :bundle_id,
4180
+ :is_static_ip,
4181
+ :private_ip_address,
4182
+ :public_ip_address,
4183
+ :ipv6_address,
4184
+ :hardware,
4185
+ :networking,
3766
4186
  :state,
3767
- :protocol,
3768
- :public_ports,
3769
- :health_check_path,
3770
- :instance_port,
3771
- :instance_health_summary,
4187
+ :username,
4188
+ :ssh_key_name)
4189
+ include Aws::Structure
4190
+ end
4191
+
4192
+ # The parameters for gaining temporary access to one of your Amazon
4193
+ # Lightsail instances.
4194
+ #
4195
+ # @!attribute [rw] cert_key
4196
+ # For SSH access, the public key to use when accessing your instance
4197
+ # For OpenSSH clients (e.g., command line SSH), you should save this
4198
+ # value to `tempkey-cert.pub`.
4199
+ # @return [String]
4200
+ #
4201
+ # @!attribute [rw] expires_at
4202
+ # For SSH access, the date on which the temporary keys expire.
4203
+ # @return [Time]
4204
+ #
4205
+ # @!attribute [rw] ip_address
4206
+ # The public IP address of the Amazon Lightsail instance.
4207
+ # @return [String]
4208
+ #
4209
+ # @!attribute [rw] password
4210
+ # For RDP access, the password for your Amazon Lightsail instance.
4211
+ # Password will be an empty string if the password for your new
4212
+ # instance is not ready yet. When you create an instance, it can take
4213
+ # up to 15 minutes for the instance to be ready.
4214
+ #
4215
+ # <note markdown="1"> If you create an instance using any key pair other than the default
4216
+ # (`LightsailDefaultKeyPair`), `password` will always be an empty
4217
+ # string.
4218
+ #
4219
+ # If you change the Administrator password on the instance, Lightsail
4220
+ # will continue to return the original password value. When accessing
4221
+ # the instance using RDP, you need to manually enter the Administrator
4222
+ # password after changing it from the default.
4223
+ #
4224
+ # </note>
4225
+ # @return [String]
4226
+ #
4227
+ # @!attribute [rw] password_data
4228
+ # For a Windows Server-based instance, an object with the data you can
4229
+ # use to retrieve your password. This is only needed if `password` is
4230
+ # empty and the instance is not new (and therefore the password is not
4231
+ # ready yet). When you create an instance, it can take up to 15
4232
+ # minutes for the instance to be ready.
4233
+ # @return [Types::PasswordData]
4234
+ #
4235
+ # @!attribute [rw] private_key
4236
+ # For SSH access, the temporary private key. For OpenSSH clients
4237
+ # (e.g., command line SSH), you should save this value to `tempkey`).
4238
+ # @return [String]
4239
+ #
4240
+ # @!attribute [rw] protocol
4241
+ # The protocol for these Amazon Lightsail instance access details.
4242
+ # @return [String]
4243
+ #
4244
+ # @!attribute [rw] instance_name
4245
+ # The name of this Amazon Lightsail instance.
4246
+ # @return [String]
4247
+ #
4248
+ # @!attribute [rw] username
4249
+ # The user name to use when logging in to the Amazon Lightsail
4250
+ # instance.
4251
+ # @return [String]
4252
+ #
4253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceAccessDetails AWS API Documentation
4254
+ #
4255
+ class InstanceAccessDetails < Struct.new(
4256
+ :cert_key,
4257
+ :expires_at,
4258
+ :ip_address,
4259
+ :password,
4260
+ :password_data,
4261
+ :private_key,
4262
+ :protocol,
4263
+ :instance_name,
4264
+ :username)
4265
+ include Aws::Structure
4266
+ end
4267
+
4268
+ # Describes the hardware for the instance.
4269
+ #
4270
+ # @!attribute [rw] cpu_count
4271
+ # The number of vCPUs the instance has.
4272
+ # @return [Integer]
4273
+ #
4274
+ # @!attribute [rw] disks
4275
+ # The disks attached to the instance.
4276
+ # @return [Array<Types::Disk>]
4277
+ #
4278
+ # @!attribute [rw] ram_size_in_gb
4279
+ # The amount of RAM in GB on the instance (e.g., `1.0`).
4280
+ # @return [Float]
4281
+ #
4282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceHardware AWS API Documentation
4283
+ #
4284
+ class InstanceHardware < Struct.new(
4285
+ :cpu_count,
4286
+ :disks,
4287
+ :ram_size_in_gb)
4288
+ include Aws::Structure
4289
+ end
4290
+
4291
+ # Describes information about the health of the instance.
4292
+ #
4293
+ # @!attribute [rw] instance_name
4294
+ # The name of the Lightsail instance for which you are requesting
4295
+ # health check data.
4296
+ # @return [String]
4297
+ #
4298
+ # @!attribute [rw] instance_health
4299
+ # Describes the overall instance health. Valid values are below.
4300
+ # @return [String]
4301
+ #
4302
+ # @!attribute [rw] instance_health_reason
4303
+ # More information about the instance health. If the `instanceHealth`
4304
+ # is `healthy`, then an `instanceHealthReason` value is not provided.
4305
+ #
4306
+ # If <b> <code>instanceHealth</code> </b> is `initial`, the <b>
4307
+ # <code>instanceHealthReason</code> </b> value can be one of the
4308
+ # following:
4309
+ #
4310
+ # * <b> <code>Lb.RegistrationInProgress</code> </b> - The target
4311
+ # instance is in the process of being registered with the load
4312
+ # balancer.
4313
+ #
4314
+ # * <b> <code>Lb.InitialHealthChecking</code> </b> - The Lightsail
4315
+ # load balancer is still sending the target instance the minimum
4316
+ # number of health checks required to determine its health status.
4317
+ #
4318
+ # If <b> <code>instanceHealth</code> </b> is `unhealthy`, the <b>
4319
+ # <code>instanceHealthReason</code> </b> value can be one of the
4320
+ # following:
4321
+ #
4322
+ # * <b> <code>Instance.ResponseCodeMismatch</code> </b> - The health
4323
+ # checks did not return an expected HTTP code.
4324
+ #
4325
+ # * <b> <code>Instance.Timeout</code> </b> - The health check requests
4326
+ # timed out.
4327
+ #
4328
+ # * <b> <code>Instance.FailedHealthChecks</code> </b> - The health
4329
+ # checks failed because the connection to the target instance timed
4330
+ # out, the target instance response was malformed, or the target
4331
+ # instance failed the health check for an unknown reason.
4332
+ #
4333
+ # * <b> <code>Lb.InternalError</code> </b> - The health checks failed
4334
+ # due to an internal error.
4335
+ #
4336
+ # If <b> <code>instanceHealth</code> </b> is `unused`, the <b>
4337
+ # <code>instanceHealthReason</code> </b> value can be one of the
4338
+ # following:
4339
+ #
4340
+ # * <b> <code>Instance.NotRegistered</code> </b> - The target instance
4341
+ # is not registered with the target group.
4342
+ #
4343
+ # * <b> <code>Instance.NotInUse</code> </b> - The target group is not
4344
+ # used by any load balancer, or the target instance is in an
4345
+ # Availability Zone that is not enabled for its load balancer.
4346
+ #
4347
+ # * <b> <code>Instance.IpUnusable</code> </b> - The target IP address
4348
+ # is reserved for use by a Lightsail load balancer.
4349
+ #
4350
+ # * <b> <code>Instance.InvalidState</code> </b> - The target is in the
4351
+ # stopped or terminated state.
4352
+ #
4353
+ # If <b> <code>instanceHealth</code> </b> is `draining`, the <b>
4354
+ # <code>instanceHealthReason</code> </b> value can be one of the
4355
+ # following:
4356
+ #
4357
+ # * <b> <code>Instance.DeregistrationInProgress</code> </b> - The
4358
+ # target instance is in the process of being deregistered and the
4359
+ # deregistration delay period has not expired.
4360
+ #
4361
+ # ^
4362
+ # @return [String]
4363
+ #
4364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceHealthSummary AWS API Documentation
4365
+ #
4366
+ class InstanceHealthSummary < Struct.new(
4367
+ :instance_name,
4368
+ :instance_health,
4369
+ :instance_health_reason)
4370
+ include Aws::Structure
4371
+ end
4372
+
4373
+ # Describes monthly data transfer rates and port information for an
4374
+ # instance.
4375
+ #
4376
+ # @!attribute [rw] monthly_transfer
4377
+ # The amount of data in GB allocated for monthly data transfers.
4378
+ # @return [Types::MonthlyTransfer]
4379
+ #
4380
+ # @!attribute [rw] ports
4381
+ # An array of key-value pairs containing information about the ports
4382
+ # on the instance.
4383
+ # @return [Array<Types::InstancePortInfo>]
4384
+ #
4385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceNetworking AWS API Documentation
4386
+ #
4387
+ class InstanceNetworking < Struct.new(
4388
+ :monthly_transfer,
4389
+ :ports)
4390
+ include Aws::Structure
4391
+ end
4392
+
4393
+ # Describes information about the instance ports.
4394
+ #
4395
+ # @!attribute [rw] from_port
4396
+ # The first port in the range.
4397
+ # @return [Integer]
4398
+ #
4399
+ # @!attribute [rw] to_port
4400
+ # The last port in the range.
4401
+ # @return [Integer]
4402
+ #
4403
+ # @!attribute [rw] protocol
4404
+ # The protocol being used. Can be one of the following.
4405
+ #
4406
+ # * `tcp` - Transmission Control Protocol (TCP) provides reliable,
4407
+ # ordered, and error-checked delivery of streamed data between
4408
+ # applications running on hosts communicating by an IP network. If
4409
+ # you have an application that doesn't require reliable data stream
4410
+ # service, use UDP instead.
4411
+ #
4412
+ # * `all` - All transport layer protocol types. For more general
4413
+ # information, see [Transport layer][1] on Wikipedia.
4414
+ #
4415
+ # * `udp` - With User Datagram Protocol (UDP), computer applications
4416
+ # can send messages (or datagrams) to other hosts on an Internet
4417
+ # Protocol (IP) network. Prior communications are not required to
4418
+ # set up transmission channels or data paths. Applications that
4419
+ # don't require reliable data stream service can use UDP, which
4420
+ # provides a connectionless datagram service that emphasizes reduced
4421
+ # latency over reliability. If you do require reliable data stream
4422
+ # service, use TCP instead.
4423
+ #
4424
+ #
4425
+ #
4426
+ # [1]: https://en.wikipedia.org/wiki/Transport_layer
4427
+ # @return [String]
4428
+ #
4429
+ # @!attribute [rw] access_from
4430
+ # The location from which access is allowed (e.g., `Anywhere
4431
+ # (0.0.0.0/0)`).
4432
+ # @return [String]
4433
+ #
4434
+ # @!attribute [rw] access_type
4435
+ # The type of access (`Public` or `Private`).
4436
+ # @return [String]
4437
+ #
4438
+ # @!attribute [rw] common_name
4439
+ # The common name.
4440
+ # @return [String]
4441
+ #
4442
+ # @!attribute [rw] access_direction
4443
+ # The access direction (`inbound` or `outbound`).
4444
+ # @return [String]
4445
+ #
4446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstancePortInfo AWS API Documentation
4447
+ #
4448
+ class InstancePortInfo < Struct.new(
4449
+ :from_port,
4450
+ :to_port,
4451
+ :protocol,
4452
+ :access_from,
4453
+ :access_type,
4454
+ :common_name,
4455
+ :access_direction)
4456
+ include Aws::Structure
4457
+ end
4458
+
4459
+ # Describes the port state.
4460
+ #
4461
+ # @!attribute [rw] from_port
4462
+ # The first port in the range.
4463
+ # @return [Integer]
4464
+ #
4465
+ # @!attribute [rw] to_port
4466
+ # The last port in the range.
4467
+ # @return [Integer]
4468
+ #
4469
+ # @!attribute [rw] protocol
4470
+ # The protocol being used. Can be one of the following.
4471
+ #
4472
+ # * `tcp` - Transmission Control Protocol (TCP) provides reliable,
4473
+ # ordered, and error-checked delivery of streamed data between
4474
+ # applications running on hosts communicating by an IP network. If
4475
+ # you have an application that doesn't require reliable data stream
4476
+ # service, use UDP instead.
4477
+ #
4478
+ # * `all` - All transport layer protocol types. For more general
4479
+ # information, see [Transport layer][1] on Wikipedia.
4480
+ #
4481
+ # * `udp` - With User Datagram Protocol (UDP), computer applications
4482
+ # can send messages (or datagrams) to other hosts on an Internet
4483
+ # Protocol (IP) network. Prior communications are not required to
4484
+ # set up transmission channels or data paths. Applications that
4485
+ # don't require reliable data stream service can use UDP, which
4486
+ # provides a connectionless datagram service that emphasizes reduced
4487
+ # latency over reliability. If you do require reliable data stream
4488
+ # service, use TCP instead.
4489
+ #
4490
+ #
4491
+ #
4492
+ # [1]: https://en.wikipedia.org/wiki/Transport_layer
4493
+ # @return [String]
4494
+ #
4495
+ # @!attribute [rw] state
4496
+ # Specifies whether the instance port is `open` or `closed`.
4497
+ # @return [String]
4498
+ #
4499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstancePortState AWS API Documentation
4500
+ #
4501
+ class InstancePortState < Struct.new(
4502
+ :from_port,
4503
+ :to_port,
4504
+ :protocol,
4505
+ :state)
4506
+ include Aws::Structure
4507
+ end
4508
+
4509
+ # Describes the snapshot of the virtual private server, or *instance*.
4510
+ #
4511
+ # @!attribute [rw] name
4512
+ # The name of the snapshot.
4513
+ # @return [String]
4514
+ #
4515
+ # @!attribute [rw] arn
4516
+ # The Amazon Resource Name (ARN) of the snapshot (e.g.,
4517
+ # `arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE`).
4518
+ # @return [String]
4519
+ #
4520
+ # @!attribute [rw] support_code
4521
+ # The support code. Include this code in your email to support when
4522
+ # you have questions about an instance or another resource in
4523
+ # Lightsail. This code enables our support team to look up your
4524
+ # Lightsail information more easily.
4525
+ # @return [String]
4526
+ #
4527
+ # @!attribute [rw] created_at
4528
+ # The timestamp when the snapshot was created (e.g.,
4529
+ # `1479907467.024`).
4530
+ # @return [Time]
4531
+ #
4532
+ # @!attribute [rw] location
4533
+ # The region name and Availability Zone where you created the
4534
+ # snapshot.
4535
+ # @return [Types::ResourceLocation]
4536
+ #
4537
+ # @!attribute [rw] resource_type
4538
+ # The type of resource (usually `InstanceSnapshot`).
4539
+ # @return [String]
4540
+ #
4541
+ # @!attribute [rw] state
4542
+ # The state the snapshot is in.
4543
+ # @return [String]
4544
+ #
4545
+ # @!attribute [rw] progress
4546
+ # The progress of the snapshot.
4547
+ # @return [String]
4548
+ #
4549
+ # @!attribute [rw] from_attached_disks
4550
+ # An array of disk objects containing information about all block
4551
+ # storage disks.
4552
+ # @return [Array<Types::Disk>]
4553
+ #
4554
+ # @!attribute [rw] from_instance_name
4555
+ # The instance from which the snapshot was created.
4556
+ # @return [String]
4557
+ #
4558
+ # @!attribute [rw] from_instance_arn
4559
+ # The Amazon Resource Name (ARN) of the instance from which the
4560
+ # snapshot was created (e.g.,
4561
+ # `arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE`).
4562
+ # @return [String]
4563
+ #
4564
+ # @!attribute [rw] from_blueprint_id
4565
+ # The blueprint ID from which you created the snapshot (e.g.,
4566
+ # `os_debian_8_3`). A blueprint is a virtual private server (or
4567
+ # *instance*) image used to create instances quickly.
4568
+ # @return [String]
4569
+ #
4570
+ # @!attribute [rw] from_bundle_id
4571
+ # The bundle ID from which you created the snapshot (e.g.,
4572
+ # `micro_1_0`).
4573
+ # @return [String]
4574
+ #
4575
+ # @!attribute [rw] size_in_gb
4576
+ # The size in GB of the SSD.
4577
+ # @return [Integer]
4578
+ #
4579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceSnapshot AWS API Documentation
4580
+ #
4581
+ class InstanceSnapshot < Struct.new(
4582
+ :name,
4583
+ :arn,
4584
+ :support_code,
4585
+ :created_at,
4586
+ :location,
4587
+ :resource_type,
4588
+ :state,
4589
+ :progress,
4590
+ :from_attached_disks,
4591
+ :from_instance_name,
4592
+ :from_instance_arn,
4593
+ :from_blueprint_id,
4594
+ :from_bundle_id,
4595
+ :size_in_gb)
4596
+ include Aws::Structure
4597
+ end
4598
+
4599
+ # Describes the virtual private server (or *instance*) status.
4600
+ #
4601
+ # @!attribute [rw] code
4602
+ # The status code for the instance.
4603
+ # @return [Integer]
4604
+ #
4605
+ # @!attribute [rw] name
4606
+ # The state of the instance (e.g., `running` or `pending`).
4607
+ # @return [String]
4608
+ #
4609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceState AWS API Documentation
4610
+ #
4611
+ class InstanceState < Struct.new(
4612
+ :code,
4613
+ :name)
4614
+ include Aws::Structure
4615
+ end
4616
+
4617
+ # @api private
4618
+ #
4619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeeredRequest AWS API Documentation
4620
+ #
4621
+ class IsVpcPeeredRequest < Aws::EmptyStructure; end
4622
+
4623
+ # @!attribute [rw] is_peered
4624
+ # Returns `true` if the Lightsail VPC is peered; otherwise, `false`.
4625
+ # @return [Boolean]
4626
+ #
4627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/IsVpcPeeredResult AWS API Documentation
4628
+ #
4629
+ class IsVpcPeeredResult < Struct.new(
4630
+ :is_peered)
4631
+ include Aws::Structure
4632
+ end
4633
+
4634
+ # Describes the SSH key pair.
4635
+ #
4636
+ # @!attribute [rw] name
4637
+ # The friendly name of the SSH key pair.
4638
+ # @return [String]
4639
+ #
4640
+ # @!attribute [rw] arn
4641
+ # The Amazon Resource Name (ARN) of the key pair (e.g.,
4642
+ # `arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE`).
4643
+ # @return [String]
4644
+ #
4645
+ # @!attribute [rw] support_code
4646
+ # The support code. Include this code in your email to support when
4647
+ # you have questions about an instance or another resource in
4648
+ # Lightsail. This code enables our support team to look up your
4649
+ # Lightsail information more easily.
4650
+ # @return [String]
4651
+ #
4652
+ # @!attribute [rw] created_at
4653
+ # The timestamp when the key pair was created (e.g.,
4654
+ # `1479816991.349`).
4655
+ # @return [Time]
4656
+ #
4657
+ # @!attribute [rw] location
4658
+ # The region name and Availability Zone where the key pair was
4659
+ # created.
4660
+ # @return [Types::ResourceLocation]
4661
+ #
4662
+ # @!attribute [rw] resource_type
4663
+ # The resource type (usually `KeyPair`).
4664
+ # @return [String]
4665
+ #
4666
+ # @!attribute [rw] fingerprint
4667
+ # The RSA fingerprint of the key pair.
4668
+ # @return [String]
4669
+ #
4670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/KeyPair AWS API Documentation
4671
+ #
4672
+ class KeyPair < Struct.new(
4673
+ :name,
4674
+ :arn,
4675
+ :support_code,
4676
+ :created_at,
4677
+ :location,
4678
+ :resource_type,
4679
+ :fingerprint)
4680
+ include Aws::Structure
4681
+ end
4682
+
4683
+ # Describes the Lightsail load balancer.
4684
+ #
4685
+ # @!attribute [rw] name
4686
+ # The name of the load balancer (e.g., `my-load-balancer`).
4687
+ # @return [String]
4688
+ #
4689
+ # @!attribute [rw] arn
4690
+ # The Amazon Resource Name (ARN) of the load balancer.
4691
+ # @return [String]
4692
+ #
4693
+ # @!attribute [rw] support_code
4694
+ # The support code. Include this code in your email to support when
4695
+ # you have questions about your Lightsail load balancer. This code
4696
+ # enables our support team to look up your Lightsail information more
4697
+ # easily.
4698
+ # @return [String]
4699
+ #
4700
+ # @!attribute [rw] created_at
4701
+ # The date when your load balancer was created.
4702
+ # @return [Time]
4703
+ #
4704
+ # @!attribute [rw] location
4705
+ # The AWS Region where your load balancer was created (e.g.,
4706
+ # `us-east-2a`). Lightsail automatically creates your load balancer
4707
+ # across Availability Zones.
4708
+ # @return [Types::ResourceLocation]
4709
+ #
4710
+ # @!attribute [rw] resource_type
4711
+ # The resource type (e.g., `LoadBalancer`.
4712
+ # @return [String]
4713
+ #
4714
+ # @!attribute [rw] dns_name
4715
+ # The DNS name of your Lightsail load balancer.
4716
+ # @return [String]
4717
+ #
4718
+ # @!attribute [rw] state
4719
+ # The status of your load balancer. Valid values are below.
4720
+ # @return [String]
4721
+ #
4722
+ # @!attribute [rw] protocol
4723
+ # The protocol you have enabled for your load balancer. Valid values
4724
+ # are below.
4725
+ #
4726
+ # You can't just have `HTTP_HTTPS`, but you can have just `HTTP`.
4727
+ # @return [String]
4728
+ #
4729
+ # @!attribute [rw] public_ports
4730
+ # An array of public port settings for your load balancer. For HTTP,
4731
+ # use port 80. For HTTPS, use port 443.
4732
+ # @return [Array<Integer>]
4733
+ #
4734
+ # @!attribute [rw] health_check_path
4735
+ # The path you specified to perform your health checks. If no path is
4736
+ # specified, the load balancer tries to make a request to the default
4737
+ # (root) page.
4738
+ # @return [String]
4739
+ #
4740
+ # @!attribute [rw] instance_port
4741
+ # The port where the load balancer will direct traffic to your
4742
+ # Lightsail instances. For HTTP traffic, it's port 80. For HTTPS
4743
+ # traffic, it's port 443.
4744
+ # @return [Integer]
4745
+ #
4746
+ # @!attribute [rw] instance_health_summary
4747
+ # An array of InstanceHealthSummary objects describing the health of
4748
+ # the load balancer.
4749
+ # @return [Array<Types::InstanceHealthSummary>]
4750
+ #
4751
+ # @!attribute [rw] tls_certificate_summaries
4752
+ # An array of LoadBalancerTlsCertificateSummary objects that provide
4753
+ # additional information about the SSL/TLS certificates. For example,
4754
+ # if `true`, the certificate is attached to the load balancer.
4755
+ # @return [Array<Types::LoadBalancerTlsCertificateSummary>]
4756
+ #
4757
+ # @!attribute [rw] configuration_options
4758
+ # A string to string map of the configuration options for your load
4759
+ # balancer. Valid values are listed below.
4760
+ # @return [Hash<String,String>]
4761
+ #
4762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancer AWS API Documentation
4763
+ #
4764
+ class LoadBalancer < Struct.new(
4765
+ :name,
4766
+ :arn,
4767
+ :support_code,
4768
+ :created_at,
4769
+ :location,
4770
+ :resource_type,
4771
+ :dns_name,
4772
+ :state,
4773
+ :protocol,
4774
+ :public_ports,
4775
+ :health_check_path,
4776
+ :instance_port,
4777
+ :instance_health_summary,
3772
4778
  :tls_certificate_summaries,
3773
4779
  :configuration_options)
3774
4780
  include Aws::Structure
3775
4781
  end
3776
4782
 
3777
- # Describes a load balancer SSL/TLS certificate.
3778
- #
3779
- # TLS is just an updated, more secure version of Secure Socket Layer
3780
- # (SSL).
4783
+ # Describes a load balancer SSL/TLS certificate.
4784
+ #
4785
+ # TLS is just an updated, more secure version of Secure Socket Layer
4786
+ # (SSL).
4787
+ #
4788
+ # @!attribute [rw] name
4789
+ # The name of the SSL/TLS certificate (e.g., `my-certificate`).
4790
+ # @return [String]
4791
+ #
4792
+ # @!attribute [rw] arn
4793
+ # The Amazon Resource Name (ARN) of the SSL/TLS certificate.
4794
+ # @return [String]
4795
+ #
4796
+ # @!attribute [rw] support_code
4797
+ # The support code. Include this code in your email to support when
4798
+ # you have questions about your Lightsail load balancer or SSL/TLS
4799
+ # certificate. This code enables our support team to look up your
4800
+ # Lightsail information more easily.
4801
+ # @return [String]
4802
+ #
4803
+ # @!attribute [rw] created_at
4804
+ # The time when you created your SSL/TLS certificate.
4805
+ # @return [Time]
4806
+ #
4807
+ # @!attribute [rw] location
4808
+ # The AWS Region and Availability Zone where you created your
4809
+ # certificate.
4810
+ # @return [Types::ResourceLocation]
4811
+ #
4812
+ # @!attribute [rw] resource_type
4813
+ # The resource type (e.g., `LoadBalancerTlsCertificate`).
4814
+ #
4815
+ # * <b> <code>Instance</code> </b> - A Lightsail instance (a virtual
4816
+ # private server)
4817
+ #
4818
+ # * <b> <code>StaticIp</code> </b> - A static IP address
4819
+ #
4820
+ # * <b> <code>KeyPair</code> </b> - The key pair used to connect to a
4821
+ # Lightsail instance
4822
+ #
4823
+ # * <b> <code>InstanceSnapshot</code> </b> - A Lightsail instance
4824
+ # snapshot
4825
+ #
4826
+ # * <b> <code>Domain</code> </b> - A DNS zone
4827
+ #
4828
+ # * <b> <code>PeeredVpc</code> </b> - A peered VPC
4829
+ #
4830
+ # * <b> <code>LoadBalancer</code> </b> - A Lightsail load balancer
4831
+ #
4832
+ # * <b> <code>LoadBalancerTlsCertificate</code> </b> - An SSL/TLS
4833
+ # certificate associated with a Lightsail load balancer
4834
+ #
4835
+ # * <b> <code>Disk</code> </b> - A Lightsail block storage disk
4836
+ #
4837
+ # * <b> <code>DiskSnapshot</code> </b> - A block storage disk snapshot
4838
+ # @return [String]
4839
+ #
4840
+ # @!attribute [rw] load_balancer_name
4841
+ # The load balancer name where your SSL/TLS certificate is attached.
4842
+ # @return [String]
4843
+ #
4844
+ # @!attribute [rw] is_attached
4845
+ # When `true`, the SSL/TLS certificate is attached to the Lightsail
4846
+ # load balancer.
4847
+ # @return [Boolean]
4848
+ #
4849
+ # @!attribute [rw] status
4850
+ # The status of the SSL/TLS certificate. Valid values are below.
4851
+ # @return [String]
4852
+ #
4853
+ # @!attribute [rw] domain_name
4854
+ # The domain name for your SSL/TLS certificate.
4855
+ # @return [String]
4856
+ #
4857
+ # @!attribute [rw] domain_validation_records
4858
+ # An array of LoadBalancerTlsCertificateDomainValidationRecord objects
4859
+ # describing the records.
4860
+ # @return [Array<Types::LoadBalancerTlsCertificateDomainValidationRecord>]
4861
+ #
4862
+ # @!attribute [rw] failure_reason
4863
+ # The reason for the SSL/TLS certificate validation failure.
4864
+ # @return [String]
4865
+ #
4866
+ # @!attribute [rw] issued_at
4867
+ # The time when the SSL/TLS certificate was issued.
4868
+ # @return [Time]
4869
+ #
4870
+ # @!attribute [rw] issuer
4871
+ # The issuer of the certificate.
4872
+ # @return [String]
4873
+ #
4874
+ # @!attribute [rw] key_algorithm
4875
+ # The algorithm that was used to generate the key pair (the public and
4876
+ # private key).
4877
+ # @return [String]
4878
+ #
4879
+ # @!attribute [rw] not_after
4880
+ # The timestamp when the SSL/TLS certificate expires.
4881
+ # @return [Time]
4882
+ #
4883
+ # @!attribute [rw] not_before
4884
+ # The timestamp when the SSL/TLS certificate is first valid.
4885
+ # @return [Time]
4886
+ #
4887
+ # @!attribute [rw] renewal_summary
4888
+ # An object containing information about the status of Lightsail's
4889
+ # managed renewal for the certificate.
4890
+ # @return [Types::LoadBalancerTlsCertificateRenewalSummary]
4891
+ #
4892
+ # @!attribute [rw] revocation_reason
4893
+ # The reason the certificate was revoked. Valid values are below.
4894
+ # @return [String]
4895
+ #
4896
+ # @!attribute [rw] revoked_at
4897
+ # The timestamp when the SSL/TLS certificate was revoked.
4898
+ # @return [Time]
4899
+ #
4900
+ # @!attribute [rw] serial
4901
+ # The serial number of the certificate.
4902
+ # @return [String]
4903
+ #
4904
+ # @!attribute [rw] signature_algorithm
4905
+ # The algorithm that was used to sign the certificate.
4906
+ # @return [String]
4907
+ #
4908
+ # @!attribute [rw] subject
4909
+ # The name of the entity that is associated with the public key
4910
+ # contained in the certificate.
4911
+ # @return [String]
4912
+ #
4913
+ # @!attribute [rw] subject_alternative_names
4914
+ # One or more domains or subdomains included in the certificate. This
4915
+ # list contains the domain names that are bound to the public key that
4916
+ # is contained in the certificate. The subject alternative names
4917
+ # include the canonical domain name (CNAME) of the certificate and
4918
+ # additional domain names that can be used to connect to the website,
4919
+ # such as `example.com`, `www.example.com`, or `m.example.com`.
4920
+ # @return [Array<String>]
4921
+ #
4922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificate AWS API Documentation
4923
+ #
4924
+ class LoadBalancerTlsCertificate < Struct.new(
4925
+ :name,
4926
+ :arn,
4927
+ :support_code,
4928
+ :created_at,
4929
+ :location,
4930
+ :resource_type,
4931
+ :load_balancer_name,
4932
+ :is_attached,
4933
+ :status,
4934
+ :domain_name,
4935
+ :domain_validation_records,
4936
+ :failure_reason,
4937
+ :issued_at,
4938
+ :issuer,
4939
+ :key_algorithm,
4940
+ :not_after,
4941
+ :not_before,
4942
+ :renewal_summary,
4943
+ :revocation_reason,
4944
+ :revoked_at,
4945
+ :serial,
4946
+ :signature_algorithm,
4947
+ :subject,
4948
+ :subject_alternative_names)
4949
+ include Aws::Structure
4950
+ end
4951
+
4952
+ # Contains information about the domain names on an SSL/TLS certificate
4953
+ # that you will use to validate domain ownership.
4954
+ #
4955
+ # @!attribute [rw] domain_name
4956
+ # The fully qualified domain name in the certificate request.
4957
+ # @return [String]
4958
+ #
4959
+ # @!attribute [rw] validation_status
4960
+ # The status of the domain validation. Valid values are listed below.
4961
+ # @return [String]
4962
+ #
4963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateDomainValidationOption AWS API Documentation
4964
+ #
4965
+ class LoadBalancerTlsCertificateDomainValidationOption < Struct.new(
4966
+ :domain_name,
4967
+ :validation_status)
4968
+ include Aws::Structure
4969
+ end
4970
+
4971
+ # Describes the validation record of each domain name in the SSL/TLS
4972
+ # certificate.
4973
+ #
4974
+ # @!attribute [rw] name
4975
+ # A fully qualified domain name in the certificate. For example,
4976
+ # `example.com`.
4977
+ # @return [String]
4978
+ #
4979
+ # @!attribute [rw] type
4980
+ # The type of validation record. For example, `CNAME` for domain
4981
+ # validation.
4982
+ # @return [String]
4983
+ #
4984
+ # @!attribute [rw] value
4985
+ # The value for that type.
4986
+ # @return [String]
4987
+ #
4988
+ # @!attribute [rw] validation_status
4989
+ # The validation status. Valid values are listed below.
4990
+ # @return [String]
4991
+ #
4992
+ # @!attribute [rw] domain_name
4993
+ # The domain name against which your SSL/TLS certificate was
4994
+ # validated.
4995
+ # @return [String]
4996
+ #
4997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateDomainValidationRecord AWS API Documentation
4998
+ #
4999
+ class LoadBalancerTlsCertificateDomainValidationRecord < Struct.new(
5000
+ :name,
5001
+ :type,
5002
+ :value,
5003
+ :validation_status,
5004
+ :domain_name)
5005
+ include Aws::Structure
5006
+ end
5007
+
5008
+ # Contains information about the status of Lightsail's managed renewal
5009
+ # for the certificate.
5010
+ #
5011
+ # @!attribute [rw] renewal_status
5012
+ # The status of Lightsail's managed renewal of the certificate. Valid
5013
+ # values are listed below.
5014
+ # @return [String]
5015
+ #
5016
+ # @!attribute [rw] domain_validation_options
5017
+ # Contains information about the validation of each domain name in the
5018
+ # certificate, as it pertains to Lightsail's managed renewal. This is
5019
+ # different from the initial validation that occurs as a result of the
5020
+ # RequestCertificate request.
5021
+ # @return [Array<Types::LoadBalancerTlsCertificateDomainValidationOption>]
5022
+ #
5023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateRenewalSummary AWS API Documentation
5024
+ #
5025
+ class LoadBalancerTlsCertificateRenewalSummary < Struct.new(
5026
+ :renewal_status,
5027
+ :domain_validation_options)
5028
+ include Aws::Structure
5029
+ end
5030
+
5031
+ # Provides a summary of SSL/TLS certificate metadata.
3781
5032
  #
3782
5033
  # @!attribute [rw] name
3783
- # The name of the SSL/TLS certificate (e.g., `my-certificate`).
5034
+ # The name of the SSL/TLS certificate.
3784
5035
  # @return [String]
3785
5036
  #
3786
- # @!attribute [rw] arn
3787
- # The Amazon Resource Name (ARN) of the SSL/TLS certificate.
3788
- # @return [String]
5037
+ # @!attribute [rw] is_attached
5038
+ # When `true`, the SSL/TLS certificate is attached to the Lightsail
5039
+ # load balancer.
5040
+ # @return [Boolean]
3789
5041
  #
3790
- # @!attribute [rw] support_code
3791
- # The support code. Include this code in your email to support when
3792
- # you have questions about your Lightsail load balancer or SSL/TLS
3793
- # certificate. This code enables our support team to look up your
3794
- # Lightsail information more easily.
3795
- # @return [String]
5042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateSummary AWS API Documentation
5043
+ #
5044
+ class LoadBalancerTlsCertificateSummary < Struct.new(
5045
+ :name,
5046
+ :is_attached)
5047
+ include Aws::Structure
5048
+ end
5049
+
5050
+ # Describes a database log event.
3796
5051
  #
3797
5052
  # @!attribute [rw] created_at
3798
- # The time when you created your SSL/TLS certificate.
5053
+ # The timestamp when the database log event was created.
3799
5054
  # @return [Time]
3800
5055
  #
3801
- # @!attribute [rw] location
3802
- # The AWS Region and Availability Zone where you created your
3803
- # certificate.
3804
- # @return [Types::ResourceLocation]
5056
+ # @!attribute [rw] message
5057
+ # The message of the database log event.
5058
+ # @return [String]
3805
5059
  #
3806
- # @!attribute [rw] resource_type
3807
- # The resource type (e.g., `LoadBalancerTlsCertificate`).
5060
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LogEvent AWS API Documentation
3808
5061
  #
3809
- # * <b> <code>Instance</code> </b> - A Lightsail instance (a virtual
3810
- # private server)
5062
+ class LogEvent < Struct.new(
5063
+ :created_at,
5064
+ :message)
5065
+ include Aws::Structure
5066
+ end
5067
+
5068
+ # Describes the metric data point.
3811
5069
  #
3812
- # * <b> <code>StaticIp</code> </b> - A static IP address
5070
+ # @!attribute [rw] average
5071
+ # The average.
5072
+ # @return [Float]
3813
5073
  #
3814
- # * <b> <code>KeyPair</code> </b> - The key pair used to connect to a
3815
- # Lightsail instance
5074
+ # @!attribute [rw] maximum
5075
+ # The maximum.
5076
+ # @return [Float]
3816
5077
  #
3817
- # * <b> <code>InstanceSnapshot</code> </b> - A Lightsail instance
3818
- # snapshot
5078
+ # @!attribute [rw] minimum
5079
+ # The minimum.
5080
+ # @return [Float]
3819
5081
  #
3820
- # * <b> <code>Domain</code> </b> - A DNS zone
5082
+ # @!attribute [rw] sample_count
5083
+ # The sample count.
5084
+ # @return [Float]
3821
5085
  #
3822
- # * <b> <code>PeeredVpc</code> </b> - A peered VPC
5086
+ # @!attribute [rw] sum
5087
+ # The sum.
5088
+ # @return [Float]
3823
5089
  #
3824
- # * <b> <code>LoadBalancer</code> </b> - A Lightsail load balancer
5090
+ # @!attribute [rw] timestamp
5091
+ # The timestamp (e.g., `1479816991.349`).
5092
+ # @return [Time]
3825
5093
  #
3826
- # * <b> <code>LoadBalancerTlsCertificate</code> </b> - An SSL/TLS
3827
- # certificate associated with a Lightsail load balancer
5094
+ # @!attribute [rw] unit
5095
+ # The unit.
5096
+ # @return [String]
3828
5097
  #
3829
- # * <b> <code>Disk</code> </b> - A Lightsail block storage disk
5098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/MetricDatapoint AWS API Documentation
3830
5099
  #
3831
- # * <b> <code>DiskSnapshot</code> </b> - A block storage disk snapshot
5100
+ class MetricDatapoint < Struct.new(
5101
+ :average,
5102
+ :maximum,
5103
+ :minimum,
5104
+ :sample_count,
5105
+ :sum,
5106
+ :timestamp,
5107
+ :unit)
5108
+ include Aws::Structure
5109
+ end
5110
+
5111
+ # Describes the monthly data transfer in and out of your virtual private
5112
+ # server (or *instance*).
5113
+ #
5114
+ # @!attribute [rw] gb_per_month_allocated
5115
+ # The amount allocated per month (in GB).
5116
+ # @return [Integer]
5117
+ #
5118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/MonthlyTransfer AWS API Documentation
5119
+ #
5120
+ class MonthlyTransfer < Struct.new(
5121
+ :gb_per_month_allocated)
5122
+ include Aws::Structure
5123
+ end
5124
+
5125
+ # @note When making an API call, you may pass OpenInstancePublicPortsRequest
5126
+ # data as a hash:
5127
+ #
5128
+ # {
5129
+ # port_info: { # required
5130
+ # from_port: 1,
5131
+ # to_port: 1,
5132
+ # protocol: "tcp", # accepts tcp, all, udp
5133
+ # },
5134
+ # instance_name: "ResourceName", # required
5135
+ # }
5136
+ #
5137
+ # @!attribute [rw] port_info
5138
+ # An array of key-value pairs containing information about the port
5139
+ # mappings.
5140
+ # @return [Types::PortInfo]
5141
+ #
5142
+ # @!attribute [rw] instance_name
5143
+ # The name of the instance for which you want to open the public
5144
+ # ports.
3832
5145
  # @return [String]
3833
5146
  #
3834
- # @!attribute [rw] load_balancer_name
3835
- # The load balancer name where your SSL/TLS certificate is attached.
5147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPortsRequest AWS API Documentation
5148
+ #
5149
+ class OpenInstancePublicPortsRequest < Struct.new(
5150
+ :port_info,
5151
+ :instance_name)
5152
+ include Aws::Structure
5153
+ end
5154
+
5155
+ # @!attribute [rw] operation
5156
+ # An array of key-value pairs containing information about the request
5157
+ # operation.
5158
+ # @return [Types::Operation]
5159
+ #
5160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPortsResult AWS API Documentation
5161
+ #
5162
+ class OpenInstancePublicPortsResult < Struct.new(
5163
+ :operation)
5164
+ include Aws::Structure
5165
+ end
5166
+
5167
+ # Describes the API operation.
5168
+ #
5169
+ # @!attribute [rw] id
5170
+ # The ID of the operation.
3836
5171
  # @return [String]
3837
5172
  #
3838
- # @!attribute [rw] is_attached
3839
- # When `true`, the SSL/TLS certificate is attached to the Lightsail
3840
- # load balancer.
3841
- # @return [Boolean]
5173
+ # @!attribute [rw] resource_name
5174
+ # The resource name.
5175
+ # @return [String]
3842
5176
  #
3843
- # @!attribute [rw] status
3844
- # The status of the SSL/TLS certificate. Valid values are below.
5177
+ # @!attribute [rw] resource_type
5178
+ # The resource type.
3845
5179
  # @return [String]
3846
5180
  #
3847
- # @!attribute [rw] domain_name
3848
- # The domain name for your SSL/TLS certificate.
5181
+ # @!attribute [rw] created_at
5182
+ # The timestamp when the operation was initialized (e.g.,
5183
+ # `1479816991.349`).
5184
+ # @return [Time]
5185
+ #
5186
+ # @!attribute [rw] location
5187
+ # The region and Availability Zone.
5188
+ # @return [Types::ResourceLocation]
5189
+ #
5190
+ # @!attribute [rw] is_terminal
5191
+ # A Boolean value indicating whether the operation is terminal.
5192
+ # @return [Boolean]
5193
+ #
5194
+ # @!attribute [rw] operation_details
5195
+ # Details about the operation (e.g., `Debian-1GB-Ohio-1`).
3849
5196
  # @return [String]
3850
5197
  #
3851
- # @!attribute [rw] domain_validation_records
3852
- # An array of LoadBalancerTlsCertificateDomainValidationRecord objects
3853
- # describing the records.
3854
- # @return [Array<Types::LoadBalancerTlsCertificateDomainValidationRecord>]
5198
+ # @!attribute [rw] operation_type
5199
+ # The type of operation.
5200
+ # @return [String]
3855
5201
  #
3856
- # @!attribute [rw] failure_reason
3857
- # The reason for the SSL/TLS certificate validation failure.
5202
+ # @!attribute [rw] status
5203
+ # The status of the operation.
3858
5204
  # @return [String]
3859
5205
  #
3860
- # @!attribute [rw] issued_at
3861
- # The time when the SSL/TLS certificate was issued.
5206
+ # @!attribute [rw] status_changed_at
5207
+ # The timestamp when the status was changed (e.g., `1479816991.349`).
3862
5208
  # @return [Time]
3863
5209
  #
3864
- # @!attribute [rw] issuer
3865
- # The issuer of the certificate.
5210
+ # @!attribute [rw] error_code
5211
+ # The error code.
5212
+ # @return [String]
5213
+ #
5214
+ # @!attribute [rw] error_details
5215
+ # The error details.
5216
+ # @return [String]
5217
+ #
5218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Operation AWS API Documentation
5219
+ #
5220
+ class Operation < Struct.new(
5221
+ :id,
5222
+ :resource_name,
5223
+ :resource_type,
5224
+ :created_at,
5225
+ :location,
5226
+ :is_terminal,
5227
+ :operation_details,
5228
+ :operation_type,
5229
+ :status,
5230
+ :status_changed_at,
5231
+ :error_code,
5232
+ :error_details)
5233
+ include Aws::Structure
5234
+ end
5235
+
5236
+ # The password data for the Windows Server-based instance, including the
5237
+ # ciphertext and the key pair name.
5238
+ #
5239
+ # @!attribute [rw] ciphertext
5240
+ # The encrypted password. Ciphertext will be an empty string if access
5241
+ # to your new instance is not ready yet. When you create an instance,
5242
+ # it can take up to 15 minutes for the instance to be ready.
5243
+ #
5244
+ # <note markdown="1"> If you use the default key pair (`LightsailDefaultKeyPair`), the
5245
+ # decrypted password will be available in the password field.
5246
+ #
5247
+ # If you are using a custom key pair, you need to use your own means
5248
+ # of decryption.
5249
+ #
5250
+ # If you change the Administrator password on the instance, Lightsail
5251
+ # will continue to return the original ciphertext value. When
5252
+ # accessing the instance using RDP, you need to manually enter the
5253
+ # Administrator password after changing it from the default.
5254
+ #
5255
+ # </note>
3866
5256
  # @return [String]
3867
5257
  #
3868
- # @!attribute [rw] key_algorithm
3869
- # The algorithm that was used to generate the key pair (the public and
3870
- # private key).
5258
+ # @!attribute [rw] key_pair_name
5259
+ # The name of the key pair that you used when creating your instance.
5260
+ # If no key pair name was specified when creating the instance,
5261
+ # Lightsail uses the default key pair (`LightsailDefaultKeyPair`).
5262
+ #
5263
+ # If you are using a custom key pair, you need to use your own means
5264
+ # of decrypting your password using the `ciphertext`. Lightsail
5265
+ # creates the ciphertext by encrypting your password with the public
5266
+ # key part of this key pair.
3871
5267
  # @return [String]
3872
5268
  #
3873
- # @!attribute [rw] not_after
3874
- # The timestamp when the SSL/TLS certificate expires.
3875
- # @return [Time]
5269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PasswordData AWS API Documentation
3876
5270
  #
3877
- # @!attribute [rw] not_before
3878
- # The timestamp when the SSL/TLS certificate is first valid.
3879
- # @return [Time]
5271
+ class PasswordData < Struct.new(
5272
+ :ciphertext,
5273
+ :key_pair_name)
5274
+ include Aws::Structure
5275
+ end
5276
+
5277
+ # @api private
3880
5278
  #
3881
- # @!attribute [rw] renewal_summary
3882
- # An object containing information about the status of Lightsail's
3883
- # managed renewal for the certificate.
3884
- # @return [Types::LoadBalancerTlsCertificateRenewalSummary]
5279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpcRequest AWS API Documentation
3885
5280
  #
3886
- # @!attribute [rw] revocation_reason
3887
- # The reason the certificate was revoked. Valid values are below.
3888
- # @return [String]
5281
+ class PeerVpcRequest < Aws::EmptyStructure; end
5282
+
5283
+ # @!attribute [rw] operation
5284
+ # An array of key-value pairs containing information about the request
5285
+ # operation.
5286
+ # @return [Types::Operation]
3889
5287
  #
3890
- # @!attribute [rw] revoked_at
3891
- # The timestamp when the SSL/TLS certificate was revoked.
3892
- # @return [Time]
5288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpcResult AWS API Documentation
3893
5289
  #
3894
- # @!attribute [rw] serial
3895
- # The serial number of the certificate.
3896
- # @return [String]
5290
+ class PeerVpcResult < Struct.new(
5291
+ :operation)
5292
+ include Aws::Structure
5293
+ end
5294
+
5295
+ # Describes a pending database maintenance action.
3897
5296
  #
3898
- # @!attribute [rw] signature_algorithm
3899
- # The algorithm that was used to sign the certificate.
5297
+ # @!attribute [rw] action
5298
+ # The type of pending database maintenance action.
3900
5299
  # @return [String]
3901
5300
  #
3902
- # @!attribute [rw] subject
3903
- # The name of the entity that is associated with the public key
3904
- # contained in the certificate.
5301
+ # @!attribute [rw] description
5302
+ # Additional detail about the pending database maintenance action.
3905
5303
  # @return [String]
3906
5304
  #
3907
- # @!attribute [rw] subject_alternative_names
3908
- # One or more domains or subdomains included in the certificate. This
3909
- # list contains the domain names that are bound to the public key that
3910
- # is contained in the certificate. The subject alternative names
3911
- # include the canonical domain name (CNAME) of the certificate and
3912
- # additional domain names that can be used to connect to the website,
3913
- # such as `example.com`, `www.example.com`, or `m.example.com`.
3914
- # @return [Array<String>]
5305
+ # @!attribute [rw] current_apply_date
5306
+ # The effective date of the pending database maintenance action.
5307
+ # @return [Time]
3915
5308
  #
3916
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificate AWS API Documentation
5309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PendingMaintenanceAction AWS API Documentation
3917
5310
  #
3918
- class LoadBalancerTlsCertificate < Struct.new(
3919
- :name,
3920
- :arn,
3921
- :support_code,
3922
- :created_at,
3923
- :location,
3924
- :resource_type,
3925
- :load_balancer_name,
3926
- :is_attached,
3927
- :status,
3928
- :domain_name,
3929
- :domain_validation_records,
3930
- :failure_reason,
3931
- :issued_at,
3932
- :issuer,
3933
- :key_algorithm,
3934
- :not_after,
3935
- :not_before,
3936
- :renewal_summary,
3937
- :revocation_reason,
3938
- :revoked_at,
3939
- :serial,
3940
- :signature_algorithm,
3941
- :subject,
3942
- :subject_alternative_names)
5311
+ class PendingMaintenanceAction < Struct.new(
5312
+ :action,
5313
+ :description,
5314
+ :current_apply_date)
3943
5315
  include Aws::Structure
3944
5316
  end
3945
5317
 
3946
- # Contains information about the domain names on an SSL/TLS certificate
3947
- # that you will use to validate domain ownership.
5318
+ # Describes a pending database value modification.
3948
5319
  #
3949
- # @!attribute [rw] domain_name
3950
- # The fully qualified domain name in the certificate request.
5320
+ # @!attribute [rw] master_user_password
5321
+ # The password for the master user of the database.
3951
5322
  # @return [String]
3952
5323
  #
3953
- # @!attribute [rw] validation_status
3954
- # The status of the domain validation. Valid values are listed below.
5324
+ # @!attribute [rw] engine_version
5325
+ # The database engine version.
3955
5326
  # @return [String]
3956
5327
  #
3957
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateDomainValidationOption AWS API Documentation
5328
+ # @!attribute [rw] backup_retention_enabled
5329
+ # A Boolean value indicating whether automated backup retention is
5330
+ # enabled.
5331
+ # @return [Boolean]
3958
5332
  #
3959
- class LoadBalancerTlsCertificateDomainValidationOption < Struct.new(
3960
- :domain_name,
3961
- :validation_status)
5333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PendingModifiedRelationalDatabaseValues AWS API Documentation
5334
+ #
5335
+ class PendingModifiedRelationalDatabaseValues < Struct.new(
5336
+ :master_user_password,
5337
+ :engine_version,
5338
+ :backup_retention_enabled)
3962
5339
  include Aws::Structure
3963
5340
  end
3964
5341
 
3965
- # Describes the validation record of each domain name in the SSL/TLS
3966
- # certificate.
5342
+ # Describes information about the ports on your virtual private server
5343
+ # (or *instance*).
3967
5344
  #
3968
- # @!attribute [rw] name
3969
- # A fully qualified domain name in the certificate. For example,
3970
- # `example.com`.
3971
- # @return [String]
5345
+ # @note When making an API call, you may pass PortInfo
5346
+ # data as a hash:
3972
5347
  #
3973
- # @!attribute [rw] type
3974
- # The type of validation record. For example, `CNAME` for domain
3975
- # validation.
3976
- # @return [String]
5348
+ # {
5349
+ # from_port: 1,
5350
+ # to_port: 1,
5351
+ # protocol: "tcp", # accepts tcp, all, udp
5352
+ # }
3977
5353
  #
3978
- # @!attribute [rw] value
3979
- # The value for that type.
3980
- # @return [String]
5354
+ # @!attribute [rw] from_port
5355
+ # The first port in the range.
5356
+ # @return [Integer]
3981
5357
  #
3982
- # @!attribute [rw] validation_status
3983
- # The validation status. Valid values are listed below.
3984
- # @return [String]
5358
+ # @!attribute [rw] to_port
5359
+ # The last port in the range.
5360
+ # @return [Integer]
3985
5361
  #
3986
- # @!attribute [rw] domain_name
3987
- # The domain name against which your SSL/TLS certificate was
3988
- # validated.
5362
+ # @!attribute [rw] protocol
5363
+ # The protocol.
3989
5364
  # @return [String]
3990
5365
  #
3991
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateDomainValidationRecord AWS API Documentation
5366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PortInfo AWS API Documentation
3992
5367
  #
3993
- class LoadBalancerTlsCertificateDomainValidationRecord < Struct.new(
3994
- :name,
3995
- :type,
3996
- :value,
3997
- :validation_status,
3998
- :domain_name)
5368
+ class PortInfo < Struct.new(
5369
+ :from_port,
5370
+ :to_port,
5371
+ :protocol)
3999
5372
  include Aws::Structure
4000
5373
  end
4001
5374
 
4002
- # Contains information about the status of Lightsail's managed renewal
4003
- # for the certificate.
5375
+ # @note When making an API call, you may pass PutInstancePublicPortsRequest
5376
+ # data as a hash:
4004
5377
  #
4005
- # @!attribute [rw] renewal_status
4006
- # The status of Lightsail's managed renewal of the certificate. Valid
4007
- # values are listed below.
4008
- # @return [String]
5378
+ # {
5379
+ # port_infos: [ # required
5380
+ # {
5381
+ # from_port: 1,
5382
+ # to_port: 1,
5383
+ # protocol: "tcp", # accepts tcp, all, udp
5384
+ # },
5385
+ # ],
5386
+ # instance_name: "ResourceName", # required
5387
+ # }
4009
5388
  #
4010
- # @!attribute [rw] domain_validation_options
4011
- # Contains information about the validation of each domain name in the
4012
- # certificate, as it pertains to Lightsail's managed renewal. This is
4013
- # different from the initial validation that occurs as a result of the
4014
- # RequestCertificate request.
4015
- # @return [Array<Types::LoadBalancerTlsCertificateDomainValidationOption>]
5389
+ # @!attribute [rw] port_infos
5390
+ # Specifies information about the public port(s).
5391
+ # @return [Array<Types::PortInfo>]
4016
5392
  #
4017
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateRenewalSummary AWS API Documentation
5393
+ # @!attribute [rw] instance_name
5394
+ # The Lightsail instance name of the public port(s) you are setting.
5395
+ # @return [String]
4018
5396
  #
4019
- class LoadBalancerTlsCertificateRenewalSummary < Struct.new(
4020
- :renewal_status,
4021
- :domain_validation_options)
5397
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPortsRequest AWS API Documentation
5398
+ #
5399
+ class PutInstancePublicPortsRequest < Struct.new(
5400
+ :port_infos,
5401
+ :instance_name)
4022
5402
  include Aws::Structure
4023
5403
  end
4024
5404
 
4025
- # Provides a summary of SSL/TLS certificate metadata.
4026
- #
4027
- # @!attribute [rw] name
4028
- # The name of the SSL/TLS certificate.
4029
- # @return [String]
4030
- #
4031
- # @!attribute [rw] is_attached
4032
- # When `true`, the SSL/TLS certificate is attached to the Lightsail
4033
- # load balancer.
4034
- # @return [Boolean]
5405
+ # @!attribute [rw] operation
5406
+ # Describes metadata about the operation you just executed.
5407
+ # @return [Types::Operation]
4035
5408
  #
4036
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateSummary AWS API Documentation
5409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPortsResult AWS API Documentation
4037
5410
  #
4038
- class LoadBalancerTlsCertificateSummary < Struct.new(
4039
- :name,
4040
- :is_attached)
5411
+ class PutInstancePublicPortsResult < Struct.new(
5412
+ :operation)
4041
5413
  include Aws::Structure
4042
5414
  end
4043
5415
 
4044
- # Describes the metric data point.
4045
- #
4046
- # @!attribute [rw] average
4047
- # The average.
4048
- # @return [Float]
4049
- #
4050
- # @!attribute [rw] maximum
4051
- # The maximum.
4052
- # @return [Float]
4053
- #
4054
- # @!attribute [rw] minimum
4055
- # The minimum.
4056
- # @return [Float]
4057
- #
4058
- # @!attribute [rw] sample_count
4059
- # The sample count.
4060
- # @return [Float]
4061
- #
4062
- # @!attribute [rw] sum
4063
- # The sum.
4064
- # @return [Float]
5416
+ # @note When making an API call, you may pass RebootInstanceRequest
5417
+ # data as a hash:
4065
5418
  #
4066
- # @!attribute [rw] timestamp
4067
- # The timestamp (e.g., `1479816991.349`).
4068
- # @return [Time]
5419
+ # {
5420
+ # instance_name: "ResourceName", # required
5421
+ # }
4069
5422
  #
4070
- # @!attribute [rw] unit
4071
- # The unit.
5423
+ # @!attribute [rw] instance_name
5424
+ # The name of the instance to reboot.
4072
5425
  # @return [String]
4073
5426
  #
4074
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/MetricDatapoint AWS API Documentation
5427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstanceRequest AWS API Documentation
4075
5428
  #
4076
- class MetricDatapoint < Struct.new(
4077
- :average,
4078
- :maximum,
4079
- :minimum,
4080
- :sample_count,
4081
- :sum,
4082
- :timestamp,
4083
- :unit)
5429
+ class RebootInstanceRequest < Struct.new(
5430
+ :instance_name)
4084
5431
  include Aws::Structure
4085
5432
  end
4086
5433
 
4087
- # Describes the monthly data transfer in and out of your virtual private
4088
- # server (or *instance*).
4089
- #
4090
- # @!attribute [rw] gb_per_month_allocated
4091
- # The amount allocated per month (in GB).
4092
- # @return [Integer]
5434
+ # @!attribute [rw] operations
5435
+ # An array of key-value pairs containing information about the request
5436
+ # operations.
5437
+ # @return [Array<Types::Operation>]
4093
5438
  #
4094
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/MonthlyTransfer AWS API Documentation
5439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstanceResult AWS API Documentation
4095
5440
  #
4096
- class MonthlyTransfer < Struct.new(
4097
- :gb_per_month_allocated)
5441
+ class RebootInstanceResult < Struct.new(
5442
+ :operations)
4098
5443
  include Aws::Structure
4099
5444
  end
4100
5445
 
4101
- # @note When making an API call, you may pass OpenInstancePublicPortsRequest
5446
+ # @note When making an API call, you may pass RebootRelationalDatabaseRequest
4102
5447
  # data as a hash:
4103
5448
  #
4104
5449
  # {
4105
- # port_info: { # required
4106
- # from_port: 1,
4107
- # to_port: 1,
4108
- # protocol: "tcp", # accepts tcp, all, udp
4109
- # },
4110
- # instance_name: "ResourceName", # required
5450
+ # relational_database_name: "ResourceName", # required
4111
5451
  # }
4112
5452
  #
4113
- # @!attribute [rw] port_info
4114
- # An array of key-value pairs containing information about the port
4115
- # mappings.
4116
- # @return [Types::PortInfo]
4117
- #
4118
- # @!attribute [rw] instance_name
4119
- # The name of the instance for which you want to open the public
4120
- # ports.
5453
+ # @!attribute [rw] relational_database_name
5454
+ # The name of your database to reboot.
4121
5455
  # @return [String]
4122
5456
  #
4123
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPortsRequest AWS API Documentation
5457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabaseRequest AWS API Documentation
4124
5458
  #
4125
- class OpenInstancePublicPortsRequest < Struct.new(
4126
- :port_info,
4127
- :instance_name)
5459
+ class RebootRelationalDatabaseRequest < Struct.new(
5460
+ :relational_database_name)
4128
5461
  include Aws::Structure
4129
5462
  end
4130
5463
 
4131
- # @!attribute [rw] operation
4132
- # An array of key-value pairs containing information about the request
4133
- # operation.
4134
- # @return [Types::Operation]
5464
+ # @!attribute [rw] operations
5465
+ # An object describing the result of your reboot relational database
5466
+ # request.
5467
+ # @return [Array<Types::Operation>]
4135
5468
  #
4136
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/OpenInstancePublicPortsResult AWS API Documentation
5469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootRelationalDatabaseResult AWS API Documentation
4137
5470
  #
4138
- class OpenInstancePublicPortsResult < Struct.new(
4139
- :operation)
5471
+ class RebootRelationalDatabaseResult < Struct.new(
5472
+ :operations)
4140
5473
  include Aws::Structure
4141
5474
  end
4142
5475
 
4143
- # Describes the API operation.
5476
+ # Describes the AWS Region.
4144
5477
  #
4145
- # @!attribute [rw] id
4146
- # The ID of the operation.
5478
+ # @!attribute [rw] continent_code
5479
+ # The continent code (e.g., `NA`, meaning North America).
4147
5480
  # @return [String]
4148
5481
  #
4149
- # @!attribute [rw] resource_name
4150
- # The resource name.
5482
+ # @!attribute [rw] description
5483
+ # The description of the AWS Region (e.g., `This region is recommended
5484
+ # to serve users in the eastern United States and eastern Canada`).
4151
5485
  # @return [String]
4152
5486
  #
4153
- # @!attribute [rw] resource_type
4154
- # The resource type.
5487
+ # @!attribute [rw] display_name
5488
+ # The display name (e.g., `Ohio`).
5489
+ # @return [String]
5490
+ #
5491
+ # @!attribute [rw] name
5492
+ # The region name (e.g., `us-east-2`).
5493
+ # @return [String]
5494
+ #
5495
+ # @!attribute [rw] availability_zones
5496
+ # The Availability Zones. Follows the format `us-east-2a`
5497
+ # (case-sensitive).
5498
+ # @return [Array<Types::AvailabilityZone>]
5499
+ #
5500
+ # @!attribute [rw] relational_database_availability_zones
5501
+ # The Availability Zones for databases. Follows the format
5502
+ # `us-east-2a` (case-sensitive).
5503
+ # @return [Array<Types::AvailabilityZone>]
5504
+ #
5505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Region AWS API Documentation
5506
+ #
5507
+ class Region < Struct.new(
5508
+ :continent_code,
5509
+ :description,
5510
+ :display_name,
5511
+ :name,
5512
+ :availability_zones,
5513
+ :relational_database_availability_zones)
5514
+ include Aws::Structure
5515
+ end
5516
+
5517
+ # Describes a database.
5518
+ #
5519
+ # @!attribute [rw] name
5520
+ # The unique name of the database resource in Lightsail.
5521
+ # @return [String]
5522
+ #
5523
+ # @!attribute [rw] arn
5524
+ # The Amazon Resource Name (ARN) of the database.
5525
+ # @return [String]
5526
+ #
5527
+ # @!attribute [rw] support_code
5528
+ # The support code for the database. Include this code in your email
5529
+ # to support when you have questions about a database in Lightsail.
5530
+ # This code enables our support team to look up your Lightsail
5531
+ # information more easily.
4155
5532
  # @return [String]
4156
5533
  #
4157
5534
  # @!attribute [rw] created_at
4158
- # The timestamp when the operation was initialized (e.g.,
4159
- # `1479816991.349`).
5535
+ # The timestamp when the database was created. Formatted in Unix time.
4160
5536
  # @return [Time]
4161
5537
  #
4162
5538
  # @!attribute [rw] location
4163
- # The region and Availability Zone.
5539
+ # The Region name and Availability Zone where the database is located.
4164
5540
  # @return [Types::ResourceLocation]
4165
5541
  #
4166
- # @!attribute [rw] is_terminal
4167
- # A Boolean value indicating whether the operation is terminal.
4168
- # @return [Boolean]
5542
+ # @!attribute [rw] resource_type
5543
+ # The Lightsail resource type for the database (for example,
5544
+ # `RelationalDatabase`).
5545
+ # @return [String]
4169
5546
  #
4170
- # @!attribute [rw] operation_details
4171
- # Details about the operation (e.g., `Debian-1GB-Ohio-1`).
5547
+ # @!attribute [rw] relational_database_blueprint_id
5548
+ # The blueprint ID for the database. A blueprint describes the major
5549
+ # engine version of a database.
4172
5550
  # @return [String]
4173
5551
  #
4174
- # @!attribute [rw] operation_type
4175
- # The type of operation.
5552
+ # @!attribute [rw] relational_database_bundle_id
5553
+ # The bundle ID for the database. A bundle describes the performance
5554
+ # specifications for your database.
4176
5555
  # @return [String]
4177
5556
  #
4178
- # @!attribute [rw] status
4179
- # The status of the operation.
5557
+ # @!attribute [rw] master_database_name
5558
+ # The name of the master database created when the Lightsail database
5559
+ # resource is created.
4180
5560
  # @return [String]
4181
5561
  #
4182
- # @!attribute [rw] status_changed_at
4183
- # The timestamp when the status was changed (e.g., `1479816991.349`).
5562
+ # @!attribute [rw] hardware
5563
+ # Describes the hardware of the database.
5564
+ # @return [Types::RelationalDatabaseHardware]
5565
+ #
5566
+ # @!attribute [rw] state
5567
+ # Describes the current state of the database.
5568
+ # @return [String]
5569
+ #
5570
+ # @!attribute [rw] secondary_availability_zone
5571
+ # Describes the secondary Availability Zone of a high availability
5572
+ # database.
5573
+ #
5574
+ # The secondary database is used for failover support of a high
5575
+ # availability database.
5576
+ # @return [String]
5577
+ #
5578
+ # @!attribute [rw] backup_retention_enabled
5579
+ # A Boolean value indicating whether automated backup retention is
5580
+ # enabled for the database.
5581
+ # @return [Boolean]
5582
+ #
5583
+ # @!attribute [rw] pending_modified_values
5584
+ # Describes pending database value modifications.
5585
+ # @return [Types::PendingModifiedRelationalDatabaseValues]
5586
+ #
5587
+ # @!attribute [rw] engine
5588
+ # The database software (for example, `MySQL`).
5589
+ # @return [String]
5590
+ #
5591
+ # @!attribute [rw] engine_version
5592
+ # The database engine version (for example, `5.7.23`).
5593
+ # @return [String]
5594
+ #
5595
+ # @!attribute [rw] latest_restorable_time
5596
+ # The latest point in time to which the database can be restored.
5597
+ # Formatted in Unix time.
4184
5598
  # @return [Time]
4185
5599
  #
4186
- # @!attribute [rw] error_code
4187
- # The error code.
5600
+ # @!attribute [rw] master_username
5601
+ # The master user name of the database.
4188
5602
  # @return [String]
4189
5603
  #
4190
- # @!attribute [rw] error_details
4191
- # The error details.
5604
+ # @!attribute [rw] parameter_apply_status
5605
+ # The status of parameter updates for the database.
4192
5606
  # @return [String]
4193
5607
  #
4194
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Operation AWS API Documentation
5608
+ # @!attribute [rw] preferred_backup_window
5609
+ # The daily time range during which automated backups are created for
5610
+ # the database (for example, `16:00-16:30`).
5611
+ # @return [String]
4195
5612
  #
4196
- class Operation < Struct.new(
4197
- :id,
4198
- :resource_name,
4199
- :resource_type,
5613
+ # @!attribute [rw] preferred_maintenance_window
5614
+ # The weekly time range during which system maintenance can occur on
5615
+ # the database.
5616
+ #
5617
+ # In the format `ddd:hh24:mi-ddd:hh24:mi`. For example,
5618
+ # `Tue:17:00-Tue:17:30`.
5619
+ # @return [String]
5620
+ #
5621
+ # @!attribute [rw] publicly_accessible
5622
+ # A Boolean value indicating whether the database is publicly
5623
+ # accessible.
5624
+ # @return [Boolean]
5625
+ #
5626
+ # @!attribute [rw] master_endpoint
5627
+ # The master endpoint for the database.
5628
+ # @return [Types::RelationalDatabaseEndpoint]
5629
+ #
5630
+ # @!attribute [rw] pending_maintenance_actions
5631
+ # Describes the pending maintenance actions for the database.
5632
+ # @return [Array<Types::PendingMaintenanceAction>]
5633
+ #
5634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabase AWS API Documentation
5635
+ #
5636
+ class RelationalDatabase < Struct.new(
5637
+ :name,
5638
+ :arn,
5639
+ :support_code,
4200
5640
  :created_at,
4201
5641
  :location,
4202
- :is_terminal,
4203
- :operation_details,
4204
- :operation_type,
4205
- :status,
4206
- :status_changed_at,
4207
- :error_code,
4208
- :error_details)
5642
+ :resource_type,
5643
+ :relational_database_blueprint_id,
5644
+ :relational_database_bundle_id,
5645
+ :master_database_name,
5646
+ :hardware,
5647
+ :state,
5648
+ :secondary_availability_zone,
5649
+ :backup_retention_enabled,
5650
+ :pending_modified_values,
5651
+ :engine,
5652
+ :engine_version,
5653
+ :latest_restorable_time,
5654
+ :master_username,
5655
+ :parameter_apply_status,
5656
+ :preferred_backup_window,
5657
+ :preferred_maintenance_window,
5658
+ :publicly_accessible,
5659
+ :master_endpoint,
5660
+ :pending_maintenance_actions)
4209
5661
  include Aws::Structure
4210
5662
  end
4211
5663
 
4212
- # The password data for the Windows Server-based instance, including the
4213
- # ciphertext and the key pair name.
5664
+ # Describes a database image, or blueprint. A blueprint describes the
5665
+ # major engine version of a database.
4214
5666
  #
4215
- # @!attribute [rw] ciphertext
4216
- # The encrypted password. Ciphertext will be an empty string if access
4217
- # to your new instance is not ready yet. When you create an instance,
4218
- # it can take up to 15 minutes for the instance to be ready.
5667
+ # @!attribute [rw] blueprint_id
5668
+ # The ID for the database blueprint.
5669
+ # @return [String]
4219
5670
  #
4220
- # <note markdown="1"> If you use the default key pair (`LightsailDefaultKeyPair`), the
4221
- # decrypted password will be available in the password field.
5671
+ # @!attribute [rw] engine
5672
+ # The database software of the database blueprint (for example,
5673
+ # `MySQL`).
5674
+ # @return [String]
4222
5675
  #
4223
- # If you are using a custom key pair, you need to use your own means
4224
- # of decryption.
5676
+ # @!attribute [rw] engine_version
5677
+ # The database engine version for the database blueprint (for example,
5678
+ # `5.7.23`).
5679
+ # @return [String]
4225
5680
  #
4226
- # If you change the Administrator password on the instance, Lightsail
4227
- # will continue to return the original ciphertext value. When
4228
- # accessing the instance using RDP, you need to manually enter the
4229
- # Administrator password after changing it from the default.
5681
+ # @!attribute [rw] engine_description
5682
+ # The description of the database engine for the database blueprint.
5683
+ # @return [String]
4230
5684
  #
4231
- # </note>
5685
+ # @!attribute [rw] engine_version_description
5686
+ # The description of the database engine version for the database
5687
+ # blueprint.
4232
5688
  # @return [String]
4233
5689
  #
4234
- # @!attribute [rw] key_pair_name
4235
- # The name of the key pair that you used when creating your instance.
4236
- # If no key pair name was specified when creating the instance,
4237
- # Lightsail uses the default key pair (`LightsailDefaultKeyPair`).
5690
+ # @!attribute [rw] is_engine_default
5691
+ # A Boolean value indicating whether the engine version is the default
5692
+ # for the database blueprint.
5693
+ # @return [Boolean]
4238
5694
  #
4239
- # If you are using a custom key pair, you need to use your own means
4240
- # of decrypting your password using the `ciphertext`. Lightsail
4241
- # creates the ciphertext by encrypting your password with the public
4242
- # key part of this key pair.
5695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseBlueprint AWS API Documentation
5696
+ #
5697
+ class RelationalDatabaseBlueprint < Struct.new(
5698
+ :blueprint_id,
5699
+ :engine,
5700
+ :engine_version,
5701
+ :engine_description,
5702
+ :engine_version_description,
5703
+ :is_engine_default)
5704
+ include Aws::Structure
5705
+ end
5706
+
5707
+ # Describes a database bundle. A bundle describes the performance
5708
+ # specifications of the database.
5709
+ #
5710
+ # @!attribute [rw] bundle_id
5711
+ # The ID for the database bundle.
4243
5712
  # @return [String]
4244
5713
  #
4245
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PasswordData AWS API Documentation
5714
+ # @!attribute [rw] name
5715
+ # The name for the database bundle.
5716
+ # @return [String]
4246
5717
  #
4247
- class PasswordData < Struct.new(
4248
- :ciphertext,
4249
- :key_pair_name)
5718
+ # @!attribute [rw] price
5719
+ # The cost of the database bundle in US currency.
5720
+ # @return [Float]
5721
+ #
5722
+ # @!attribute [rw] ram_size_in_gb
5723
+ # The amount of RAM in GB (for example, `2.0`) for the database
5724
+ # bundle.
5725
+ # @return [Float]
5726
+ #
5727
+ # @!attribute [rw] disk_size_in_gb
5728
+ # The size of the disk for the database bundle.
5729
+ # @return [Integer]
5730
+ #
5731
+ # @!attribute [rw] transfer_per_month_in_gb
5732
+ # The data transfer rate per month in GB for the database bundle.
5733
+ # @return [Integer]
5734
+ #
5735
+ # @!attribute [rw] cpu_count
5736
+ # The number of virtual CPUs (vCPUs) for the database bundle.
5737
+ # @return [Integer]
5738
+ #
5739
+ # @!attribute [rw] is_encrypted
5740
+ # A Boolean value indicating whether the database bundle is encrypted.
5741
+ # @return [Boolean]
5742
+ #
5743
+ # @!attribute [rw] is_active
5744
+ # A Boolean value indicating whether the database bundle is active.
5745
+ # @return [Boolean]
5746
+ #
5747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseBundle AWS API Documentation
5748
+ #
5749
+ class RelationalDatabaseBundle < Struct.new(
5750
+ :bundle_id,
5751
+ :name,
5752
+ :price,
5753
+ :ram_size_in_gb,
5754
+ :disk_size_in_gb,
5755
+ :transfer_per_month_in_gb,
5756
+ :cpu_count,
5757
+ :is_encrypted,
5758
+ :is_active)
4250
5759
  include Aws::Structure
4251
5760
  end
4252
5761
 
4253
- # @api private
5762
+ # Describes an endpoint for a database.
4254
5763
  #
4255
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpcRequest AWS API Documentation
5764
+ # @!attribute [rw] port
5765
+ # Specifies the port that the database is listening on.
5766
+ # @return [Integer]
4256
5767
  #
4257
- class PeerVpcRequest < Aws::EmptyStructure; end
4258
-
4259
- # @!attribute [rw] operation
4260
- # An array of key-value pairs containing information about the request
4261
- # operation.
4262
- # @return [Types::Operation]
5768
+ # @!attribute [rw] address
5769
+ # Specifies the DNS address of the database.
5770
+ # @return [String]
4263
5771
  #
4264
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PeerVpcResult AWS API Documentation
5772
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseEndpoint AWS API Documentation
4265
5773
  #
4266
- class PeerVpcResult < Struct.new(
4267
- :operation)
5774
+ class RelationalDatabaseEndpoint < Struct.new(
5775
+ :port,
5776
+ :address)
4268
5777
  include Aws::Structure
4269
5778
  end
4270
5779
 
4271
- # Describes information about the ports on your virtual private server
4272
- # (or *instance*).
5780
+ # Describes an event for a database.
4273
5781
  #
4274
- # @note When making an API call, you may pass PortInfo
4275
- # data as a hash:
5782
+ # @!attribute [rw] resource
5783
+ # The database that the database event relates to.
5784
+ # @return [String]
4276
5785
  #
4277
- # {
4278
- # from_port: 1,
4279
- # to_port: 1,
4280
- # protocol: "tcp", # accepts tcp, all, udp
4281
- # }
5786
+ # @!attribute [rw] created_at
5787
+ # The timestamp when the database event was created.
5788
+ # @return [Time]
5789
+ #
5790
+ # @!attribute [rw] message
5791
+ # The message of the database event.
5792
+ # @return [String]
5793
+ #
5794
+ # @!attribute [rw] event_categories
5795
+ # The category that the database event belongs to.
5796
+ # @return [Array<String>]
5797
+ #
5798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseEvent AWS API Documentation
5799
+ #
5800
+ class RelationalDatabaseEvent < Struct.new(
5801
+ :resource,
5802
+ :created_at,
5803
+ :message,
5804
+ :event_categories)
5805
+ include Aws::Structure
5806
+ end
5807
+
5808
+ # Describes the hardware of a database.
4282
5809
  #
4283
- # @!attribute [rw] from_port
4284
- # The first port in the range.
5810
+ # @!attribute [rw] cpu_count
5811
+ # The number of vCPUs for the database.
4285
5812
  # @return [Integer]
4286
5813
  #
4287
- # @!attribute [rw] to_port
4288
- # The last port in the range.
5814
+ # @!attribute [rw] disk_size_in_gb
5815
+ # The size of the disk for the database.
4289
5816
  # @return [Integer]
4290
5817
  #
4291
- # @!attribute [rw] protocol
4292
- # The protocol.
4293
- # @return [String]
5818
+ # @!attribute [rw] ram_size_in_gb
5819
+ # The amount of RAM in GB for the database.
5820
+ # @return [Float]
4294
5821
  #
4295
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PortInfo AWS API Documentation
5822
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseHardware AWS API Documentation
4296
5823
  #
4297
- class PortInfo < Struct.new(
4298
- :from_port,
4299
- :to_port,
4300
- :protocol)
5824
+ class RelationalDatabaseHardware < Struct.new(
5825
+ :cpu_count,
5826
+ :disk_size_in_gb,
5827
+ :ram_size_in_gb)
4301
5828
  include Aws::Structure
4302
5829
  end
4303
5830
 
4304
- # @note When making an API call, you may pass PutInstancePublicPortsRequest
5831
+ # Describes the parameters of a database.
5832
+ #
5833
+ # @note When making an API call, you may pass RelationalDatabaseParameter
4305
5834
  # data as a hash:
4306
5835
  #
4307
5836
  # {
4308
- # port_infos: [ # required
4309
- # {
4310
- # from_port: 1,
4311
- # to_port: 1,
4312
- # protocol: "tcp", # accepts tcp, all, udp
4313
- # },
4314
- # ],
4315
- # instance_name: "ResourceName", # required
5837
+ # allowed_values: "string",
5838
+ # apply_method: "string",
5839
+ # apply_type: "string",
5840
+ # data_type: "string",
5841
+ # description: "string",
5842
+ # is_modifiable: false,
5843
+ # parameter_name: "string",
5844
+ # parameter_value: "string",
4316
5845
  # }
4317
5846
  #
4318
- # @!attribute [rw] port_infos
4319
- # Specifies information about the public port(s).
4320
- # @return [Array<Types::PortInfo>]
5847
+ # @!attribute [rw] allowed_values
5848
+ # Specifies the valid range of values for the parameter.
5849
+ # @return [String]
4321
5850
  #
4322
- # @!attribute [rw] instance_name
4323
- # The Lightsail instance name of the public port(s) you are setting.
5851
+ # @!attribute [rw] apply_method
5852
+ # Indicates when parameter updates are applied.
5853
+ #
5854
+ # Can be `immediate` or `pending-reboot`.
4324
5855
  # @return [String]
4325
5856
  #
4326
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPortsRequest AWS API Documentation
5857
+ # @!attribute [rw] apply_type
5858
+ # Specifies the engine-specific parameter type.
5859
+ # @return [String]
4327
5860
  #
4328
- class PutInstancePublicPortsRequest < Struct.new(
4329
- :port_infos,
4330
- :instance_name)
4331
- include Aws::Structure
4332
- end
4333
-
4334
- # @!attribute [rw] operation
4335
- # Describes metadata about the operation you just executed.
4336
- # @return [Types::Operation]
5861
+ # @!attribute [rw] data_type
5862
+ # Specifies the valid data type for the parameter.
5863
+ # @return [String]
4337
5864
  #
4338
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/PutInstancePublicPortsResult AWS API Documentation
5865
+ # @!attribute [rw] description
5866
+ # Provides a description of the parameter.
5867
+ # @return [String]
4339
5868
  #
4340
- class PutInstancePublicPortsResult < Struct.new(
4341
- :operation)
4342
- include Aws::Structure
4343
- end
4344
-
4345
- # @note When making an API call, you may pass RebootInstanceRequest
4346
- # data as a hash:
5869
+ # @!attribute [rw] is_modifiable
5870
+ # A Boolean value indicating whether the parameter can be modified.
5871
+ # @return [Boolean]
4347
5872
  #
4348
- # {
4349
- # instance_name: "ResourceName", # required
4350
- # }
5873
+ # @!attribute [rw] parameter_name
5874
+ # Specifies the name of the parameter.
5875
+ # @return [String]
4351
5876
  #
4352
- # @!attribute [rw] instance_name
4353
- # The name of the instance to reboot.
5877
+ # @!attribute [rw] parameter_value
5878
+ # Specifies the value of the parameter.
4354
5879
  # @return [String]
4355
5880
  #
4356
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstanceRequest AWS API Documentation
5881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseParameter AWS API Documentation
4357
5882
  #
4358
- class RebootInstanceRequest < Struct.new(
4359
- :instance_name)
5883
+ class RelationalDatabaseParameter < Struct.new(
5884
+ :allowed_values,
5885
+ :apply_method,
5886
+ :apply_type,
5887
+ :data_type,
5888
+ :description,
5889
+ :is_modifiable,
5890
+ :parameter_name,
5891
+ :parameter_value)
4360
5892
  include Aws::Structure
4361
5893
  end
4362
5894
 
4363
- # @!attribute [rw] operations
4364
- # An array of key-value pairs containing information about the request
4365
- # operations.
4366
- # @return [Array<Types::Operation>]
5895
+ # Describes a database snapshot.
4367
5896
  #
4368
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RebootInstanceResult AWS API Documentation
5897
+ # @!attribute [rw] name
5898
+ # The name of the database snapshot.
5899
+ # @return [String]
4369
5900
  #
4370
- class RebootInstanceResult < Struct.new(
4371
- :operations)
4372
- include Aws::Structure
4373
- end
4374
-
4375
- # Describes the AWS Region.
5901
+ # @!attribute [rw] arn
5902
+ # The Amazon Resource Name (ARN) of the database snapshot.
5903
+ # @return [String]
4376
5904
  #
4377
- # @!attribute [rw] continent_code
4378
- # The continent code (e.g., `NA`, meaning North America).
5905
+ # @!attribute [rw] support_code
5906
+ # The support code for the database snapshot. Include this code in
5907
+ # your email to support when you have questions about a database
5908
+ # snapshot in Lightsail. This code enables our support team to look up
5909
+ # your Lightsail information more easily.
4379
5910
  # @return [String]
4380
5911
  #
4381
- # @!attribute [rw] description
4382
- # The description of the AWS Region (e.g., `This region is recommended
4383
- # to serve users in the eastern United States and eastern Canada`).
5912
+ # @!attribute [rw] created_at
5913
+ # The timestamp when the database snapshot was created.
5914
+ # @return [Time]
5915
+ #
5916
+ # @!attribute [rw] location
5917
+ # The Region name and Availability Zone where the database snapshot is
5918
+ # located.
5919
+ # @return [Types::ResourceLocation]
5920
+ #
5921
+ # @!attribute [rw] resource_type
5922
+ # The Lightsail resource type.
4384
5923
  # @return [String]
4385
5924
  #
4386
- # @!attribute [rw] display_name
4387
- # The display name (e.g., `Ohio`).
5925
+ # @!attribute [rw] engine
5926
+ # The software of the database snapshot (for example, `MySQL`)
4388
5927
  # @return [String]
4389
5928
  #
4390
- # @!attribute [rw] name
4391
- # The region name (e.g., `us-east-2`).
5929
+ # @!attribute [rw] engine_version
5930
+ # The database engine version for the database snapshot (for example,
5931
+ # `5.7.23`).
4392
5932
  # @return [String]
4393
5933
  #
4394
- # @!attribute [rw] availability_zones
4395
- # The Availability Zones. Follows the format `us-east-2a`
4396
- # (case-sensitive).
4397
- # @return [Array<Types::AvailabilityZone>]
5934
+ # @!attribute [rw] size_in_gb
5935
+ # The size of the disk in GB (for example, `32`) for the database
5936
+ # snapshot.
5937
+ # @return [Integer]
4398
5938
  #
4399
- # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Region AWS API Documentation
5939
+ # @!attribute [rw] state
5940
+ # The state of the database snapshot.
5941
+ # @return [String]
4400
5942
  #
4401
- class Region < Struct.new(
4402
- :continent_code,
4403
- :description,
4404
- :display_name,
5943
+ # @!attribute [rw] from_relational_database_name
5944
+ # The name of the source database from which the database snapshot was
5945
+ # created.
5946
+ # @return [String]
5947
+ #
5948
+ # @!attribute [rw] from_relational_database_arn
5949
+ # The Amazon Resource Name (ARN) of the database from which the
5950
+ # database snapshot was created.
5951
+ # @return [String]
5952
+ #
5953
+ # @!attribute [rw] from_relational_database_bundle_id
5954
+ # The bundle ID of the database from which the database snapshot was
5955
+ # created.
5956
+ # @return [String]
5957
+ #
5958
+ # @!attribute [rw] from_relational_database_blueprint_id
5959
+ # The blueprint ID of the database from which the database snapshot
5960
+ # was created. A blueprint describes the major engine version of a
5961
+ # database.
5962
+ # @return [String]
5963
+ #
5964
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/RelationalDatabaseSnapshot AWS API Documentation
5965
+ #
5966
+ class RelationalDatabaseSnapshot < Struct.new(
4405
5967
  :name,
4406
- :availability_zones)
5968
+ :arn,
5969
+ :support_code,
5970
+ :created_at,
5971
+ :location,
5972
+ :resource_type,
5973
+ :engine,
5974
+ :engine_version,
5975
+ :size_in_gb,
5976
+ :state,
5977
+ :from_relational_database_name,
5978
+ :from_relational_database_arn,
5979
+ :from_relational_database_bundle_id,
5980
+ :from_relational_database_blueprint_id)
4407
5981
  include Aws::Structure
4408
5982
  end
4409
5983
 
@@ -4486,6 +6060,36 @@ module Aws::Lightsail
4486
6060
  include Aws::Structure
4487
6061
  end
4488
6062
 
6063
+ # @note When making an API call, you may pass StartRelationalDatabaseRequest
6064
+ # data as a hash:
6065
+ #
6066
+ # {
6067
+ # relational_database_name: "ResourceName", # required
6068
+ # }
6069
+ #
6070
+ # @!attribute [rw] relational_database_name
6071
+ # The name of your database to start.
6072
+ # @return [String]
6073
+ #
6074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartRelationalDatabaseRequest AWS API Documentation
6075
+ #
6076
+ class StartRelationalDatabaseRequest < Struct.new(
6077
+ :relational_database_name)
6078
+ include Aws::Structure
6079
+ end
6080
+
6081
+ # @!attribute [rw] operations
6082
+ # An object describing the result of your start relational database
6083
+ # request.
6084
+ # @return [Array<Types::Operation>]
6085
+ #
6086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StartRelationalDatabaseResult AWS API Documentation
6087
+ #
6088
+ class StartRelationalDatabaseResult < Struct.new(
6089
+ :operations)
6090
+ include Aws::Structure
6091
+ end
6092
+
4489
6093
  # Describes the static IP.
4490
6094
  #
4491
6095
  # @!attribute [rw] name
@@ -4586,6 +6190,43 @@ module Aws::Lightsail
4586
6190
  include Aws::Structure
4587
6191
  end
4588
6192
 
6193
+ # @note When making an API call, you may pass StopRelationalDatabaseRequest
6194
+ # data as a hash:
6195
+ #
6196
+ # {
6197
+ # relational_database_name: "ResourceName", # required
6198
+ # relational_database_snapshot_name: "ResourceName",
6199
+ # }
6200
+ #
6201
+ # @!attribute [rw] relational_database_name
6202
+ # The name of your database to stop.
6203
+ # @return [String]
6204
+ #
6205
+ # @!attribute [rw] relational_database_snapshot_name
6206
+ # The name of your new database snapshot to be created before stopping
6207
+ # your database.
6208
+ # @return [String]
6209
+ #
6210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopRelationalDatabaseRequest AWS API Documentation
6211
+ #
6212
+ class StopRelationalDatabaseRequest < Struct.new(
6213
+ :relational_database_name,
6214
+ :relational_database_snapshot_name)
6215
+ include Aws::Structure
6216
+ end
6217
+
6218
+ # @!attribute [rw] operations
6219
+ # An object describing the result of your stop relational database
6220
+ # request.
6221
+ # @return [Array<Types::Operation>]
6222
+ #
6223
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/StopRelationalDatabaseResult AWS API Documentation
6224
+ #
6225
+ class StopRelationalDatabaseResult < Struct.new(
6226
+ :operations)
6227
+ include Aws::Structure
6228
+ end
6229
+
4589
6230
  # @api private
4590
6231
  #
4591
6232
  # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UnpeerVpcRequest AWS API Documentation
@@ -4693,5 +6334,186 @@ module Aws::Lightsail
4693
6334
  include Aws::Structure
4694
6335
  end
4695
6336
 
6337
+ # @note When making an API call, you may pass UpdateRelationalDatabaseParametersRequest
6338
+ # data as a hash:
6339
+ #
6340
+ # {
6341
+ # relational_database_name: "ResourceName", # required
6342
+ # parameters: [ # required
6343
+ # {
6344
+ # allowed_values: "string",
6345
+ # apply_method: "string",
6346
+ # apply_type: "string",
6347
+ # data_type: "string",
6348
+ # description: "string",
6349
+ # is_modifiable: false,
6350
+ # parameter_name: "string",
6351
+ # parameter_value: "string",
6352
+ # },
6353
+ # ],
6354
+ # }
6355
+ #
6356
+ # @!attribute [rw] relational_database_name
6357
+ # The name of your database for which to update parameters.
6358
+ # @return [String]
6359
+ #
6360
+ # @!attribute [rw] parameters
6361
+ # The database parameters to update.
6362
+ # @return [Array<Types::RelationalDatabaseParameter>]
6363
+ #
6364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseParametersRequest AWS API Documentation
6365
+ #
6366
+ class UpdateRelationalDatabaseParametersRequest < Struct.new(
6367
+ :relational_database_name,
6368
+ :parameters)
6369
+ include Aws::Structure
6370
+ end
6371
+
6372
+ # @!attribute [rw] operations
6373
+ # An object describing the result of your update relational database
6374
+ # parameters request.
6375
+ # @return [Array<Types::Operation>]
6376
+ #
6377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseParametersResult AWS API Documentation
6378
+ #
6379
+ class UpdateRelationalDatabaseParametersResult < Struct.new(
6380
+ :operations)
6381
+ include Aws::Structure
6382
+ end
6383
+
6384
+ # @note When making an API call, you may pass UpdateRelationalDatabaseRequest
6385
+ # data as a hash:
6386
+ #
6387
+ # {
6388
+ # relational_database_name: "ResourceName", # required
6389
+ # master_user_password: "SensitiveString",
6390
+ # rotate_master_user_password: false,
6391
+ # preferred_backup_window: "string",
6392
+ # preferred_maintenance_window: "string",
6393
+ # enable_backup_retention: false,
6394
+ # disable_backup_retention: false,
6395
+ # publicly_accessible: false,
6396
+ # apply_immediately: false,
6397
+ # }
6398
+ #
6399
+ # @!attribute [rw] relational_database_name
6400
+ # The name of your database to update.
6401
+ # @return [String]
6402
+ #
6403
+ # @!attribute [rw] master_user_password
6404
+ # The password for the master user of your database. The password can
6405
+ # include any printable ASCII character except "/", """, or
6406
+ # "@".
6407
+ #
6408
+ # Constraints: Must contain 8 to 41 characters.
6409
+ # @return [String]
6410
+ #
6411
+ # @!attribute [rw] rotate_master_user_password
6412
+ # When `true`, the master user password is changed to a new strong
6413
+ # password generated by Lightsail.
6414
+ #
6415
+ # Use the `get relational database master user password` operation to
6416
+ # get the new password.
6417
+ # @return [Boolean]
6418
+ #
6419
+ # @!attribute [rw] preferred_backup_window
6420
+ # The daily time range during which automated backups are created for
6421
+ # your database if automated backups are enabled.
6422
+ #
6423
+ # Constraints:
6424
+ #
6425
+ # * Must be in the `hh24:mi-hh24:mi` format.
6426
+ #
6427
+ # Example: `16:00-16:30`
6428
+ #
6429
+ # * Specified in Universal Coordinated Time (UTC).
6430
+ #
6431
+ # * Must not conflict with the preferred maintenance window.
6432
+ #
6433
+ # * Must be at least 30 minutes.
6434
+ # @return [String]
6435
+ #
6436
+ # @!attribute [rw] preferred_maintenance_window
6437
+ # The weekly time range during which system maintenance can occur on
6438
+ # your database.
6439
+ #
6440
+ # The default is a 30-minute window selected at random from an 8-hour
6441
+ # block of time for each AWS Region, occurring on a random day of the
6442
+ # week.
6443
+ #
6444
+ # Constraints:
6445
+ #
6446
+ # * Must be in the `ddd:hh24:mi-ddd:hh24:mi` format.
6447
+ #
6448
+ # * Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
6449
+ #
6450
+ # * Must be at least 30 minutes.
6451
+ #
6452
+ # * Specified in Universal Coordinated Time (UTC).
6453
+ #
6454
+ # * Example: `Tue:17:00-Tue:17:30`
6455
+ # @return [String]
6456
+ #
6457
+ # @!attribute [rw] enable_backup_retention
6458
+ # When `true`, enables automated backup retention for your database.
6459
+ #
6460
+ # Updates are applied during the next maintenance window because this
6461
+ # can result in an outage.
6462
+ # @return [Boolean]
6463
+ #
6464
+ # @!attribute [rw] disable_backup_retention
6465
+ # When `true`, disables automated backup retention for your database.
6466
+ #
6467
+ # Disabling backup retention deletes all automated database backups.
6468
+ # Before disabling this, you may want to create a snapshot of your
6469
+ # database using the `create relational database snapshot` operation.
6470
+ #
6471
+ # Updates are applied during the next maintenance window because this
6472
+ # can result in an outage.
6473
+ # @return [Boolean]
6474
+ #
6475
+ # @!attribute [rw] publicly_accessible
6476
+ # Specifies the accessibility options for your database. A value of
6477
+ # `true` specifies a database that is available to resources outside
6478
+ # of your Lightsail account. A value of `false` specifies a database
6479
+ # that is available only to your Lightsail resources in the same
6480
+ # region as your database.
6481
+ # @return [Boolean]
6482
+ #
6483
+ # @!attribute [rw] apply_immediately
6484
+ # When `true`, applies changes immediately. When `false`, applies
6485
+ # changes during the preferred maintenance window. Some changes may
6486
+ # cause an outage.
6487
+ #
6488
+ # Default: `false`
6489
+ # @return [Boolean]
6490
+ #
6491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseRequest AWS API Documentation
6492
+ #
6493
+ class UpdateRelationalDatabaseRequest < Struct.new(
6494
+ :relational_database_name,
6495
+ :master_user_password,
6496
+ :rotate_master_user_password,
6497
+ :preferred_backup_window,
6498
+ :preferred_maintenance_window,
6499
+ :enable_backup_retention,
6500
+ :disable_backup_retention,
6501
+ :publicly_accessible,
6502
+ :apply_immediately)
6503
+ include Aws::Structure
6504
+ end
6505
+
6506
+ # @!attribute [rw] operations
6507
+ # An object describing the result of your update relational database
6508
+ # request.
6509
+ # @return [Array<Types::Operation>]
6510
+ #
6511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateRelationalDatabaseResult AWS API Documentation
6512
+ #
6513
+ class UpdateRelationalDatabaseResult < Struct.new(
6514
+ :operations)
6515
+ include Aws::Structure
6516
+ end
6517
+
4696
6518
  end
4697
6519
  end