aws-sdk-lightsail 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-lightsail.rb +1 -1
- data/lib/aws-sdk-lightsail/client.rb +837 -92
- data/lib/aws-sdk-lightsail/client_api.rb +418 -1
- data/lib/aws-sdk-lightsail/types.rb +1048 -80
- metadata +2 -2
@@ -70,7 +70,7 @@ module Aws::Lightsail
|
|
70
70
|
end
|
71
71
|
|
72
72
|
# @!attribute [rw] operations
|
73
|
-
# An object describing the API
|
73
|
+
# An object describing the API operations.
|
74
74
|
# @return [Array<Types::Operation>]
|
75
75
|
#
|
76
76
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachDiskResult AWS API Documentation
|
@@ -80,6 +80,78 @@ module Aws::Lightsail
|
|
80
80
|
include Aws::Structure
|
81
81
|
end
|
82
82
|
|
83
|
+
# @note When making an API call, you may pass AttachInstancesToLoadBalancerRequest
|
84
|
+
# data as a hash:
|
85
|
+
#
|
86
|
+
# {
|
87
|
+
# load_balancer_name: "ResourceName", # required
|
88
|
+
# instance_names: ["ResourceName"], # required
|
89
|
+
# }
|
90
|
+
#
|
91
|
+
# @!attribute [rw] load_balancer_name
|
92
|
+
# The name of the load balancer.
|
93
|
+
# @return [String]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] instance_names
|
96
|
+
# An array of strings representing the instance name(s) you want to
|
97
|
+
# attach to your load balancer.
|
98
|
+
# @return [Array<String>]
|
99
|
+
#
|
100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancerRequest AWS API Documentation
|
101
|
+
#
|
102
|
+
class AttachInstancesToLoadBalancerRequest < Struct.new(
|
103
|
+
:load_balancer_name,
|
104
|
+
:instance_names)
|
105
|
+
include Aws::Structure
|
106
|
+
end
|
107
|
+
|
108
|
+
# @!attribute [rw] operations
|
109
|
+
# An object representing the API operations.
|
110
|
+
# @return [Array<Types::Operation>]
|
111
|
+
#
|
112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachInstancesToLoadBalancerResult AWS API Documentation
|
113
|
+
#
|
114
|
+
class AttachInstancesToLoadBalancerResult < Struct.new(
|
115
|
+
:operations)
|
116
|
+
include Aws::Structure
|
117
|
+
end
|
118
|
+
|
119
|
+
# @note When making an API call, you may pass AttachLoadBalancerTlsCertificateRequest
|
120
|
+
# data as a hash:
|
121
|
+
#
|
122
|
+
# {
|
123
|
+
# load_balancer_name: "ResourceName", # required
|
124
|
+
# certificate_name: "ResourceName", # required
|
125
|
+
# }
|
126
|
+
#
|
127
|
+
# @!attribute [rw] load_balancer_name
|
128
|
+
# The name of the load balancer to which you want to associate the
|
129
|
+
# TLS/SSL certificate.
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
# @!attribute [rw] certificate_name
|
133
|
+
# The name of your TLS/SSL certificate.
|
134
|
+
# @return [String]
|
135
|
+
#
|
136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachLoadBalancerTlsCertificateRequest AWS API Documentation
|
137
|
+
#
|
138
|
+
class AttachLoadBalancerTlsCertificateRequest < Struct.new(
|
139
|
+
:load_balancer_name,
|
140
|
+
:certificate_name)
|
141
|
+
include Aws::Structure
|
142
|
+
end
|
143
|
+
|
144
|
+
# @!attribute [rw] operations
|
145
|
+
# An object representing the API operations.
|
146
|
+
# @return [Array<Types::Operation>]
|
147
|
+
#
|
148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AttachLoadBalancerTlsCertificateResult AWS API Documentation
|
149
|
+
#
|
150
|
+
class AttachLoadBalancerTlsCertificateResult < Struct.new(
|
151
|
+
:operations)
|
152
|
+
include Aws::Structure
|
153
|
+
end
|
154
|
+
|
83
155
|
# @note When making an API call, you may pass AttachStaticIpRequest
|
84
156
|
# data as a hash:
|
85
157
|
#
|
@@ -468,6 +540,7 @@ module Aws::Lightsail
|
|
468
540
|
# id: "NonEmptyString",
|
469
541
|
# name: "DomainName",
|
470
542
|
# target: "string",
|
543
|
+
# is_alias: false,
|
471
544
|
# type: "DomainEntryType",
|
472
545
|
# options: {
|
473
546
|
# "DomainEntryOptionsKeys" => "string",
|
@@ -633,7 +706,7 @@ module Aws::Lightsail
|
|
633
706
|
#
|
634
707
|
# @!attribute [rw] user_data
|
635
708
|
# You can create a launch script that configures a server with
|
636
|
-
# additional user data. For example, `apt-get
|
709
|
+
# additional user data. For example, `apt-get -y update`.
|
637
710
|
#
|
638
711
|
# <note markdown="1"> Depending on the machine image you choose, the command to get
|
639
712
|
# software on your instance varies. Amazon Linux and CentOS use `yum`,
|
@@ -730,7 +803,7 @@ module Aws::Lightsail
|
|
730
803
|
#
|
731
804
|
# @!attribute [rw] user_data
|
732
805
|
# A launch script you can create that configures a server with
|
733
|
-
# additional user data. For example, you might want to run `apt-get
|
806
|
+
# additional user data. For example, you might want to run `apt-get -y
|
734
807
|
# update`.
|
735
808
|
#
|
736
809
|
# <note markdown="1"> Depending on the machine image you choose, the command to get
|
@@ -820,6 +893,124 @@ module Aws::Lightsail
|
|
820
893
|
include Aws::Structure
|
821
894
|
end
|
822
895
|
|
896
|
+
# @note When making an API call, you may pass CreateLoadBalancerRequest
|
897
|
+
# data as a hash:
|
898
|
+
#
|
899
|
+
# {
|
900
|
+
# load_balancer_name: "ResourceName", # required
|
901
|
+
# instance_port: 1, # required
|
902
|
+
# health_check_path: "string",
|
903
|
+
# certificate_name: "ResourceName",
|
904
|
+
# certificate_domain_name: "DomainName",
|
905
|
+
# certificate_alternative_names: ["DomainName"],
|
906
|
+
# }
|
907
|
+
#
|
908
|
+
# @!attribute [rw] load_balancer_name
|
909
|
+
# The name of your load balancer.
|
910
|
+
# @return [String]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] instance_port
|
913
|
+
# The instance port where you're creating your load balancer.
|
914
|
+
# @return [Integer]
|
915
|
+
#
|
916
|
+
# @!attribute [rw] health_check_path
|
917
|
+
# The path you provided to perform the load balancer health check. If
|
918
|
+
# you didn't specify a health check path, Lightsail uses the root
|
919
|
+
# path of your website (e.g., `"/"`).
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @!attribute [rw] certificate_name
|
923
|
+
# The name of the TLS/SSL certificate.
|
924
|
+
#
|
925
|
+
# If you specify `certificateName`, then `certificateDomainName` is
|
926
|
+
# required (and vice-versa).
|
927
|
+
# @return [String]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] certificate_domain_name
|
930
|
+
# The domain name with which your certificate is associated (e.g.,
|
931
|
+
# `example.com`).
|
932
|
+
#
|
933
|
+
# If you specify `certificateDomainName`, then `certificateName` is
|
934
|
+
# required (and vice-versa).
|
935
|
+
# @return [String]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] certificate_alternative_names
|
938
|
+
# The alternative domain names to use with your TLS/SSL certificate
|
939
|
+
# (e.g., `www.example.com`, `www.ejemplo.com`, `ejemplo.com`).
|
940
|
+
# @return [Array<String>]
|
941
|
+
#
|
942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerRequest AWS API Documentation
|
943
|
+
#
|
944
|
+
class CreateLoadBalancerRequest < Struct.new(
|
945
|
+
:load_balancer_name,
|
946
|
+
:instance_port,
|
947
|
+
:health_check_path,
|
948
|
+
:certificate_name,
|
949
|
+
:certificate_domain_name,
|
950
|
+
:certificate_alternative_names)
|
951
|
+
include Aws::Structure
|
952
|
+
end
|
953
|
+
|
954
|
+
# @!attribute [rw] operations
|
955
|
+
# An object containing information about the API operations.
|
956
|
+
# @return [Array<Types::Operation>]
|
957
|
+
#
|
958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerResult AWS API Documentation
|
959
|
+
#
|
960
|
+
class CreateLoadBalancerResult < Struct.new(
|
961
|
+
:operations)
|
962
|
+
include Aws::Structure
|
963
|
+
end
|
964
|
+
|
965
|
+
# @note When making an API call, you may pass CreateLoadBalancerTlsCertificateRequest
|
966
|
+
# data as a hash:
|
967
|
+
#
|
968
|
+
# {
|
969
|
+
# load_balancer_name: "ResourceName", # required
|
970
|
+
# certificate_name: "ResourceName", # required
|
971
|
+
# certificate_domain_name: "DomainName", # required
|
972
|
+
# certificate_alternative_names: ["DomainName"],
|
973
|
+
# }
|
974
|
+
#
|
975
|
+
# @!attribute [rw] load_balancer_name
|
976
|
+
# The load balancer name where you want to create the TLS/SSL
|
977
|
+
# certificate.
|
978
|
+
# @return [String]
|
979
|
+
#
|
980
|
+
# @!attribute [rw] certificate_name
|
981
|
+
# The TLS/SSL certificate name.
|
982
|
+
# @return [String]
|
983
|
+
#
|
984
|
+
# @!attribute [rw] certificate_domain_name
|
985
|
+
# The domain name (e.g., `example.com`) for your TLS/SSL certificate.
|
986
|
+
# @return [String]
|
987
|
+
#
|
988
|
+
# @!attribute [rw] certificate_alternative_names
|
989
|
+
# An array of strings listing alternative domain names for your
|
990
|
+
# TLS/SSL certificate.
|
991
|
+
# @return [Array<String>]
|
992
|
+
#
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificateRequest AWS API Documentation
|
994
|
+
#
|
995
|
+
class CreateLoadBalancerTlsCertificateRequest < Struct.new(
|
996
|
+
:load_balancer_name,
|
997
|
+
:certificate_name,
|
998
|
+
:certificate_domain_name,
|
999
|
+
:certificate_alternative_names)
|
1000
|
+
include Aws::Structure
|
1001
|
+
end
|
1002
|
+
|
1003
|
+
# @!attribute [rw] operations
|
1004
|
+
# An object containing information about the API operations.
|
1005
|
+
# @return [Array<Types::Operation>]
|
1006
|
+
#
|
1007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancerTlsCertificateResult AWS API Documentation
|
1008
|
+
#
|
1009
|
+
class CreateLoadBalancerTlsCertificateResult < Struct.new(
|
1010
|
+
:operations)
|
1011
|
+
include Aws::Structure
|
1012
|
+
end
|
1013
|
+
|
823
1014
|
# @note When making an API call, you may pass DeleteDiskRequest
|
824
1015
|
# data as a hash:
|
825
1016
|
#
|
@@ -888,6 +1079,7 @@ module Aws::Lightsail
|
|
888
1079
|
# id: "NonEmptyString",
|
889
1080
|
# name: "DomainName",
|
890
1081
|
# target: "string",
|
1082
|
+
# is_alias: false,
|
891
1083
|
# type: "DomainEntryType",
|
892
1084
|
# options: {
|
893
1085
|
# "DomainEntryOptionsKeys" => "string",
|
@@ -1044,6 +1236,76 @@ module Aws::Lightsail
|
|
1044
1236
|
include Aws::Structure
|
1045
1237
|
end
|
1046
1238
|
|
1239
|
+
# @note When making an API call, you may pass DeleteLoadBalancerRequest
|
1240
|
+
# data as a hash:
|
1241
|
+
#
|
1242
|
+
# {
|
1243
|
+
# load_balancer_name: "ResourceName", # required
|
1244
|
+
# }
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] load_balancer_name
|
1247
|
+
# The name of the load balancer you want to delete.
|
1248
|
+
# @return [String]
|
1249
|
+
#
|
1250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerRequest AWS API Documentation
|
1251
|
+
#
|
1252
|
+
class DeleteLoadBalancerRequest < Struct.new(
|
1253
|
+
:load_balancer_name)
|
1254
|
+
include Aws::Structure
|
1255
|
+
end
|
1256
|
+
|
1257
|
+
# @!attribute [rw] operations
|
1258
|
+
# An object describing the API operations.
|
1259
|
+
# @return [Array<Types::Operation>]
|
1260
|
+
#
|
1261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerResult AWS API Documentation
|
1262
|
+
#
|
1263
|
+
class DeleteLoadBalancerResult < Struct.new(
|
1264
|
+
:operations)
|
1265
|
+
include Aws::Structure
|
1266
|
+
end
|
1267
|
+
|
1268
|
+
# @note When making an API call, you may pass DeleteLoadBalancerTlsCertificateRequest
|
1269
|
+
# data as a hash:
|
1270
|
+
#
|
1271
|
+
# {
|
1272
|
+
# load_balancer_name: "ResourceName", # required
|
1273
|
+
# certificate_name: "ResourceName", # required
|
1274
|
+
# force: false,
|
1275
|
+
# }
|
1276
|
+
#
|
1277
|
+
# @!attribute [rw] load_balancer_name
|
1278
|
+
# The load balancer name.
|
1279
|
+
# @return [String]
|
1280
|
+
#
|
1281
|
+
# @!attribute [rw] certificate_name
|
1282
|
+
# The TLS/SSL certificate name.
|
1283
|
+
# @return [String]
|
1284
|
+
#
|
1285
|
+
# @!attribute [rw] force
|
1286
|
+
# When `true`, forces the deletion of a TLS/SSL certificate.
|
1287
|
+
# @return [Boolean]
|
1288
|
+
#
|
1289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificateRequest AWS API Documentation
|
1290
|
+
#
|
1291
|
+
class DeleteLoadBalancerTlsCertificateRequest < Struct.new(
|
1292
|
+
:load_balancer_name,
|
1293
|
+
:certificate_name,
|
1294
|
+
:force)
|
1295
|
+
include Aws::Structure
|
1296
|
+
end
|
1297
|
+
|
1298
|
+
# @!attribute [rw] operations
|
1299
|
+
# An object describing the API operations.
|
1300
|
+
# @return [Array<Types::Operation>]
|
1301
|
+
#
|
1302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificateResult AWS API Documentation
|
1303
|
+
#
|
1304
|
+
class DeleteLoadBalancerTlsCertificateResult < Struct.new(
|
1305
|
+
:operations)
|
1306
|
+
include Aws::Structure
|
1307
|
+
end
|
1308
|
+
|
1047
1309
|
# @note When making an API call, you may pass DetachDiskRequest
|
1048
1310
|
# data as a hash:
|
1049
1311
|
#
|
@@ -1074,6 +1336,42 @@ module Aws::Lightsail
|
|
1074
1336
|
include Aws::Structure
|
1075
1337
|
end
|
1076
1338
|
|
1339
|
+
# @note When making an API call, you may pass DetachInstancesFromLoadBalancerRequest
|
1340
|
+
# data as a hash:
|
1341
|
+
#
|
1342
|
+
# {
|
1343
|
+
# load_balancer_name: "ResourceName", # required
|
1344
|
+
# instance_names: ["ResourceName"], # required
|
1345
|
+
# }
|
1346
|
+
#
|
1347
|
+
# @!attribute [rw] load_balancer_name
|
1348
|
+
# The name of the Lightsail load balancer.
|
1349
|
+
# @return [String]
|
1350
|
+
#
|
1351
|
+
# @!attribute [rw] instance_names
|
1352
|
+
# An array of strings containing the names of the instances you want
|
1353
|
+
# to detach from the load balancer.
|
1354
|
+
# @return [Array<String>]
|
1355
|
+
#
|
1356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancerRequest AWS API Documentation
|
1357
|
+
#
|
1358
|
+
class DetachInstancesFromLoadBalancerRequest < Struct.new(
|
1359
|
+
:load_balancer_name,
|
1360
|
+
:instance_names)
|
1361
|
+
include Aws::Structure
|
1362
|
+
end
|
1363
|
+
|
1364
|
+
# @!attribute [rw] operations
|
1365
|
+
# An object describing the API operations.
|
1366
|
+
# @return [Array<Types::Operation>]
|
1367
|
+
#
|
1368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DetachInstancesFromLoadBalancerResult AWS API Documentation
|
1369
|
+
#
|
1370
|
+
class DetachInstancesFromLoadBalancerResult < Struct.new(
|
1371
|
+
:operations)
|
1372
|
+
include Aws::Structure
|
1373
|
+
end
|
1374
|
+
|
1077
1375
|
# @note When making an API call, you may pass DetachStaticIpRequest
|
1078
1376
|
# data as a hash:
|
1079
1377
|
#
|
@@ -1165,7 +1463,7 @@ module Aws::Lightsail
|
|
1165
1463
|
# @!attribute [rw] attachment_state
|
1166
1464
|
# (Deprecated) The attachment state of the disk.
|
1167
1465
|
#
|
1168
|
-
# <note markdown="1"> In releases prior to November
|
1466
|
+
# <note markdown="1"> In releases prior to November 14, 2017, this parameter returned
|
1169
1467
|
# `attached` for system disks in the API response. It is now
|
1170
1468
|
# deprecated, but still included in the response. Use `isAttached`
|
1171
1469
|
# instead.
|
@@ -1176,7 +1474,7 @@ module Aws::Lightsail
|
|
1176
1474
|
# @!attribute [rw] gb_in_use
|
1177
1475
|
# (Deprecated) The number of GB in use by the disk.
|
1178
1476
|
#
|
1179
|
-
# <note markdown="1"> In releases prior to November
|
1477
|
+
# <note markdown="1"> In releases prior to November 14, 2017, this parameter was not
|
1180
1478
|
# included in the API response. It is now deprecated.
|
1181
1479
|
#
|
1182
1480
|
# </note>
|
@@ -1357,6 +1655,7 @@ module Aws::Lightsail
|
|
1357
1655
|
# id: "NonEmptyString",
|
1358
1656
|
# name: "DomainName",
|
1359
1657
|
# target: "string",
|
1658
|
+
# is_alias: false,
|
1360
1659
|
# type: "DomainEntryType",
|
1361
1660
|
# options: {
|
1362
1661
|
# "DomainEntryOptionsKeys" => "string",
|
@@ -1375,12 +1674,22 @@ module Aws::Lightsail
|
|
1375
1674
|
# The target AWS name server (e.g., `ns-111.awsdns-22.com.`).
|
1376
1675
|
# @return [String]
|
1377
1676
|
#
|
1677
|
+
# @!attribute [rw] is_alias
|
1678
|
+
# When `true`, specifies whether the domain entry is an alias used by
|
1679
|
+
# the Lightsail load balancer.
|
1680
|
+
# @return [Boolean]
|
1681
|
+
#
|
1378
1682
|
# @!attribute [rw] type
|
1379
1683
|
# The type of domain entry (e.g., `SOA` or `NS`).
|
1380
1684
|
# @return [String]
|
1381
1685
|
#
|
1382
1686
|
# @!attribute [rw] options
|
1383
|
-
# The options for the domain entry.
|
1687
|
+
# (Deprecated) The options for the domain entry.
|
1688
|
+
#
|
1689
|
+
# <note markdown="1"> In releases prior to November 29, 2017, this parameter was not
|
1690
|
+
# included in the API response. It is now deprecated.
|
1691
|
+
#
|
1692
|
+
# </note>
|
1384
1693
|
# @return [Hash<String,String>]
|
1385
1694
|
#
|
1386
1695
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DomainEntry AWS API Documentation
|
@@ -1389,6 +1698,7 @@ module Aws::Lightsail
|
|
1389
1698
|
:id,
|
1390
1699
|
:name,
|
1391
1700
|
:target,
|
1701
|
+
:is_alias,
|
1392
1702
|
:type,
|
1393
1703
|
:options)
|
1394
1704
|
include Aws::Structure
|
@@ -2105,104 +2415,359 @@ module Aws::Lightsail
|
|
2105
2415
|
include Aws::Structure
|
2106
2416
|
end
|
2107
2417
|
|
2108
|
-
# @note When making an API call, you may pass
|
2418
|
+
# @note When making an API call, you may pass GetLoadBalancerMetricDataRequest
|
2109
2419
|
# data as a hash:
|
2110
2420
|
#
|
2111
2421
|
# {
|
2112
|
-
#
|
2422
|
+
# load_balancer_name: "ResourceName", # required
|
2423
|
+
# metric_name: "ClientTLSNegotiationErrorCount", # required, accepts ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount
|
2424
|
+
# period: 1, # required
|
2425
|
+
# start_time: Time.now, # required
|
2426
|
+
# end_time: Time.now, # required
|
2427
|
+
# 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
|
2428
|
+
# statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
|
2113
2429
|
# }
|
2114
2430
|
#
|
2115
|
-
# @!attribute [rw]
|
2116
|
-
#
|
2431
|
+
# @!attribute [rw] load_balancer_name
|
2432
|
+
# The name of the load balancer.
|
2117
2433
|
# @return [String]
|
2118
2434
|
#
|
2119
|
-
#
|
2435
|
+
# @!attribute [rw] metric_name
|
2436
|
+
# The metric about which you want to return information. Valid values
|
2437
|
+
# are listed below, along with the most useful `statistics` to include
|
2438
|
+
# in your request.
|
2120
2439
|
#
|
2121
|
-
|
2122
|
-
|
2123
|
-
|
2124
|
-
|
2125
|
-
|
2126
|
-
# @!attribute [rw] operation
|
2127
|
-
# An array of key-value pairs containing information about the results
|
2128
|
-
# of your get operation request.
|
2129
|
-
# @return [Types::Operation]
|
2440
|
+
# * <b> <code>ClientTLSNegotiationErrorCount</code> </b> - The number
|
2441
|
+
# of TLS connections initiated by the client that did not establish
|
2442
|
+
# a session with the load balancer. Possible causes include a
|
2443
|
+
# mismatch of ciphers or protocols.
|
2130
2444
|
#
|
2131
|
-
#
|
2445
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
2132
2446
|
#
|
2133
|
-
|
2134
|
-
|
2135
|
-
include Aws::Structure
|
2136
|
-
end
|
2137
|
-
|
2138
|
-
# @note When making an API call, you may pass GetOperationsForResourceRequest
|
2139
|
-
# data as a hash:
|
2447
|
+
# * <b> <code>HealthyHostCount</code> </b> - The number of target
|
2448
|
+
# instances that are considered healthy.
|
2140
2449
|
#
|
2141
|
-
#
|
2142
|
-
#
|
2143
|
-
# page_token: "string",
|
2144
|
-
# }
|
2450
|
+
# `Statistics`\: The most useful statistic are `Average`, `Minimum`,
|
2451
|
+
# and `Maximum`.
|
2145
2452
|
#
|
2146
|
-
#
|
2147
|
-
#
|
2148
|
-
# @return [String]
|
2453
|
+
# * <b> <code>UnhealthyHostCount</code> </b> - The number of target
|
2454
|
+
# instances that are considered unhealthy.
|
2149
2455
|
#
|
2150
|
-
#
|
2151
|
-
#
|
2152
|
-
# operations for resource request.
|
2153
|
-
# @return [String]
|
2456
|
+
# `Statistics`\: The most useful statistic are `Average`, `Minimum`,
|
2457
|
+
# and `Maximum`.
|
2154
2458
|
#
|
2155
|
-
#
|
2459
|
+
# * <b> <code>HTTPCode_LB_4XX_Count</code> </b> - The number of HTTP
|
2460
|
+
# 4XX client error codes that originate from the load balancer.
|
2461
|
+
# Client errors are generated when requests are malformed or
|
2462
|
+
# incomplete. These requests have not been received by the target
|
2463
|
+
# instance. This count does not include any response codes generated
|
2464
|
+
# by the target instances.
|
2156
2465
|
#
|
2157
|
-
|
2158
|
-
|
2159
|
-
:page_token)
|
2160
|
-
include Aws::Structure
|
2161
|
-
end
|
2162
|
-
|
2163
|
-
# @!attribute [rw] operations
|
2164
|
-
# An array of key-value pairs containing information about the results
|
2165
|
-
# of your get operations for resource request.
|
2166
|
-
# @return [Array<Types::Operation>]
|
2466
|
+
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
2467
|
+
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
2167
2468
|
#
|
2168
|
-
#
|
2169
|
-
#
|
2469
|
+
# * <b> <code>HTTPCode_LB_5XX_Count</code> </b> - The number of HTTP
|
2470
|
+
# 5XX server error codes that originate from the load balancer. This
|
2471
|
+
# count does not include any response codes generated by the target
|
2472
|
+
# instances.
|
2170
2473
|
#
|
2171
|
-
#
|
2172
|
-
#
|
2173
|
-
#
|
2474
|
+
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
2475
|
+
# `Minimum`, `Maximum`, and `Average` all return `1`. Note that
|
2476
|
+
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
2174
2477
|
#
|
2175
|
-
#
|
2176
|
-
#
|
2478
|
+
# * <b> <code>HTTPCode_Instance_2XX_Count</code> </b> - The number of
|
2479
|
+
# HTTP response codes generated by the target instances. This does
|
2480
|
+
# not include any response codes generated by the load balancer.
|
2177
2481
|
#
|
2178
|
-
#
|
2179
|
-
#
|
2180
|
-
# operation, which can be used to return the next set of items in the
|
2181
|
-
# list.
|
2182
|
-
# @return [String]
|
2482
|
+
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
2483
|
+
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
2183
2484
|
#
|
2184
|
-
#
|
2485
|
+
# * <b> <code>HTTPCode_Instance_3XX_Count</code> </b> - The number of
|
2486
|
+
# HTTP response codes generated by the target instances. This does
|
2487
|
+
# not include any response codes generated by the load balancer.
|
2185
2488
|
#
|
2186
|
-
|
2187
|
-
|
2188
|
-
:next_page_count,
|
2189
|
-
:next_page_token)
|
2190
|
-
include Aws::Structure
|
2191
|
-
end
|
2192
|
-
|
2193
|
-
# @note When making an API call, you may pass GetOperationsRequest
|
2194
|
-
# data as a hash:
|
2489
|
+
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
2490
|
+
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
2195
2491
|
#
|
2196
|
-
#
|
2197
|
-
#
|
2198
|
-
#
|
2492
|
+
# * <b> <code>HTTPCode_Instance_4XX_Count</code> </b> - The number of
|
2493
|
+
# HTTP response codes generated by the target instances. This does
|
2494
|
+
# not include any response codes generated by the load balancer.
|
2199
2495
|
#
|
2200
|
-
#
|
2201
|
-
#
|
2202
|
-
# operations request.
|
2203
|
-
# @return [String]
|
2496
|
+
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
2497
|
+
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
2204
2498
|
#
|
2205
|
-
#
|
2499
|
+
# * <b> <code>HTTPCode_Instance_5XX_Count</code> </b> - The number of
|
2500
|
+
# HTTP response codes generated by the target instances. This does
|
2501
|
+
# not include any response codes generated by the load balancer.
|
2502
|
+
#
|
2503
|
+
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
2504
|
+
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
2505
|
+
#
|
2506
|
+
# * <b> <code>InstanceResponseTime</code> </b> - The time elapsed, in
|
2507
|
+
# seconds, after the request leaves the load balancer until a
|
2508
|
+
# response from the target instance is received.
|
2509
|
+
#
|
2510
|
+
# `Statistics`\: The most useful statistic is `Average`.
|
2511
|
+
#
|
2512
|
+
# * <b> <code>RejectedConnectionCount</code> </b> - The number of
|
2513
|
+
# connections that were rejected because the load balancer had
|
2514
|
+
# reached its maximum number of connections.
|
2515
|
+
#
|
2516
|
+
# `Statistics`\: The most useful statistic is `Sum`.
|
2517
|
+
#
|
2518
|
+
# * <b> <code>RequestCount</code> </b> - The number of requests
|
2519
|
+
# processed over IPv4. This count includes only the requests with a
|
2520
|
+
# response generated by a target instance of the load balancer.
|
2521
|
+
#
|
2522
|
+
# `Statistics`\: The most useful statistic is `Sum`. Note that
|
2523
|
+
# `Minimum`, `Maximum`, and `Average` all return `1`.
|
2524
|
+
# @return [String]
|
2525
|
+
#
|
2526
|
+
# @!attribute [rw] period
|
2527
|
+
# The time period duration for your health data request.
|
2528
|
+
# @return [Integer]
|
2529
|
+
#
|
2530
|
+
# @!attribute [rw] start_time
|
2531
|
+
# The start time of the period.
|
2532
|
+
# @return [Time]
|
2533
|
+
#
|
2534
|
+
# @!attribute [rw] end_time
|
2535
|
+
# The end time of the period.
|
2536
|
+
# @return [Time]
|
2537
|
+
#
|
2538
|
+
# @!attribute [rw] unit
|
2539
|
+
# The unit for the time period request. Valid values are listed below.
|
2540
|
+
# @return [String]
|
2541
|
+
#
|
2542
|
+
# @!attribute [rw] statistics
|
2543
|
+
# An array of statistics that you want to request metrics for. Valid
|
2544
|
+
# values are listed below.
|
2545
|
+
# @return [Array<String>]
|
2546
|
+
#
|
2547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricDataRequest AWS API Documentation
|
2548
|
+
#
|
2549
|
+
class GetLoadBalancerMetricDataRequest < Struct.new(
|
2550
|
+
:load_balancer_name,
|
2551
|
+
:metric_name,
|
2552
|
+
:period,
|
2553
|
+
:start_time,
|
2554
|
+
:end_time,
|
2555
|
+
:unit,
|
2556
|
+
:statistics)
|
2557
|
+
include Aws::Structure
|
2558
|
+
end
|
2559
|
+
|
2560
|
+
# @!attribute [rw] metric_name
|
2561
|
+
# The metric about which you are receiving information. Valid values
|
2562
|
+
# are listed below.
|
2563
|
+
# @return [String]
|
2564
|
+
#
|
2565
|
+
# @!attribute [rw] metric_data
|
2566
|
+
# An array of metric datapoint objects.
|
2567
|
+
# @return [Array<Types::MetricDatapoint>]
|
2568
|
+
#
|
2569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerMetricDataResult AWS API Documentation
|
2570
|
+
#
|
2571
|
+
class GetLoadBalancerMetricDataResult < Struct.new(
|
2572
|
+
:metric_name,
|
2573
|
+
:metric_data)
|
2574
|
+
include Aws::Structure
|
2575
|
+
end
|
2576
|
+
|
2577
|
+
# @note When making an API call, you may pass GetLoadBalancerRequest
|
2578
|
+
# data as a hash:
|
2579
|
+
#
|
2580
|
+
# {
|
2581
|
+
# load_balancer_name: "ResourceName", # required
|
2582
|
+
# }
|
2583
|
+
#
|
2584
|
+
# @!attribute [rw] load_balancer_name
|
2585
|
+
# The name of the load balancer.
|
2586
|
+
# @return [String]
|
2587
|
+
#
|
2588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerRequest AWS API Documentation
|
2589
|
+
#
|
2590
|
+
class GetLoadBalancerRequest < Struct.new(
|
2591
|
+
:load_balancer_name)
|
2592
|
+
include Aws::Structure
|
2593
|
+
end
|
2594
|
+
|
2595
|
+
# @!attribute [rw] load_balancer
|
2596
|
+
# An object containing information about your load balancer.
|
2597
|
+
# @return [Types::LoadBalancer]
|
2598
|
+
#
|
2599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerResult AWS API Documentation
|
2600
|
+
#
|
2601
|
+
class GetLoadBalancerResult < Struct.new(
|
2602
|
+
:load_balancer)
|
2603
|
+
include Aws::Structure
|
2604
|
+
end
|
2605
|
+
|
2606
|
+
# @note When making an API call, you may pass GetLoadBalancerTlsCertificatesRequest
|
2607
|
+
# data as a hash:
|
2608
|
+
#
|
2609
|
+
# {
|
2610
|
+
# load_balancer_name: "ResourceName", # required
|
2611
|
+
# }
|
2612
|
+
#
|
2613
|
+
# @!attribute [rw] load_balancer_name
|
2614
|
+
# The name of the load balancer where you stored your TLS/SSL
|
2615
|
+
# certificate.
|
2616
|
+
# @return [String]
|
2617
|
+
#
|
2618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsCertificatesRequest AWS API Documentation
|
2619
|
+
#
|
2620
|
+
class GetLoadBalancerTlsCertificatesRequest < Struct.new(
|
2621
|
+
:load_balancer_name)
|
2622
|
+
include Aws::Structure
|
2623
|
+
end
|
2624
|
+
|
2625
|
+
# @!attribute [rw] tls_certificates
|
2626
|
+
# An array of LoadBalancerTlsCertificate objects describing your
|
2627
|
+
# TLS/SSL certificates.
|
2628
|
+
# @return [Array<Types::LoadBalancerTlsCertificate>]
|
2629
|
+
#
|
2630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancerTlsCertificatesResult AWS API Documentation
|
2631
|
+
#
|
2632
|
+
class GetLoadBalancerTlsCertificatesResult < Struct.new(
|
2633
|
+
:tls_certificates)
|
2634
|
+
include Aws::Structure
|
2635
|
+
end
|
2636
|
+
|
2637
|
+
# @note When making an API call, you may pass GetLoadBalancersRequest
|
2638
|
+
# data as a hash:
|
2639
|
+
#
|
2640
|
+
# {
|
2641
|
+
# page_token: "string",
|
2642
|
+
# }
|
2643
|
+
#
|
2644
|
+
# @!attribute [rw] page_token
|
2645
|
+
# A token used for paginating the results from your GetLoadBalancers
|
2646
|
+
# request.
|
2647
|
+
# @return [String]
|
2648
|
+
#
|
2649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancersRequest AWS API Documentation
|
2650
|
+
#
|
2651
|
+
class GetLoadBalancersRequest < Struct.new(
|
2652
|
+
:page_token)
|
2653
|
+
include Aws::Structure
|
2654
|
+
end
|
2655
|
+
|
2656
|
+
# @!attribute [rw] load_balancers
|
2657
|
+
# An array of LoadBalancer objects describing your load balancers.
|
2658
|
+
# @return [Array<Types::LoadBalancer>]
|
2659
|
+
#
|
2660
|
+
# @!attribute [rw] next_page_token
|
2661
|
+
# A token used for advancing to the next page of results from your
|
2662
|
+
# GetLoadBalancers request.
|
2663
|
+
# @return [String]
|
2664
|
+
#
|
2665
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetLoadBalancersResult AWS API Documentation
|
2666
|
+
#
|
2667
|
+
class GetLoadBalancersResult < Struct.new(
|
2668
|
+
:load_balancers,
|
2669
|
+
:next_page_token)
|
2670
|
+
include Aws::Structure
|
2671
|
+
end
|
2672
|
+
|
2673
|
+
# @note When making an API call, you may pass GetOperationRequest
|
2674
|
+
# data as a hash:
|
2675
|
+
#
|
2676
|
+
# {
|
2677
|
+
# operation_id: "NonEmptyString", # required
|
2678
|
+
# }
|
2679
|
+
#
|
2680
|
+
# @!attribute [rw] operation_id
|
2681
|
+
# A GUID used to identify the operation.
|
2682
|
+
# @return [String]
|
2683
|
+
#
|
2684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationRequest AWS API Documentation
|
2685
|
+
#
|
2686
|
+
class GetOperationRequest < Struct.new(
|
2687
|
+
:operation_id)
|
2688
|
+
include Aws::Structure
|
2689
|
+
end
|
2690
|
+
|
2691
|
+
# @!attribute [rw] operation
|
2692
|
+
# An array of key-value pairs containing information about the results
|
2693
|
+
# of your get operation request.
|
2694
|
+
# @return [Types::Operation]
|
2695
|
+
#
|
2696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationResult AWS API Documentation
|
2697
|
+
#
|
2698
|
+
class GetOperationResult < Struct.new(
|
2699
|
+
:operation)
|
2700
|
+
include Aws::Structure
|
2701
|
+
end
|
2702
|
+
|
2703
|
+
# @note When making an API call, you may pass GetOperationsForResourceRequest
|
2704
|
+
# data as a hash:
|
2705
|
+
#
|
2706
|
+
# {
|
2707
|
+
# resource_name: "ResourceName", # required
|
2708
|
+
# page_token: "string",
|
2709
|
+
# }
|
2710
|
+
#
|
2711
|
+
# @!attribute [rw] resource_name
|
2712
|
+
# The name of the resource for which you are requesting information.
|
2713
|
+
# @return [String]
|
2714
|
+
#
|
2715
|
+
# @!attribute [rw] page_token
|
2716
|
+
# A token used for advancing to the next page of results from your get
|
2717
|
+
# operations for resource request.
|
2718
|
+
# @return [String]
|
2719
|
+
#
|
2720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResourceRequest AWS API Documentation
|
2721
|
+
#
|
2722
|
+
class GetOperationsForResourceRequest < Struct.new(
|
2723
|
+
:resource_name,
|
2724
|
+
:page_token)
|
2725
|
+
include Aws::Structure
|
2726
|
+
end
|
2727
|
+
|
2728
|
+
# @!attribute [rw] operations
|
2729
|
+
# An array of key-value pairs containing information about the results
|
2730
|
+
# of your get operations for resource request.
|
2731
|
+
# @return [Array<Types::Operation>]
|
2732
|
+
#
|
2733
|
+
# @!attribute [rw] next_page_count
|
2734
|
+
# (Deprecated) Returns the number of pages of results that remain.
|
2735
|
+
#
|
2736
|
+
# <note markdown="1"> In releases prior to June 12, 2017, this parameter returned `null`
|
2737
|
+
# by the API. It is now deprecated, and the API returns the
|
2738
|
+
# `nextPageToken` parameter instead.
|
2739
|
+
#
|
2740
|
+
# </note>
|
2741
|
+
# @return [String]
|
2742
|
+
#
|
2743
|
+
# @!attribute [rw] next_page_token
|
2744
|
+
# An identifier that was returned from the previous call to this
|
2745
|
+
# operation, which can be used to return the next set of items in the
|
2746
|
+
# list.
|
2747
|
+
# @return [String]
|
2748
|
+
#
|
2749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsForResourceResult AWS API Documentation
|
2750
|
+
#
|
2751
|
+
class GetOperationsForResourceResult < Struct.new(
|
2752
|
+
:operations,
|
2753
|
+
:next_page_count,
|
2754
|
+
:next_page_token)
|
2755
|
+
include Aws::Structure
|
2756
|
+
end
|
2757
|
+
|
2758
|
+
# @note When making an API call, you may pass GetOperationsRequest
|
2759
|
+
# data as a hash:
|
2760
|
+
#
|
2761
|
+
# {
|
2762
|
+
# page_token: "string",
|
2763
|
+
# }
|
2764
|
+
#
|
2765
|
+
# @!attribute [rw] page_token
|
2766
|
+
# A token used for advancing to the next page of results from your get
|
2767
|
+
# operations request.
|
2768
|
+
# @return [String]
|
2769
|
+
#
|
2770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetOperationsRequest AWS API Documentation
|
2206
2771
|
#
|
2207
2772
|
class GetOperationsRequest < Struct.new(
|
2208
2773
|
:page_token)
|
@@ -2568,6 +3133,30 @@ module Aws::Lightsail
|
|
2568
3133
|
include Aws::Structure
|
2569
3134
|
end
|
2570
3135
|
|
3136
|
+
# Describes information about the health of the instance.
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] instance_name
|
3139
|
+
# The name of the Lightsail instance for which you are requesting
|
3140
|
+
# health check data.
|
3141
|
+
# @return [String]
|
3142
|
+
#
|
3143
|
+
# @!attribute [rw] instance_health
|
3144
|
+
# Describes the overall instance health. Valid values are below.
|
3145
|
+
# @return [String]
|
3146
|
+
#
|
3147
|
+
# @!attribute [rw] instance_health_reason
|
3148
|
+
# More information about the instance health. Valid values are below.
|
3149
|
+
# @return [String]
|
3150
|
+
#
|
3151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/InstanceHealthSummary AWS API Documentation
|
3152
|
+
#
|
3153
|
+
class InstanceHealthSummary < Struct.new(
|
3154
|
+
:instance_name,
|
3155
|
+
:instance_health,
|
3156
|
+
:instance_health_reason)
|
3157
|
+
include Aws::Structure
|
3158
|
+
end
|
3159
|
+
|
2571
3160
|
# Describes monthly data transfer rates and port information for an
|
2572
3161
|
# instance.
|
2573
3162
|
#
|
@@ -2878,6 +3467,342 @@ module Aws::Lightsail
|
|
2878
3467
|
include Aws::Structure
|
2879
3468
|
end
|
2880
3469
|
|
3470
|
+
# Describes the Lightsail load balancer.
|
3471
|
+
#
|
3472
|
+
# @!attribute [rw] name
|
3473
|
+
# The name of the load balancer (e.g., `my-load-balancer`).
|
3474
|
+
# @return [String]
|
3475
|
+
#
|
3476
|
+
# @!attribute [rw] arn
|
3477
|
+
# The Amazon Resource Name (ARN) of the load balancer.
|
3478
|
+
# @return [String]
|
3479
|
+
#
|
3480
|
+
# @!attribute [rw] support_code
|
3481
|
+
# The support code. Include this code in your email to support when
|
3482
|
+
# you have questions about your Lightsail load balancer. This code
|
3483
|
+
# enables our support team to look up your Lightsail information more
|
3484
|
+
# easily.
|
3485
|
+
# @return [String]
|
3486
|
+
#
|
3487
|
+
# @!attribute [rw] created_at
|
3488
|
+
# The date when your load balancer was created.
|
3489
|
+
# @return [Time]
|
3490
|
+
#
|
3491
|
+
# @!attribute [rw] location
|
3492
|
+
# The AWS Region and Availability Zone where your load balancer was
|
3493
|
+
# created (e.g., `us-east-2a`).
|
3494
|
+
# @return [Types::ResourceLocation]
|
3495
|
+
#
|
3496
|
+
# @!attribute [rw] resource_type
|
3497
|
+
# The resource type (e.g., `LoadBalancer`.
|
3498
|
+
# @return [String]
|
3499
|
+
#
|
3500
|
+
# @!attribute [rw] dns_name
|
3501
|
+
# The DNS name of your Lightsail load balancer.
|
3502
|
+
# @return [String]
|
3503
|
+
#
|
3504
|
+
# @!attribute [rw] state
|
3505
|
+
# The status of your load balancer. Valid values are below.
|
3506
|
+
# @return [String]
|
3507
|
+
#
|
3508
|
+
# @!attribute [rw] protocol
|
3509
|
+
# The protocol you have enabled for your load balancer. Valid values
|
3510
|
+
# are below.
|
3511
|
+
# @return [String]
|
3512
|
+
#
|
3513
|
+
# @!attribute [rw] public_ports
|
3514
|
+
# An array of public port settings for your load balancer.
|
3515
|
+
# @return [Array<Integer>]
|
3516
|
+
#
|
3517
|
+
# @!attribute [rw] health_check_path
|
3518
|
+
# The path you specified to perform your health checks. If no path is
|
3519
|
+
# specified, the load balancer tries to make a request to the default
|
3520
|
+
# (root) page.
|
3521
|
+
# @return [String]
|
3522
|
+
#
|
3523
|
+
# @!attribute [rw] instance_port
|
3524
|
+
# The instance port where the load balancer is listening.
|
3525
|
+
# @return [Integer]
|
3526
|
+
#
|
3527
|
+
# @!attribute [rw] instance_health_summary
|
3528
|
+
# An array of InstanceHealthSummary objects describing the health of
|
3529
|
+
# the load balancer.
|
3530
|
+
# @return [Array<Types::InstanceHealthSummary>]
|
3531
|
+
#
|
3532
|
+
# @!attribute [rw] tls_certificate_summaries
|
3533
|
+
# An array of LoadBalancerTlsCertificateSummary objects that provide
|
3534
|
+
# additional information about the TLS/SSL certificates.
|
3535
|
+
# @return [Array<Types::LoadBalancerTlsCertificateSummary>]
|
3536
|
+
#
|
3537
|
+
# @!attribute [rw] configuration_options
|
3538
|
+
# A string to string map of the configuration options for your load
|
3539
|
+
# balancer. Valid values are listed below.
|
3540
|
+
# @return [Hash<String,String>]
|
3541
|
+
#
|
3542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancer AWS API Documentation
|
3543
|
+
#
|
3544
|
+
class LoadBalancer < Struct.new(
|
3545
|
+
:name,
|
3546
|
+
:arn,
|
3547
|
+
:support_code,
|
3548
|
+
:created_at,
|
3549
|
+
:location,
|
3550
|
+
:resource_type,
|
3551
|
+
:dns_name,
|
3552
|
+
:state,
|
3553
|
+
:protocol,
|
3554
|
+
:public_ports,
|
3555
|
+
:health_check_path,
|
3556
|
+
:instance_port,
|
3557
|
+
:instance_health_summary,
|
3558
|
+
:tls_certificate_summaries,
|
3559
|
+
:configuration_options)
|
3560
|
+
include Aws::Structure
|
3561
|
+
end
|
3562
|
+
|
3563
|
+
# Describes a load balancer TLS/SSL certificate.
|
3564
|
+
#
|
3565
|
+
# TLS is just an updated, more secure version of Secure Socket Layer
|
3566
|
+
# (SSL).
|
3567
|
+
#
|
3568
|
+
# @!attribute [rw] name
|
3569
|
+
# The name of the TLS/SSL certificate (e.g., `my-certificate`).
|
3570
|
+
# @return [String]
|
3571
|
+
#
|
3572
|
+
# @!attribute [rw] arn
|
3573
|
+
# The Amazon Resource Name (ARN) of the TLS/SSL certificate.
|
3574
|
+
# @return [String]
|
3575
|
+
#
|
3576
|
+
# @!attribute [rw] support_code
|
3577
|
+
# The support code. Include this code in your email to support when
|
3578
|
+
# you have questions about your Lightsail load balancer or TLS/SSL
|
3579
|
+
# certificate. This code enables our support team to look up your
|
3580
|
+
# Lightsail information more easily.
|
3581
|
+
# @return [String]
|
3582
|
+
#
|
3583
|
+
# @!attribute [rw] created_at
|
3584
|
+
# The time when you created your TLS/SSL certificate.
|
3585
|
+
# @return [Time]
|
3586
|
+
#
|
3587
|
+
# @!attribute [rw] location
|
3588
|
+
# The AWS Region and Availability Zone where you created your
|
3589
|
+
# certificate.
|
3590
|
+
# @return [Types::ResourceLocation]
|
3591
|
+
#
|
3592
|
+
# @!attribute [rw] resource_type
|
3593
|
+
# The resource type (e.g., `LoadBalancerTlsCertificate`.
|
3594
|
+
# @return [String]
|
3595
|
+
#
|
3596
|
+
# @!attribute [rw] load_balancer_name
|
3597
|
+
# The load balancer name where your TLS/SSL certificate is attached.
|
3598
|
+
# @return [String]
|
3599
|
+
#
|
3600
|
+
# @!attribute [rw] is_attached
|
3601
|
+
# When `true`, the TLS/SSL certificate is attached to the Lightsail
|
3602
|
+
# load balancer.
|
3603
|
+
# @return [Boolean]
|
3604
|
+
#
|
3605
|
+
# @!attribute [rw] status
|
3606
|
+
# The status of the TLS/SSL certificate. Valid values are below.
|
3607
|
+
# @return [String]
|
3608
|
+
#
|
3609
|
+
# @!attribute [rw] domain_name
|
3610
|
+
# The domain name for your TLS/SSL certificate.
|
3611
|
+
# @return [String]
|
3612
|
+
#
|
3613
|
+
# @!attribute [rw] domain_validation_records
|
3614
|
+
# An array of LoadBalancerTlsCertificateDomainValidationRecord objects
|
3615
|
+
# describing the records.
|
3616
|
+
# @return [Array<Types::LoadBalancerTlsCertificateDomainValidationRecord>]
|
3617
|
+
#
|
3618
|
+
# @!attribute [rw] failure_reason
|
3619
|
+
# The reason for the TLS/SSL certificate validation failure.
|
3620
|
+
# @return [String]
|
3621
|
+
#
|
3622
|
+
# @!attribute [rw] issued_at
|
3623
|
+
# The time when the TLS/SSL certificate was issued.
|
3624
|
+
# @return [Time]
|
3625
|
+
#
|
3626
|
+
# @!attribute [rw] issuer
|
3627
|
+
# The issuer of the certificate.
|
3628
|
+
# @return [String]
|
3629
|
+
#
|
3630
|
+
# @!attribute [rw] key_algorithm
|
3631
|
+
# The algorithm that was used to generate the key pair (the public and
|
3632
|
+
# private key).
|
3633
|
+
# @return [String]
|
3634
|
+
#
|
3635
|
+
# @!attribute [rw] not_after
|
3636
|
+
# The timestamp when the TLS/SSL certificate expires.
|
3637
|
+
# @return [Time]
|
3638
|
+
#
|
3639
|
+
# @!attribute [rw] not_before
|
3640
|
+
# The timestamp when the TLS/SSL certificate is first valid.
|
3641
|
+
# @return [Time]
|
3642
|
+
#
|
3643
|
+
# @!attribute [rw] renewal_summary
|
3644
|
+
# An object containing information about the status of Lightsail's
|
3645
|
+
# managed renewal for the certificate.
|
3646
|
+
# @return [Types::LoadBalancerTlsCertificateRenewalSummary]
|
3647
|
+
#
|
3648
|
+
# @!attribute [rw] revocation_reason
|
3649
|
+
# The reason the certificate was revoked. Valid values are below.
|
3650
|
+
# @return [String]
|
3651
|
+
#
|
3652
|
+
# @!attribute [rw] revoked_at
|
3653
|
+
# The timestamp when the TLS/SSL certificate was revoked.
|
3654
|
+
# @return [Time]
|
3655
|
+
#
|
3656
|
+
# @!attribute [rw] serial
|
3657
|
+
# The serial number of the certificate.
|
3658
|
+
# @return [String]
|
3659
|
+
#
|
3660
|
+
# @!attribute [rw] signature_algorithm
|
3661
|
+
# The algorithm that was used to sign the certificate.
|
3662
|
+
# @return [String]
|
3663
|
+
#
|
3664
|
+
# @!attribute [rw] subject
|
3665
|
+
# The name of the entity that is associated with the public key
|
3666
|
+
# contained in the certificate.
|
3667
|
+
# @return [String]
|
3668
|
+
#
|
3669
|
+
# @!attribute [rw] subject_alternative_names
|
3670
|
+
# One or more domain names (subject alternative names) included in the
|
3671
|
+
# certificate. This list contains the domain names that are bound to
|
3672
|
+
# the public key that is contained in the certificate. The subject
|
3673
|
+
# alternative names include the canonical domain name (CN) of the
|
3674
|
+
# certificate and additional domain names that can be used to connect
|
3675
|
+
# to the website.
|
3676
|
+
# @return [Array<String>]
|
3677
|
+
#
|
3678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificate AWS API Documentation
|
3679
|
+
#
|
3680
|
+
class LoadBalancerTlsCertificate < Struct.new(
|
3681
|
+
:name,
|
3682
|
+
:arn,
|
3683
|
+
:support_code,
|
3684
|
+
:created_at,
|
3685
|
+
:location,
|
3686
|
+
:resource_type,
|
3687
|
+
:load_balancer_name,
|
3688
|
+
:is_attached,
|
3689
|
+
:status,
|
3690
|
+
:domain_name,
|
3691
|
+
:domain_validation_records,
|
3692
|
+
:failure_reason,
|
3693
|
+
:issued_at,
|
3694
|
+
:issuer,
|
3695
|
+
:key_algorithm,
|
3696
|
+
:not_after,
|
3697
|
+
:not_before,
|
3698
|
+
:renewal_summary,
|
3699
|
+
:revocation_reason,
|
3700
|
+
:revoked_at,
|
3701
|
+
:serial,
|
3702
|
+
:signature_algorithm,
|
3703
|
+
:subject,
|
3704
|
+
:subject_alternative_names)
|
3705
|
+
include Aws::Structure
|
3706
|
+
end
|
3707
|
+
|
3708
|
+
# Contains information about the domain names on a TLS/SSL certificate
|
3709
|
+
# that you will use to validate domain ownership.
|
3710
|
+
#
|
3711
|
+
# @!attribute [rw] domain_name
|
3712
|
+
# A fully qualified domain name in the certificate request.
|
3713
|
+
# @return [String]
|
3714
|
+
#
|
3715
|
+
# @!attribute [rw] validation_status
|
3716
|
+
# The status of the domain validation. Valid values are listed below.
|
3717
|
+
# @return [String]
|
3718
|
+
#
|
3719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateDomainValidationOption AWS API Documentation
|
3720
|
+
#
|
3721
|
+
class LoadBalancerTlsCertificateDomainValidationOption < Struct.new(
|
3722
|
+
:domain_name,
|
3723
|
+
:validation_status)
|
3724
|
+
include Aws::Structure
|
3725
|
+
end
|
3726
|
+
|
3727
|
+
# Describes the validation record of each domain name in the TLS/SSL
|
3728
|
+
# certificate.
|
3729
|
+
#
|
3730
|
+
# @!attribute [rw] name
|
3731
|
+
# A fully qualified domain name in the certificate. For example,
|
3732
|
+
# `example.com`.
|
3733
|
+
# @return [String]
|
3734
|
+
#
|
3735
|
+
# @!attribute [rw] type
|
3736
|
+
# The type of validation record. For example, `CNAME` for domain
|
3737
|
+
# validation.
|
3738
|
+
# @return [String]
|
3739
|
+
#
|
3740
|
+
# @!attribute [rw] value
|
3741
|
+
# The value for that type.
|
3742
|
+
# @return [String]
|
3743
|
+
#
|
3744
|
+
# @!attribute [rw] validation_status
|
3745
|
+
# The validation status. Valid values are listed below.
|
3746
|
+
# @return [String]
|
3747
|
+
#
|
3748
|
+
# @!attribute [rw] domain_name
|
3749
|
+
# The domain name against which your TLS/SSL certificate was
|
3750
|
+
# validated.
|
3751
|
+
# @return [String]
|
3752
|
+
#
|
3753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateDomainValidationRecord AWS API Documentation
|
3754
|
+
#
|
3755
|
+
class LoadBalancerTlsCertificateDomainValidationRecord < Struct.new(
|
3756
|
+
:name,
|
3757
|
+
:type,
|
3758
|
+
:value,
|
3759
|
+
:validation_status,
|
3760
|
+
:domain_name)
|
3761
|
+
include Aws::Structure
|
3762
|
+
end
|
3763
|
+
|
3764
|
+
# Contains information about the status of Lightsail's managed renewal
|
3765
|
+
# for the certificate.
|
3766
|
+
#
|
3767
|
+
# @!attribute [rw] renewal_status
|
3768
|
+
# The status of Lightsail's managed renewal of the certificate. Valid
|
3769
|
+
# values are listed below.
|
3770
|
+
# @return [String]
|
3771
|
+
#
|
3772
|
+
# @!attribute [rw] domain_validation_options
|
3773
|
+
# Contains information about the validation of each domain name in the
|
3774
|
+
# certificate, as it pertains to Lightsail's managed renewal. This is
|
3775
|
+
# different from the initial validation that occurs as a result of the
|
3776
|
+
# RequestCertificate request.
|
3777
|
+
# @return [Array<Types::LoadBalancerTlsCertificateDomainValidationOption>]
|
3778
|
+
#
|
3779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateRenewalSummary AWS API Documentation
|
3780
|
+
#
|
3781
|
+
class LoadBalancerTlsCertificateRenewalSummary < Struct.new(
|
3782
|
+
:renewal_status,
|
3783
|
+
:domain_validation_options)
|
3784
|
+
include Aws::Structure
|
3785
|
+
end
|
3786
|
+
|
3787
|
+
# Provides a summary of TLS/SSL certificate metadata.
|
3788
|
+
#
|
3789
|
+
# @!attribute [rw] name
|
3790
|
+
# The name of the TLS/SSL certificate.
|
3791
|
+
# @return [String]
|
3792
|
+
#
|
3793
|
+
# @!attribute [rw] is_attached
|
3794
|
+
# When `true`, the TLS/SSL certificate is attached to the Lightsail
|
3795
|
+
# load balancer.
|
3796
|
+
# @return [Boolean]
|
3797
|
+
#
|
3798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LoadBalancerTlsCertificateSummary AWS API Documentation
|
3799
|
+
#
|
3800
|
+
class LoadBalancerTlsCertificateSummary < Struct.new(
|
3801
|
+
:name,
|
3802
|
+
:is_attached)
|
3803
|
+
include Aws::Structure
|
3804
|
+
end
|
3805
|
+
|
2881
3806
|
# Describes the metric data point.
|
2882
3807
|
#
|
2883
3808
|
# @!attribute [rw] average
|
@@ -3450,6 +4375,7 @@ module Aws::Lightsail
|
|
3450
4375
|
# id: "NonEmptyString",
|
3451
4376
|
# name: "DomainName",
|
3452
4377
|
# target: "string",
|
4378
|
+
# is_alias: false,
|
3453
4379
|
# type: "DomainEntryType",
|
3454
4380
|
# options: {
|
3455
4381
|
# "DomainEntryOptionsKeys" => "string",
|
@@ -3486,5 +4412,47 @@ module Aws::Lightsail
|
|
3486
4412
|
include Aws::Structure
|
3487
4413
|
end
|
3488
4414
|
|
4415
|
+
# @note When making an API call, you may pass UpdateLoadBalancerAttributeRequest
|
4416
|
+
# data as a hash:
|
4417
|
+
#
|
4418
|
+
# {
|
4419
|
+
# load_balancer_name: "ResourceName", # required
|
4420
|
+
# attribute_name: "HealthCheckPath", # required, accepts HealthCheckPath, SessionStickinessEnabled, SessionStickiness_LB_CookieDurationSeconds
|
4421
|
+
# attribute_value: "StringMax256", # required
|
4422
|
+
# }
|
4423
|
+
#
|
4424
|
+
# @!attribute [rw] load_balancer_name
|
4425
|
+
# The name of the load balancer that you want to modify.
|
4426
|
+
# @return [String]
|
4427
|
+
#
|
4428
|
+
# @!attribute [rw] attribute_name
|
4429
|
+
# The name of the attribute you want to update. Valid values are
|
4430
|
+
# below.
|
4431
|
+
# @return [String]
|
4432
|
+
#
|
4433
|
+
# @!attribute [rw] attribute_value
|
4434
|
+
# The value that you want to specify for the attribute name.
|
4435
|
+
# @return [String]
|
4436
|
+
#
|
4437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateLoadBalancerAttributeRequest AWS API Documentation
|
4438
|
+
#
|
4439
|
+
class UpdateLoadBalancerAttributeRequest < Struct.new(
|
4440
|
+
:load_balancer_name,
|
4441
|
+
:attribute_name,
|
4442
|
+
:attribute_value)
|
4443
|
+
include Aws::Structure
|
4444
|
+
end
|
4445
|
+
|
4446
|
+
# @!attribute [rw] operations
|
4447
|
+
# An object describing the API operations.
|
4448
|
+
# @return [Array<Types::Operation>]
|
4449
|
+
#
|
4450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateLoadBalancerAttributeResult AWS API Documentation
|
4451
|
+
#
|
4452
|
+
class UpdateLoadBalancerAttributeResult < Struct.new(
|
4453
|
+
:operations)
|
4454
|
+
include Aws::Structure
|
4455
|
+
end
|
4456
|
+
|
3489
4457
|
end
|
3490
4458
|
end
|