aws-sdk-lightsail 1.51.0 → 1.52.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lightsail.rb +1 -1
- data/lib/aws-sdk-lightsail/client.rb +1312 -487
- data/lib/aws-sdk-lightsail/client_api.rb +323 -0
- data/lib/aws-sdk-lightsail/types.rb +1157 -173
- metadata +2 -2
@@ -36,6 +36,124 @@ module Aws::Lightsail
|
|
36
36
|
include Aws::Structure
|
37
37
|
end
|
38
38
|
|
39
|
+
# Describes an access key for an Amazon Lightsail bucket.
|
40
|
+
#
|
41
|
+
# Access keys grant full programmatic access to the specified bucket and
|
42
|
+
# its objects. You can have a maximum of two access keys per bucket. Use
|
43
|
+
# the CreateBucketAccessKey action to create an access key for a
|
44
|
+
# specific bucket. For more information about access keys, see [Creating
|
45
|
+
# access keys for a bucket in Amazon Lightsail][1] in the *Amazon
|
46
|
+
# Lightsail Developer Guide*.
|
47
|
+
#
|
48
|
+
# The `secretAccessKey` value is returned only in response to the
|
49
|
+
# `CreateBucketAccessKey` action. You can get a secret access key only
|
50
|
+
# when you first create an access key; you cannot get the secret access
|
51
|
+
# key later. If you lose the secret access key, you must create a new
|
52
|
+
# access key.
|
53
|
+
#
|
54
|
+
#
|
55
|
+
#
|
56
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys
|
57
|
+
#
|
58
|
+
# @!attribute [rw] access_key_id
|
59
|
+
# The ID of the access key.
|
60
|
+
# @return [String]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] secret_access_key
|
63
|
+
# The secret access key used to sign requests.
|
64
|
+
#
|
65
|
+
# You should store the secret access key in a safe location. We
|
66
|
+
# recommend that you delete the access key if the secret access key is
|
67
|
+
# compromised.
|
68
|
+
# @return [String]
|
69
|
+
#
|
70
|
+
# @!attribute [rw] status
|
71
|
+
# The status of the access key.
|
72
|
+
#
|
73
|
+
# A status of `Active` means that the key is valid, while `Inactive`
|
74
|
+
# means it is not.
|
75
|
+
# @return [String]
|
76
|
+
#
|
77
|
+
# @!attribute [rw] created_at
|
78
|
+
# The timestamp when the access key was created.
|
79
|
+
# @return [Time]
|
80
|
+
#
|
81
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AccessKey AWS API Documentation
|
82
|
+
#
|
83
|
+
class AccessKey < Struct.new(
|
84
|
+
:access_key_id,
|
85
|
+
:secret_access_key,
|
86
|
+
:status,
|
87
|
+
:created_at)
|
88
|
+
SENSITIVE = [:access_key_id]
|
89
|
+
include Aws::Structure
|
90
|
+
end
|
91
|
+
|
92
|
+
# Describes the anonymous access permissions for an Amazon Lightsail
|
93
|
+
# bucket and its objects.
|
94
|
+
#
|
95
|
+
# For more information about bucket access permissions, see
|
96
|
+
# [Understanding bucket permissions in Amazon Lightsail][1] in the
|
97
|
+
#
|
98
|
+
# *Amazon Lightsail Developer Guide*.
|
99
|
+
#
|
100
|
+
#
|
101
|
+
#
|
102
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-understanding-bucket-permissions
|
103
|
+
#
|
104
|
+
# @note When making an API call, you may pass AccessRules
|
105
|
+
# data as a hash:
|
106
|
+
#
|
107
|
+
# {
|
108
|
+
# get_object: "public", # accepts public, private
|
109
|
+
# allow_public_overrides: false,
|
110
|
+
# }
|
111
|
+
#
|
112
|
+
# @!attribute [rw] get_object
|
113
|
+
# Specifies the anonymous access to all objects in a bucket.
|
114
|
+
#
|
115
|
+
# The following options can be specified:
|
116
|
+
#
|
117
|
+
# * `public` - Sets all objects in the bucket to public (read-only),
|
118
|
+
# making them readable by anyone in the world.
|
119
|
+
#
|
120
|
+
# If the `getObject` value is set to `public`, then all objects in
|
121
|
+
# the bucket default to public regardless of the
|
122
|
+
# `allowPublicOverrides` value.
|
123
|
+
#
|
124
|
+
# * `private` - Sets all objects in the bucket to private, making them
|
125
|
+
# readable only by you or anyone you give access to.
|
126
|
+
#
|
127
|
+
# If the `getObject` value is set to `private`, and the
|
128
|
+
# `allowPublicOverrides` value is set to `true`, then all objects in
|
129
|
+
# the bucket default to private unless they are configured with a
|
130
|
+
# `public-read` ACL. Individual objects with a `public-read` ACL are
|
131
|
+
# readable by anyone in the world.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] allow_public_overrides
|
135
|
+
# A Boolean value that indicates whether the access control list (ACL)
|
136
|
+
# permissions that are applied to individual objects override the
|
137
|
+
# `getObject` option that is currently specified.
|
138
|
+
#
|
139
|
+
# When this is true, you can use the [PutObjectAcl][1] Amazon S3 API
|
140
|
+
# action to set individual objects to public (read-only) using the
|
141
|
+
# `public-read` ACL, or to private using the `private` ACL.
|
142
|
+
#
|
143
|
+
#
|
144
|
+
#
|
145
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html
|
146
|
+
# @return [Boolean]
|
147
|
+
#
|
148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/AccessRules AWS API Documentation
|
149
|
+
#
|
150
|
+
class AccessRules < Struct.new(
|
151
|
+
:get_object,
|
152
|
+
:allow_public_overrides)
|
153
|
+
SENSITIVE = []
|
154
|
+
include Aws::Structure
|
155
|
+
end
|
156
|
+
|
39
157
|
# Lightsail throws this exception when an account is still in the setup
|
40
158
|
# in progress state.
|
41
159
|
#
|
@@ -145,8 +263,8 @@ module Aws::Lightsail
|
|
145
263
|
|
146
264
|
# Describes an alarm.
|
147
265
|
#
|
148
|
-
# An alarm is a way to monitor your
|
149
|
-
#
|
266
|
+
# An alarm is a way to monitor your Lightsail resource metrics. For more
|
267
|
+
# information, see [Alarms in Amazon Lightsail][1].
|
150
268
|
#
|
151
269
|
#
|
152
270
|
#
|
@@ -793,6 +911,194 @@ module Aws::Lightsail
|
|
793
911
|
include Aws::Structure
|
794
912
|
end
|
795
913
|
|
914
|
+
# Describes an Amazon Lightsail bucket.
|
915
|
+
#
|
916
|
+
# @!attribute [rw] resource_type
|
917
|
+
# The Lightsail resource type of the bucket (for example, `Bucket`).
|
918
|
+
# @return [String]
|
919
|
+
#
|
920
|
+
# @!attribute [rw] access_rules
|
921
|
+
# An object that describes the access rules of the bucket.
|
922
|
+
# @return [Types::AccessRules]
|
923
|
+
#
|
924
|
+
# @!attribute [rw] arn
|
925
|
+
# The Amazon Resource Name (ARN) of the bucket.
|
926
|
+
# @return [String]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] bundle_id
|
929
|
+
# The ID of the bundle currently applied to the bucket.
|
930
|
+
#
|
931
|
+
# A bucket bundle specifies the monthly cost, storage space, and data
|
932
|
+
# transfer quota for a bucket.
|
933
|
+
#
|
934
|
+
# Use the UpdateBucketBundle action to change the bundle of a bucket.
|
935
|
+
# @return [String]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] created_at
|
938
|
+
# The timestamp when the distribution was created.
|
939
|
+
# @return [Time]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] url
|
942
|
+
# The URL of the bucket.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] location
|
946
|
+
# Describes the resource location.
|
947
|
+
# @return [Types::ResourceLocation]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] name
|
950
|
+
# The name of the bucket.
|
951
|
+
# @return [String]
|
952
|
+
#
|
953
|
+
# @!attribute [rw] support_code
|
954
|
+
# The support code for a bucket. Include this code in your email to
|
955
|
+
# support when you have questions about a Lightsail bucket. This code
|
956
|
+
# enables our support team to look up your Lightsail information more
|
957
|
+
# easily.
|
958
|
+
# @return [String]
|
959
|
+
#
|
960
|
+
# @!attribute [rw] tags
|
961
|
+
# The tag keys and optional values for the bucket. For more
|
962
|
+
# information, see [Tags in Amazon Lightsail][1] in the *Amazon
|
963
|
+
# Lightsail Developer Guide*.
|
964
|
+
#
|
965
|
+
#
|
966
|
+
#
|
967
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags
|
968
|
+
# @return [Array<Types::Tag>]
|
969
|
+
#
|
970
|
+
# @!attribute [rw] object_versioning
|
971
|
+
# Indicates whether object versioning is enabled for the bucket.
|
972
|
+
#
|
973
|
+
# The following options can be configured:
|
974
|
+
#
|
975
|
+
# * `Enabled` - Object versioning is enabled.
|
976
|
+
#
|
977
|
+
# * `Suspended` - Object versioning was previously enabled but is
|
978
|
+
# currently suspended. Existing object versions are retained.
|
979
|
+
#
|
980
|
+
# * `NeverEnabled` - Object versioning has never been enabled.
|
981
|
+
# @return [String]
|
982
|
+
#
|
983
|
+
# @!attribute [rw] able_to_update_bundle
|
984
|
+
# Indicates whether the bundle that is currently applied to a bucket
|
985
|
+
# can be changed to another bundle.
|
986
|
+
#
|
987
|
+
# You can update a bucket's bundle only one time within a monthly AWS
|
988
|
+
# billing cycle.
|
989
|
+
#
|
990
|
+
# Use the UpdateBucketBundle action to change a bucket's bundle.
|
991
|
+
# @return [Boolean]
|
992
|
+
#
|
993
|
+
# @!attribute [rw] readonly_access_accounts
|
994
|
+
# An array of strings that specify the AWS account IDs that have
|
995
|
+
# read-only access to the bucket.
|
996
|
+
# @return [Array<String>]
|
997
|
+
#
|
998
|
+
# @!attribute [rw] resources_receiving_access
|
999
|
+
# An array of objects that describe Lightsail instances that have
|
1000
|
+
# access to the bucket.
|
1001
|
+
#
|
1002
|
+
# Use the SetResourceAccessForBucket action to update the instances
|
1003
|
+
# that have access to a bucket.
|
1004
|
+
# @return [Array<Types::ResourceReceivingAccess>]
|
1005
|
+
#
|
1006
|
+
# @!attribute [rw] state
|
1007
|
+
# An object that describes the state of the bucket.
|
1008
|
+
# @return [Types::BucketState]
|
1009
|
+
#
|
1010
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/Bucket AWS API Documentation
|
1011
|
+
#
|
1012
|
+
class Bucket < Struct.new(
|
1013
|
+
:resource_type,
|
1014
|
+
:access_rules,
|
1015
|
+
:arn,
|
1016
|
+
:bundle_id,
|
1017
|
+
:created_at,
|
1018
|
+
:url,
|
1019
|
+
:location,
|
1020
|
+
:name,
|
1021
|
+
:support_code,
|
1022
|
+
:tags,
|
1023
|
+
:object_versioning,
|
1024
|
+
:able_to_update_bundle,
|
1025
|
+
:readonly_access_accounts,
|
1026
|
+
:resources_receiving_access,
|
1027
|
+
:state)
|
1028
|
+
SENSITIVE = []
|
1029
|
+
include Aws::Structure
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
# Describes the specifications of a bundle that can be applied to an
|
1033
|
+
# Amazon Lightsail bucket.
|
1034
|
+
#
|
1035
|
+
# A bucket bundle specifies the monthly cost, storage space, and data
|
1036
|
+
# transfer quota for a bucket.
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] bundle_id
|
1039
|
+
# The ID of the bundle.
|
1040
|
+
# @return [String]
|
1041
|
+
#
|
1042
|
+
# @!attribute [rw] name
|
1043
|
+
# The name of the bundle.
|
1044
|
+
# @return [String]
|
1045
|
+
#
|
1046
|
+
# @!attribute [rw] price
|
1047
|
+
# The monthly price of the bundle, in US dollars.
|
1048
|
+
# @return [Float]
|
1049
|
+
#
|
1050
|
+
# @!attribute [rw] storage_per_month_in_gb
|
1051
|
+
# The storage size of the bundle, in GB.
|
1052
|
+
# @return [Integer]
|
1053
|
+
#
|
1054
|
+
# @!attribute [rw] transfer_per_month_in_gb
|
1055
|
+
# The monthly network transfer quota of the bundle.
|
1056
|
+
# @return [Integer]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] is_active
|
1059
|
+
# Indicates whether the bundle is active. Use for a new or existing
|
1060
|
+
# bucket.
|
1061
|
+
# @return [Boolean]
|
1062
|
+
#
|
1063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/BucketBundle AWS API Documentation
|
1064
|
+
#
|
1065
|
+
class BucketBundle < Struct.new(
|
1066
|
+
:bundle_id,
|
1067
|
+
:name,
|
1068
|
+
:price,
|
1069
|
+
:storage_per_month_in_gb,
|
1070
|
+
:transfer_per_month_in_gb,
|
1071
|
+
:is_active)
|
1072
|
+
SENSITIVE = []
|
1073
|
+
include Aws::Structure
|
1074
|
+
end
|
1075
|
+
|
1076
|
+
# Describes the state of an Amazon Lightsail bucket.
|
1077
|
+
#
|
1078
|
+
# @!attribute [rw] code
|
1079
|
+
# The state code of the bucket.
|
1080
|
+
#
|
1081
|
+
# The following codes are possible:
|
1082
|
+
#
|
1083
|
+
# * `OK` - The bucket is in a running state.
|
1084
|
+
#
|
1085
|
+
# * `Unknown` - Creation of the bucket might have timed-out. You might
|
1086
|
+
# want to delete the bucket and create a new one.
|
1087
|
+
# @return [String]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] message
|
1090
|
+
# A message that describes the state of the bucket.
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/BucketState AWS API Documentation
|
1094
|
+
#
|
1095
|
+
class BucketState < Struct.new(
|
1096
|
+
:code,
|
1097
|
+
:message)
|
1098
|
+
SENSITIVE = []
|
1099
|
+
include Aws::Structure
|
1100
|
+
end
|
1101
|
+
|
796
1102
|
# Describes a bundle, which is a set of specs describing your virtual
|
797
1103
|
# private server (or *instance*).
|
798
1104
|
#
|
@@ -1269,12 +1575,12 @@ module Aws::Lightsail
|
|
1269
1575
|
#
|
1270
1576
|
# @!attribute [rw] tags
|
1271
1577
|
# The tag keys and optional values for the resource. For more
|
1272
|
-
# information about tags in Lightsail, see the [Lightsail
|
1273
|
-
# Guide][1].
|
1578
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
1579
|
+
# Developer Guide][1].
|
1274
1580
|
#
|
1275
1581
|
#
|
1276
1582
|
#
|
1277
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
1583
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
1278
1584
|
# @return [Array<Types::Tag>]
|
1279
1585
|
#
|
1280
1586
|
# @!attribute [rw] support_code
|
@@ -1332,12 +1638,12 @@ module Aws::Lightsail
|
|
1332
1638
|
#
|
1333
1639
|
# @!attribute [rw] tags
|
1334
1640
|
# The tag keys and optional values for the resource. For more
|
1335
|
-
# information about tags in Lightsail, see the [Lightsail
|
1336
|
-
# Guide][1].
|
1641
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
1642
|
+
# Developer Guide][1].
|
1337
1643
|
#
|
1338
1644
|
#
|
1339
1645
|
#
|
1340
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
1646
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
1341
1647
|
# @return [Array<Types::Tag>]
|
1342
1648
|
#
|
1343
1649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CertificateSummary AWS API Documentation
|
@@ -1399,7 +1705,7 @@ module Aws::Lightsail
|
|
1399
1705
|
end
|
1400
1706
|
|
1401
1707
|
# Describes a CloudFormation stack record created as a result of the
|
1402
|
-
# `create cloud formation stack`
|
1708
|
+
# `create cloud formation stack` action.
|
1403
1709
|
#
|
1404
1710
|
# A CloudFormation stack record provides information about the AWS
|
1405
1711
|
# CloudFormation stack used to create a new Amazon Elastic Compute Cloud
|
@@ -1659,12 +1965,12 @@ module Aws::Lightsail
|
|
1659
1965
|
#
|
1660
1966
|
# @!attribute [rw] tags
|
1661
1967
|
# The tag keys and optional values for the resource. For more
|
1662
|
-
# information about tags in Lightsail, see the [Lightsail
|
1663
|
-
# Guide][1].
|
1968
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
1969
|
+
# Developer Guide][1].
|
1664
1970
|
#
|
1665
1971
|
#
|
1666
1972
|
#
|
1667
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
1973
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
1668
1974
|
# @return [Array<Types::Tag>]
|
1669
1975
|
#
|
1670
1976
|
# @!attribute [rw] power
|
@@ -1989,7 +2295,9 @@ module Aws::Lightsail
|
|
1989
2295
|
#
|
1990
2296
|
# @!attribute [rw] success_codes
|
1991
2297
|
# The HTTP codes to use when checking for a successful response from a
|
1992
|
-
# container. You can specify values between 200 and 499
|
2298
|
+
# container. You can specify values between `200` and `499`. You can
|
2299
|
+
# specify multiple values (for example, `200,202`) or a range of
|
2300
|
+
# values (for example, `200-299`).
|
1993
2301
|
# @return [String]
|
1994
2302
|
#
|
1995
2303
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ContainerServiceHealthCheckConfig AWS API Documentation
|
@@ -2221,7 +2529,7 @@ module Aws::Lightsail
|
|
2221
2529
|
# restore_date: "string",
|
2222
2530
|
# use_latest_restorable_auto_snapshot: false,
|
2223
2531
|
# target_snapshot_name: "ResourceName", # required
|
2224
|
-
# source_region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2
|
2532
|
+
# source_region: "us-east-1", # required, accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1
|
2225
2533
|
# }
|
2226
2534
|
#
|
2227
2535
|
# @!attribute [rw] source_snapshot_name
|
@@ -2242,8 +2550,8 @@ module Aws::Lightsail
|
|
2242
2550
|
# Constraint:
|
2243
2551
|
#
|
2244
2552
|
# * Define this parameter only when copying an automatic snapshot as a
|
2245
|
-
# manual snapshot. For more information, see the [Lightsail
|
2246
|
-
# Guide][1].
|
2553
|
+
# manual snapshot. For more information, see the [Amazon Lightsail
|
2554
|
+
# Developer Guide][1].
|
2247
2555
|
#
|
2248
2556
|
# ^
|
2249
2557
|
#
|
@@ -2267,8 +2575,8 @@ module Aws::Lightsail
|
|
2267
2575
|
# exclusive.
|
2268
2576
|
#
|
2269
2577
|
# * Define this parameter only when copying an automatic snapshot as a
|
2270
|
-
# manual snapshot. For more information, see the [Lightsail
|
2271
|
-
# Guide][1].
|
2578
|
+
# manual snapshot. For more information, see the [Amazon Lightsail
|
2579
|
+
# Developer Guide][1].
|
2272
2580
|
#
|
2273
2581
|
#
|
2274
2582
|
#
|
@@ -2286,8 +2594,8 @@ module Aws::Lightsail
|
|
2286
2594
|
# date` parameters are mutually exclusive.
|
2287
2595
|
#
|
2288
2596
|
# * Define this parameter only when copying an automatic snapshot as a
|
2289
|
-
# manual snapshot. For more information, see the [Lightsail
|
2290
|
-
# Guide][1].
|
2597
|
+
# manual snapshot. For more information, see the [Amazon Lightsail
|
2598
|
+
# Developer Guide][1].
|
2291
2599
|
#
|
2292
2600
|
#
|
2293
2601
|
#
|
@@ -2330,6 +2638,134 @@ module Aws::Lightsail
|
|
2330
2638
|
include Aws::Structure
|
2331
2639
|
end
|
2332
2640
|
|
2641
|
+
# @note When making an API call, you may pass CreateBucketAccessKeyRequest
|
2642
|
+
# data as a hash:
|
2643
|
+
#
|
2644
|
+
# {
|
2645
|
+
# bucket_name: "BucketName", # required
|
2646
|
+
# }
|
2647
|
+
#
|
2648
|
+
# @!attribute [rw] bucket_name
|
2649
|
+
# The name of the bucket that the new access key will belong to, and
|
2650
|
+
# grant access to.
|
2651
|
+
# @return [String]
|
2652
|
+
#
|
2653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateBucketAccessKeyRequest AWS API Documentation
|
2654
|
+
#
|
2655
|
+
class CreateBucketAccessKeyRequest < Struct.new(
|
2656
|
+
:bucket_name)
|
2657
|
+
SENSITIVE = []
|
2658
|
+
include Aws::Structure
|
2659
|
+
end
|
2660
|
+
|
2661
|
+
# @!attribute [rw] access_key
|
2662
|
+
# An object that describes the access key that is created.
|
2663
|
+
# @return [Types::AccessKey]
|
2664
|
+
#
|
2665
|
+
# @!attribute [rw] operations
|
2666
|
+
# An array of objects that describe the result of the action, such as
|
2667
|
+
# the status of the request, the timestamp of the request, and the
|
2668
|
+
# resources affected by the request.
|
2669
|
+
# @return [Array<Types::Operation>]
|
2670
|
+
#
|
2671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateBucketAccessKeyResult AWS API Documentation
|
2672
|
+
#
|
2673
|
+
class CreateBucketAccessKeyResult < Struct.new(
|
2674
|
+
:access_key,
|
2675
|
+
:operations)
|
2676
|
+
SENSITIVE = []
|
2677
|
+
include Aws::Structure
|
2678
|
+
end
|
2679
|
+
|
2680
|
+
# @note When making an API call, you may pass CreateBucketRequest
|
2681
|
+
# data as a hash:
|
2682
|
+
#
|
2683
|
+
# {
|
2684
|
+
# bucket_name: "BucketName", # required
|
2685
|
+
# bundle_id: "NonEmptyString", # required
|
2686
|
+
# tags: [
|
2687
|
+
# {
|
2688
|
+
# key: "TagKey",
|
2689
|
+
# value: "TagValue",
|
2690
|
+
# },
|
2691
|
+
# ],
|
2692
|
+
# enable_object_versioning: false,
|
2693
|
+
# }
|
2694
|
+
#
|
2695
|
+
# @!attribute [rw] bucket_name
|
2696
|
+
# The name for the bucket.
|
2697
|
+
#
|
2698
|
+
# For more information about bucket names, see [Bucket naming rules in
|
2699
|
+
# Amazon Lightsail][1] in the *Amazon Lightsail Developer Guide*.
|
2700
|
+
#
|
2701
|
+
#
|
2702
|
+
#
|
2703
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/bucket-naming-rules-in-amazon-lightsail
|
2704
|
+
# @return [String]
|
2705
|
+
#
|
2706
|
+
# @!attribute [rw] bundle_id
|
2707
|
+
# The ID of the bundle to use for the bucket.
|
2708
|
+
#
|
2709
|
+
# A bucket bundle specifies the monthly cost, storage space, and data
|
2710
|
+
# transfer quota for a bucket.
|
2711
|
+
#
|
2712
|
+
# Use the GetBucketBundles action to get a list of bundle IDs that you
|
2713
|
+
# can specify.
|
2714
|
+
#
|
2715
|
+
# Use the UpdateBucketBundle action to change the bundle after the
|
2716
|
+
# bucket is created.
|
2717
|
+
# @return [String]
|
2718
|
+
#
|
2719
|
+
# @!attribute [rw] tags
|
2720
|
+
# The tag keys and optional values to add to the bucket during
|
2721
|
+
# creation.
|
2722
|
+
#
|
2723
|
+
# Use the TagResource action to tag the bucket after it's created.
|
2724
|
+
# @return [Array<Types::Tag>]
|
2725
|
+
#
|
2726
|
+
# @!attribute [rw] enable_object_versioning
|
2727
|
+
# A Boolean value that indicates whether to enable versioning of
|
2728
|
+
# objects in the bucket.
|
2729
|
+
#
|
2730
|
+
# For more information about versioning, see [Enabling and suspending
|
2731
|
+
# bucket object versioning in Amazon Lightsail][1] in the *Amazon
|
2732
|
+
# Lightsail Developer Guide*.
|
2733
|
+
#
|
2734
|
+
#
|
2735
|
+
#
|
2736
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning
|
2737
|
+
# @return [Boolean]
|
2738
|
+
#
|
2739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateBucketRequest AWS API Documentation
|
2740
|
+
#
|
2741
|
+
class CreateBucketRequest < Struct.new(
|
2742
|
+
:bucket_name,
|
2743
|
+
:bundle_id,
|
2744
|
+
:tags,
|
2745
|
+
:enable_object_versioning)
|
2746
|
+
SENSITIVE = []
|
2747
|
+
include Aws::Structure
|
2748
|
+
end
|
2749
|
+
|
2750
|
+
# @!attribute [rw] bucket
|
2751
|
+
# An object that describes the bucket that is created.
|
2752
|
+
# @return [Types::Bucket]
|
2753
|
+
#
|
2754
|
+
# @!attribute [rw] operations
|
2755
|
+
# An array of objects that describe the result of the action, such as
|
2756
|
+
# the status of the request, the timestamp of the request, and the
|
2757
|
+
# resources affected by the request.
|
2758
|
+
# @return [Array<Types::Operation>]
|
2759
|
+
#
|
2760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateBucketResult AWS API Documentation
|
2761
|
+
#
|
2762
|
+
class CreateBucketResult < Struct.new(
|
2763
|
+
:bucket,
|
2764
|
+
:operations)
|
2765
|
+
SENSITIVE = []
|
2766
|
+
include Aws::Structure
|
2767
|
+
end
|
2768
|
+
|
2333
2769
|
# @note When making an API call, you may pass CreateCertificateRequest
|
2334
2770
|
# data as a hash:
|
2335
2771
|
#
|
@@ -2707,14 +3143,17 @@ module Aws::Lightsail
|
|
2707
3143
|
# @return [Integer]
|
2708
3144
|
#
|
2709
3145
|
# @!attribute [rw] tags
|
2710
|
-
# The tag keys and optional values
|
3146
|
+
# The tag keys and optional values to add to the certificate during
|
3147
|
+
# create.
|
2711
3148
|
#
|
2712
|
-
#
|
2713
|
-
# Guide][1].
|
3149
|
+
# Use the `TagResource` action to tag a resource after it's created.
|
2714
3150
|
#
|
3151
|
+
# For more information about tags in Lightsail, see the [Amazon
|
3152
|
+
# Lightsail Developer Guide][1].
|
2715
3153
|
#
|
2716
3154
|
#
|
2717
|
-
#
|
3155
|
+
#
|
3156
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
2718
3157
|
# @return [Array<Types::Tag>]
|
2719
3158
|
#
|
2720
3159
|
# @!attribute [rw] public_domain_names
|
@@ -2854,8 +3293,8 @@ module Aws::Lightsail
|
|
2854
3293
|
# parameters are mutually exclusive.
|
2855
3294
|
#
|
2856
3295
|
# * Define this parameter only when creating a new disk from an
|
2857
|
-
# automatic snapshot. For more information, see the [
|
2858
|
-
# Guide][1].
|
3296
|
+
# automatic snapshot. For more information, see the [Amazon
|
3297
|
+
# Lightsail Developer Guide][1].
|
2859
3298
|
#
|
2860
3299
|
#
|
2861
3300
|
#
|
@@ -2877,8 +3316,8 @@ module Aws::Lightsail
|
|
2877
3316
|
# exclusive.
|
2878
3317
|
#
|
2879
3318
|
# * Define this parameter only when creating a new disk from an
|
2880
|
-
# automatic snapshot. For more information, see the [
|
2881
|
-
# Guide][1].
|
3319
|
+
# automatic snapshot. For more information, see the [Amazon
|
3320
|
+
# Lightsail Developer Guide][1].
|
2882
3321
|
#
|
2883
3322
|
#
|
2884
3323
|
#
|
@@ -2896,8 +3335,8 @@ module Aws::Lightsail
|
|
2896
3335
|
# date` parameters are mutually exclusive.
|
2897
3336
|
#
|
2898
3337
|
# * Define this parameter only when creating a new disk from an
|
2899
|
-
# automatic snapshot. For more information, see the [
|
2900
|
-
# Guide][1].
|
3338
|
+
# automatic snapshot. For more information, see the [Amazon
|
3339
|
+
# Lightsail Developer Guide][1].
|
2901
3340
|
#
|
2902
3341
|
#
|
2903
3342
|
#
|
@@ -3093,7 +3532,7 @@ module Aws::Lightsail
|
|
3093
3532
|
# distribution_name: "ResourceName", # required
|
3094
3533
|
# origin: { # required
|
3095
3534
|
# name: "ResourceName",
|
3096
|
-
# region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2
|
3535
|
+
# region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1
|
3097
3536
|
# protocol_policy: "http-only", # accepts http-only, https-only
|
3098
3537
|
# },
|
3099
3538
|
# default_cache_behavior: { # required
|
@@ -3464,13 +3903,13 @@ module Aws::Lightsail
|
|
3464
3903
|
# <note markdown="1"> Depending on the machine image you choose, the command to get
|
3465
3904
|
# software on your instance varies. Amazon Linux and CentOS use `yum`,
|
3466
3905
|
# Debian and Ubuntu use `apt-get`, and FreeBSD uses `pkg`. For a
|
3467
|
-
# complete list, see the [
|
3906
|
+
# complete list, see the [Amazon Lightsail Developer Guide][1].
|
3468
3907
|
#
|
3469
3908
|
# </note>
|
3470
3909
|
#
|
3471
3910
|
#
|
3472
3911
|
#
|
3473
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
3912
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image
|
3474
3913
|
# @return [String]
|
3475
3914
|
#
|
3476
3915
|
# @!attribute [rw] key_pair_name
|
@@ -3509,8 +3948,8 @@ module Aws::Lightsail
|
|
3509
3948
|
# snapshot name` parameters are mutually exclusive.
|
3510
3949
|
#
|
3511
3950
|
# * Define this parameter only when creating a new instance from an
|
3512
|
-
# automatic snapshot. For more information, see the [
|
3513
|
-
# Guide][1].
|
3951
|
+
# automatic snapshot. For more information, see the [Amazon
|
3952
|
+
# Lightsail Developer Guide][1].
|
3514
3953
|
#
|
3515
3954
|
#
|
3516
3955
|
#
|
@@ -3532,8 +3971,8 @@ module Aws::Lightsail
|
|
3532
3971
|
# exclusive.
|
3533
3972
|
#
|
3534
3973
|
# * Define this parameter only when creating a new instance from an
|
3535
|
-
# automatic snapshot. For more information, see the [
|
3536
|
-
# Guide][1].
|
3974
|
+
# automatic snapshot. For more information, see the [Amazon
|
3975
|
+
# Lightsail Developer Guide][1].
|
3537
3976
|
#
|
3538
3977
|
#
|
3539
3978
|
#
|
@@ -3551,8 +3990,8 @@ module Aws::Lightsail
|
|
3551
3990
|
# date` parameters are mutually exclusive.
|
3552
3991
|
#
|
3553
3992
|
# * Define this parameter only when creating a new instance from an
|
3554
|
-
# automatic snapshot. For more information, see the [
|
3555
|
-
# Guide][1].
|
3993
|
+
# automatic snapshot. For more information, see the [Amazon
|
3994
|
+
# Lightsail Developer Guide][1].
|
3556
3995
|
#
|
3557
3996
|
#
|
3558
3997
|
#
|
@@ -3676,13 +4115,13 @@ module Aws::Lightsail
|
|
3676
4115
|
# <note markdown="1"> Depending on the machine image you choose, the command to get
|
3677
4116
|
# software on your instance varies. Amazon Linux and CentOS use `yum`,
|
3678
4117
|
# Debian and Ubuntu use `apt-get`, and FreeBSD uses `pkg`. For a
|
3679
|
-
# complete list, see the [
|
4118
|
+
# complete list, see the [Amazon Lightsail Developer Guide][1].
|
3680
4119
|
#
|
3681
4120
|
# </note>
|
3682
4121
|
#
|
3683
4122
|
#
|
3684
4123
|
#
|
3685
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
4124
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image
|
3686
4125
|
# @return [String]
|
3687
4126
|
#
|
3688
4127
|
# @!attribute [rw] key_pair_name
|
@@ -4518,6 +4957,106 @@ module Aws::Lightsail
|
|
4518
4957
|
include Aws::Structure
|
4519
4958
|
end
|
4520
4959
|
|
4960
|
+
# @note When making an API call, you may pass DeleteBucketAccessKeyRequest
|
4961
|
+
# data as a hash:
|
4962
|
+
#
|
4963
|
+
# {
|
4964
|
+
# bucket_name: "BucketName", # required
|
4965
|
+
# access_key_id: "NonEmptyString", # required
|
4966
|
+
# }
|
4967
|
+
#
|
4968
|
+
# @!attribute [rw] bucket_name
|
4969
|
+
# The name of the bucket that the access key belongs to.
|
4970
|
+
# @return [String]
|
4971
|
+
#
|
4972
|
+
# @!attribute [rw] access_key_id
|
4973
|
+
# The ID of the access key to delete.
|
4974
|
+
#
|
4975
|
+
# Use the GetBucketAccessKeys action to get a list of access key IDs
|
4976
|
+
# that you can specify.
|
4977
|
+
# @return [String]
|
4978
|
+
#
|
4979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteBucketAccessKeyRequest AWS API Documentation
|
4980
|
+
#
|
4981
|
+
class DeleteBucketAccessKeyRequest < Struct.new(
|
4982
|
+
:bucket_name,
|
4983
|
+
:access_key_id)
|
4984
|
+
SENSITIVE = []
|
4985
|
+
include Aws::Structure
|
4986
|
+
end
|
4987
|
+
|
4988
|
+
# @!attribute [rw] operations
|
4989
|
+
# An array of objects that describe the result of the action, such as
|
4990
|
+
# the status of the request, the timestamp of the request, and the
|
4991
|
+
# resources affected by the request.
|
4992
|
+
# @return [Array<Types::Operation>]
|
4993
|
+
#
|
4994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteBucketAccessKeyResult AWS API Documentation
|
4995
|
+
#
|
4996
|
+
class DeleteBucketAccessKeyResult < Struct.new(
|
4997
|
+
:operations)
|
4998
|
+
SENSITIVE = []
|
4999
|
+
include Aws::Structure
|
5000
|
+
end
|
5001
|
+
|
5002
|
+
# @note When making an API call, you may pass DeleteBucketRequest
|
5003
|
+
# data as a hash:
|
5004
|
+
#
|
5005
|
+
# {
|
5006
|
+
# bucket_name: "BucketName", # required
|
5007
|
+
# force_delete: false,
|
5008
|
+
# }
|
5009
|
+
#
|
5010
|
+
# @!attribute [rw] bucket_name
|
5011
|
+
# The name of the bucket to delete.
|
5012
|
+
#
|
5013
|
+
# Use the GetBuckets action to get a list of bucket names that you can
|
5014
|
+
# specify.
|
5015
|
+
# @return [String]
|
5016
|
+
#
|
5017
|
+
# @!attribute [rw] force_delete
|
5018
|
+
# A Boolean value that indicates whether to force delete the bucket.
|
5019
|
+
#
|
5020
|
+
# You must force delete the bucket if it has one of the following
|
5021
|
+
# conditions:
|
5022
|
+
#
|
5023
|
+
# * The bucket is the origin of a distribution.
|
5024
|
+
#
|
5025
|
+
# * The bucket has instances that were granted access to it using the
|
5026
|
+
# SetResourceAccessForBucket action.
|
5027
|
+
#
|
5028
|
+
# * The bucket has objects.
|
5029
|
+
#
|
5030
|
+
# * The bucket has access keys.
|
5031
|
+
#
|
5032
|
+
# Force deleting a bucket might impact other resources that rely on
|
5033
|
+
# the bucket, such as instances, distributions, or software that use
|
5034
|
+
# the issued access keys.
|
5035
|
+
# @return [Boolean]
|
5036
|
+
#
|
5037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteBucketRequest AWS API Documentation
|
5038
|
+
#
|
5039
|
+
class DeleteBucketRequest < Struct.new(
|
5040
|
+
:bucket_name,
|
5041
|
+
:force_delete)
|
5042
|
+
SENSITIVE = []
|
5043
|
+
include Aws::Structure
|
5044
|
+
end
|
5045
|
+
|
5046
|
+
# @!attribute [rw] operations
|
5047
|
+
# An array of objects that describe the result of the action, such as
|
5048
|
+
# the status of the request, the timestamp of the request, and the
|
5049
|
+
# resources affected by the request.
|
5050
|
+
# @return [Array<Types::Operation>]
|
5051
|
+
#
|
5052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DeleteBucketResult AWS API Documentation
|
5053
|
+
#
|
5054
|
+
class DeleteBucketResult < Struct.new(
|
5055
|
+
:operations)
|
5056
|
+
SENSITIVE = []
|
5057
|
+
include Aws::Structure
|
5058
|
+
end
|
5059
|
+
|
4521
5060
|
# @note When making an API call, you may pass DeleteCertificateRequest
|
4522
5061
|
# data as a hash:
|
4523
5062
|
#
|
@@ -5373,7 +5912,7 @@ module Aws::Lightsail
|
|
5373
5912
|
include Aws::Structure
|
5374
5913
|
end
|
5375
5914
|
|
5376
|
-
# Describes a
|
5915
|
+
# Describes a block storage disk.
|
5377
5916
|
#
|
5378
5917
|
# @!attribute [rw] name
|
5379
5918
|
# The unique name of the disk.
|
@@ -5404,12 +5943,12 @@ module Aws::Lightsail
|
|
5404
5943
|
#
|
5405
5944
|
# @!attribute [rw] tags
|
5406
5945
|
# The tag keys and optional values for the resource. For more
|
5407
|
-
# information about tags in Lightsail, see the [Lightsail
|
5408
|
-
# Guide][1].
|
5946
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
5947
|
+
# Developer Guide][1].
|
5409
5948
|
#
|
5410
5949
|
#
|
5411
5950
|
#
|
5412
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
5951
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
5413
5952
|
# @return [Array<Types::Tag>]
|
5414
5953
|
#
|
5415
5954
|
# @!attribute [rw] add_ons
|
@@ -5579,12 +6118,12 @@ module Aws::Lightsail
|
|
5579
6118
|
#
|
5580
6119
|
# @!attribute [rw] tags
|
5581
6120
|
# The tag keys and optional values for the resource. For more
|
5582
|
-
# information about tags in Lightsail, see the [Lightsail
|
5583
|
-
# Guide][1].
|
6121
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
6122
|
+
# Developer Guide][1].
|
5584
6123
|
#
|
5585
6124
|
#
|
5586
6125
|
#
|
5587
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
6126
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
5588
6127
|
# @return [Array<Types::Tag>]
|
5589
6128
|
#
|
5590
6129
|
# @!attribute [rw] size_in_gb
|
@@ -5680,7 +6219,7 @@ module Aws::Lightsail
|
|
5680
6219
|
#
|
5681
6220
|
# @!attribute [rw] is_active
|
5682
6221
|
# Indicates whether the bundle is active, and can be specified for a
|
5683
|
-
# new distribution.
|
6222
|
+
# new or existing distribution.
|
5684
6223
|
# @return [Boolean]
|
5685
6224
|
#
|
5686
6225
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/DistributionBundle AWS API Documentation
|
@@ -5695,7 +6234,7 @@ module Aws::Lightsail
|
|
5695
6234
|
include Aws::Structure
|
5696
6235
|
end
|
5697
6236
|
|
5698
|
-
# Describes a domain where you are storing recordsets
|
6237
|
+
# Describes a domain where you are storing recordsets.
|
5699
6238
|
#
|
5700
6239
|
# @!attribute [rw] name
|
5701
6240
|
# The name of the domain.
|
@@ -5728,12 +6267,12 @@ module Aws::Lightsail
|
|
5728
6267
|
#
|
5729
6268
|
# @!attribute [rw] tags
|
5730
6269
|
# The tag keys and optional values for the resource. For more
|
5731
|
-
# information about tags in Lightsail, see the [Lightsail
|
5732
|
-
# Guide][1].
|
6270
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
6271
|
+
# Developer Guide][1].
|
5733
6272
|
#
|
5734
6273
|
#
|
5735
6274
|
#
|
5736
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
6275
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
5737
6276
|
# @return [Array<Types::Tag>]
|
5738
6277
|
#
|
5739
6278
|
# @!attribute [rw] domain_entries
|
@@ -6178,135 +6717,396 @@ module Aws::Lightsail
|
|
6178
6717
|
# @!attribute [rw] alarm_name
|
6179
6718
|
# The name of the alarm.
|
6180
6719
|
#
|
6181
|
-
# Specify an alarm name to return information about a specific alarm.
|
6720
|
+
# Specify an alarm name to return information about a specific alarm.
|
6721
|
+
# @return [String]
|
6722
|
+
#
|
6723
|
+
# @!attribute [rw] page_token
|
6724
|
+
# The token to advance to the next page of results from your request.
|
6725
|
+
#
|
6726
|
+
# To get a page token, perform an initial `GetAlarms` request. If your
|
6727
|
+
# results are paginated, the response will return a next page token
|
6728
|
+
# that you can specify as the page token in a subsequent request.
|
6729
|
+
# @return [String]
|
6730
|
+
#
|
6731
|
+
# @!attribute [rw] monitored_resource_name
|
6732
|
+
# The name of the Lightsail resource being monitored by the alarm.
|
6733
|
+
#
|
6734
|
+
# Specify a monitored resource name to return information about all
|
6735
|
+
# alarms for a specific resource.
|
6736
|
+
# @return [String]
|
6737
|
+
#
|
6738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAlarmsRequest AWS API Documentation
|
6739
|
+
#
|
6740
|
+
class GetAlarmsRequest < Struct.new(
|
6741
|
+
:alarm_name,
|
6742
|
+
:page_token,
|
6743
|
+
:monitored_resource_name)
|
6744
|
+
SENSITIVE = []
|
6745
|
+
include Aws::Structure
|
6746
|
+
end
|
6747
|
+
|
6748
|
+
# @!attribute [rw] alarms
|
6749
|
+
# An array of objects that describe the alarms.
|
6750
|
+
# @return [Array<Types::Alarm>]
|
6751
|
+
#
|
6752
|
+
# @!attribute [rw] next_page_token
|
6753
|
+
# The token to advance to the next page of results from your request.
|
6754
|
+
#
|
6755
|
+
# A next page token is not returned if there are no more results to
|
6756
|
+
# display.
|
6757
|
+
#
|
6758
|
+
# To get the next page of results, perform another `GetAlarms` request
|
6759
|
+
# and specify the next page token using the `pageToken` parameter.
|
6760
|
+
# @return [String]
|
6761
|
+
#
|
6762
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAlarmsResult AWS API Documentation
|
6763
|
+
#
|
6764
|
+
class GetAlarmsResult < Struct.new(
|
6765
|
+
:alarms,
|
6766
|
+
:next_page_token)
|
6767
|
+
SENSITIVE = []
|
6768
|
+
include Aws::Structure
|
6769
|
+
end
|
6770
|
+
|
6771
|
+
# @note When making an API call, you may pass GetAutoSnapshotsRequest
|
6772
|
+
# data as a hash:
|
6773
|
+
#
|
6774
|
+
# {
|
6775
|
+
# resource_name: "ResourceName", # required
|
6776
|
+
# }
|
6777
|
+
#
|
6778
|
+
# @!attribute [rw] resource_name
|
6779
|
+
# The name of the source instance or disk from which to get automatic
|
6780
|
+
# snapshot information.
|
6781
|
+
# @return [String]
|
6782
|
+
#
|
6783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAutoSnapshotsRequest AWS API Documentation
|
6784
|
+
#
|
6785
|
+
class GetAutoSnapshotsRequest < Struct.new(
|
6786
|
+
:resource_name)
|
6787
|
+
SENSITIVE = []
|
6788
|
+
include Aws::Structure
|
6789
|
+
end
|
6790
|
+
|
6791
|
+
# @!attribute [rw] resource_name
|
6792
|
+
# The name of the source instance or disk for the automatic snapshots.
|
6793
|
+
# @return [String]
|
6794
|
+
#
|
6795
|
+
# @!attribute [rw] resource_type
|
6796
|
+
# The resource type (e.g., `Instance` or `Disk`).
|
6797
|
+
# @return [String]
|
6798
|
+
#
|
6799
|
+
# @!attribute [rw] auto_snapshots
|
6800
|
+
# An array of objects that describe the automatic snapshots that are
|
6801
|
+
# available for the specified source instance or disk.
|
6802
|
+
# @return [Array<Types::AutoSnapshotDetails>]
|
6803
|
+
#
|
6804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetAutoSnapshotsResult AWS API Documentation
|
6805
|
+
#
|
6806
|
+
class GetAutoSnapshotsResult < Struct.new(
|
6807
|
+
:resource_name,
|
6808
|
+
:resource_type,
|
6809
|
+
:auto_snapshots)
|
6810
|
+
SENSITIVE = []
|
6811
|
+
include Aws::Structure
|
6812
|
+
end
|
6813
|
+
|
6814
|
+
# @note When making an API call, you may pass GetBlueprintsRequest
|
6815
|
+
# data as a hash:
|
6816
|
+
#
|
6817
|
+
# {
|
6818
|
+
# include_inactive: false,
|
6819
|
+
# page_token: "string",
|
6820
|
+
# }
|
6821
|
+
#
|
6822
|
+
# @!attribute [rw] include_inactive
|
6823
|
+
# A Boolean value indicating whether to include inactive results in
|
6824
|
+
# your request.
|
6825
|
+
# @return [Boolean]
|
6826
|
+
#
|
6827
|
+
# @!attribute [rw] page_token
|
6828
|
+
# The token to advance to the next page of results from your request.
|
6829
|
+
#
|
6830
|
+
# To get a page token, perform an initial `GetBlueprints` request. If
|
6831
|
+
# your results are paginated, the response will return a next page
|
6832
|
+
# token that you can specify as the page token in a subsequent
|
6833
|
+
# request.
|
6834
|
+
# @return [String]
|
6835
|
+
#
|
6836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprintsRequest AWS API Documentation
|
6837
|
+
#
|
6838
|
+
class GetBlueprintsRequest < Struct.new(
|
6839
|
+
:include_inactive,
|
6840
|
+
:page_token)
|
6841
|
+
SENSITIVE = []
|
6842
|
+
include Aws::Structure
|
6843
|
+
end
|
6844
|
+
|
6845
|
+
# @!attribute [rw] blueprints
|
6846
|
+
# An array of key-value pairs that contains information about the
|
6847
|
+
# available blueprints.
|
6848
|
+
# @return [Array<Types::Blueprint>]
|
6849
|
+
#
|
6850
|
+
# @!attribute [rw] next_page_token
|
6851
|
+
# The token to advance to the next page of results from your request.
|
6852
|
+
#
|
6853
|
+
# A next page token is not returned if there are no more results to
|
6854
|
+
# display.
|
6855
|
+
#
|
6856
|
+
# To get the next page of results, perform another `GetBlueprints`
|
6857
|
+
# request and specify the next page token using the `pageToken`
|
6858
|
+
# parameter.
|
6859
|
+
# @return [String]
|
6860
|
+
#
|
6861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBlueprintsResult AWS API Documentation
|
6862
|
+
#
|
6863
|
+
class GetBlueprintsResult < Struct.new(
|
6864
|
+
:blueprints,
|
6865
|
+
:next_page_token)
|
6866
|
+
SENSITIVE = []
|
6867
|
+
include Aws::Structure
|
6868
|
+
end
|
6869
|
+
|
6870
|
+
# @note When making an API call, you may pass GetBucketAccessKeysRequest
|
6871
|
+
# data as a hash:
|
6872
|
+
#
|
6873
|
+
# {
|
6874
|
+
# bucket_name: "BucketName", # required
|
6875
|
+
# }
|
6876
|
+
#
|
6877
|
+
# @!attribute [rw] bucket_name
|
6878
|
+
# The name of the bucket for which to return access keys.
|
6879
|
+
# @return [String]
|
6880
|
+
#
|
6881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketAccessKeysRequest AWS API Documentation
|
6882
|
+
#
|
6883
|
+
class GetBucketAccessKeysRequest < Struct.new(
|
6884
|
+
:bucket_name)
|
6885
|
+
SENSITIVE = []
|
6886
|
+
include Aws::Structure
|
6887
|
+
end
|
6888
|
+
|
6889
|
+
# @!attribute [rw] access_keys
|
6890
|
+
# An object that describes the access keys for the specified bucket.
|
6891
|
+
# @return [Array<Types::AccessKey>]
|
6892
|
+
#
|
6893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketAccessKeysResult AWS API Documentation
|
6894
|
+
#
|
6895
|
+
class GetBucketAccessKeysResult < Struct.new(
|
6896
|
+
:access_keys)
|
6897
|
+
SENSITIVE = []
|
6898
|
+
include Aws::Structure
|
6899
|
+
end
|
6900
|
+
|
6901
|
+
# @note When making an API call, you may pass GetBucketBundlesRequest
|
6902
|
+
# data as a hash:
|
6903
|
+
#
|
6904
|
+
# {
|
6905
|
+
# include_inactive: false,
|
6906
|
+
# }
|
6907
|
+
#
|
6908
|
+
# @!attribute [rw] include_inactive
|
6909
|
+
# A Boolean value that indicates whether to include inactive
|
6910
|
+
# (unavailable) bundles in the response.
|
6911
|
+
# @return [Boolean]
|
6912
|
+
#
|
6913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketBundlesRequest AWS API Documentation
|
6914
|
+
#
|
6915
|
+
class GetBucketBundlesRequest < Struct.new(
|
6916
|
+
:include_inactive)
|
6917
|
+
SENSITIVE = []
|
6918
|
+
include Aws::Structure
|
6919
|
+
end
|
6920
|
+
|
6921
|
+
# @!attribute [rw] bundles
|
6922
|
+
# An object that describes bucket bundles.
|
6923
|
+
# @return [Array<Types::BucketBundle>]
|
6924
|
+
#
|
6925
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketBundlesResult AWS API Documentation
|
6926
|
+
#
|
6927
|
+
class GetBucketBundlesResult < Struct.new(
|
6928
|
+
:bundles)
|
6929
|
+
SENSITIVE = []
|
6930
|
+
include Aws::Structure
|
6931
|
+
end
|
6932
|
+
|
6933
|
+
# @note When making an API call, you may pass GetBucketMetricDataRequest
|
6934
|
+
# data as a hash:
|
6935
|
+
#
|
6936
|
+
# {
|
6937
|
+
# bucket_name: "BucketName", # required
|
6938
|
+
# metric_name: "BucketSizeBytes", # required, accepts BucketSizeBytes, NumberOfObjects
|
6939
|
+
# start_time: Time.now, # required
|
6940
|
+
# end_time: Time.now, # required
|
6941
|
+
# period: 1, # required
|
6942
|
+
# statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
|
6943
|
+
# 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
|
6944
|
+
# }
|
6945
|
+
#
|
6946
|
+
# @!attribute [rw] bucket_name
|
6947
|
+
# The name of the bucket for which to get metric data.
|
6948
|
+
# @return [String]
|
6949
|
+
#
|
6950
|
+
# @!attribute [rw] metric_name
|
6951
|
+
# The metric for which you want to return information.
|
6952
|
+
#
|
6953
|
+
# Valid bucket metric names are listed below, along with the most
|
6954
|
+
# useful statistics to include in your request, and the published unit
|
6955
|
+
# value.
|
6956
|
+
#
|
6957
|
+
# <note markdown="1"> These bucket metrics are reported once per day.
|
6958
|
+
#
|
6959
|
+
# </note>
|
6960
|
+
#
|
6961
|
+
# * <b> <code>BucketSizeBytes</code> </b> - The amount of data in
|
6962
|
+
# bytes stored in a bucket. This value is calculated by summing the
|
6963
|
+
# size of all objects in the bucket (including object versions),
|
6964
|
+
# including the size of all parts for all incomplete multipart
|
6965
|
+
# uploads to the bucket.
|
6966
|
+
#
|
6967
|
+
# Statistics: The most useful statistic is `Maximum`.
|
6968
|
+
#
|
6969
|
+
# Unit: The published unit is `Bytes`.
|
6970
|
+
#
|
6971
|
+
# * <b> <code>NumberOfObjects</code> </b> - The total number of
|
6972
|
+
# objects stored in a bucket. This value is calculated by counting
|
6973
|
+
# all objects in the bucket (including object versions) and the
|
6974
|
+
# total number of parts for all incomplete multipart uploads to the
|
6975
|
+
# bucket.
|
6976
|
+
#
|
6977
|
+
# Statistics: The most useful statistic is `Average`.
|
6978
|
+
#
|
6979
|
+
# Unit: The published unit is `Count`.
|
6182
6980
|
# @return [String]
|
6183
6981
|
#
|
6184
|
-
# @!attribute [rw]
|
6185
|
-
# The
|
6982
|
+
# @!attribute [rw] start_time
|
6983
|
+
# The timestamp indicating the earliest data to be returned.
|
6984
|
+
# @return [Time]
|
6186
6985
|
#
|
6187
|
-
#
|
6188
|
-
#
|
6189
|
-
#
|
6190
|
-
# @return [String]
|
6986
|
+
# @!attribute [rw] end_time
|
6987
|
+
# The timestamp indicating the latest data to be returned.
|
6988
|
+
# @return [Time]
|
6191
6989
|
#
|
6192
|
-
# @!attribute [rw]
|
6193
|
-
# The
|
6990
|
+
# @!attribute [rw] period
|
6991
|
+
# The granularity, in seconds, of the returned data points.
|
6194
6992
|
#
|
6195
|
-
#
|
6196
|
-
#
|
6197
|
-
#
|
6993
|
+
# <note markdown="1"> Bucket storage metrics are reported once per day. Therefore, you
|
6994
|
+
# should specify a period of 86400 seconds, which is the number of
|
6995
|
+
# seconds in a day.
|
6198
6996
|
#
|
6199
|
-
#
|
6997
|
+
# </note>
|
6998
|
+
# @return [Integer]
|
6200
6999
|
#
|
6201
|
-
|
6202
|
-
|
6203
|
-
:page_token,
|
6204
|
-
:monitored_resource_name)
|
6205
|
-
SENSITIVE = []
|
6206
|
-
include Aws::Structure
|
6207
|
-
end
|
6208
|
-
|
6209
|
-
# @!attribute [rw] alarms
|
6210
|
-
# An array of objects that describe the alarms.
|
6211
|
-
# @return [Array<Types::Alarm>]
|
7000
|
+
# @!attribute [rw] statistics
|
7001
|
+
# The statistic for the metric.
|
6212
7002
|
#
|
6213
|
-
#
|
6214
|
-
# The token to advance to the next page of results from your request.
|
7003
|
+
# The following statistics are available:
|
6215
7004
|
#
|
6216
|
-
#
|
6217
|
-
#
|
7005
|
+
# * `Minimum` - The lowest value observed during the specified period.
|
7006
|
+
# Use this value to determine low volumes of activity for your
|
7007
|
+
# application.
|
6218
7008
|
#
|
6219
|
-
#
|
6220
|
-
#
|
6221
|
-
#
|
7009
|
+
# * `Maximum` - The highest value observed during the specified
|
7010
|
+
# period. Use this value to determine high volumes of activity for
|
7011
|
+
# your application.
|
6222
7012
|
#
|
6223
|
-
#
|
7013
|
+
# * `Sum` - The sum of all values submitted for the matching metric.
|
7014
|
+
# You can use this statistic to determine the total volume of a
|
7015
|
+
# metric.
|
6224
7016
|
#
|
6225
|
-
|
6226
|
-
|
6227
|
-
|
6228
|
-
|
6229
|
-
|
6230
|
-
|
6231
|
-
|
6232
|
-
# @note When making an API call, you may pass GetAutoSnapshotsRequest
|
6233
|
-
# data as a hash:
|
7017
|
+
# * `Average` - The value of `Sum` / `SampleCount` during the
|
7018
|
+
# specified period. By comparing this statistic with the `Minimum`
|
7019
|
+
# and `Maximum` values, you can determine the full scope of a metric
|
7020
|
+
# and how close the average use is to the `Minimum` and `Maximum`
|
7021
|
+
# values. This comparison helps you to know when to increase or
|
7022
|
+
# decrease your resources.
|
6234
7023
|
#
|
6235
|
-
#
|
6236
|
-
#
|
6237
|
-
#
|
7024
|
+
# * `SampleCount` - The count, or number, of data points used for the
|
7025
|
+
# statistical calculation.
|
7026
|
+
# @return [Array<String>]
|
6238
7027
|
#
|
6239
|
-
# @!attribute [rw]
|
6240
|
-
# The
|
6241
|
-
#
|
7028
|
+
# @!attribute [rw] unit
|
7029
|
+
# The unit for the metric data request.
|
7030
|
+
#
|
7031
|
+
# Valid units depend on the metric data being requested. For the valid
|
7032
|
+
# units with each available metric, see the `metricName` parameter.
|
6242
7033
|
# @return [String]
|
6243
7034
|
#
|
6244
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/
|
7035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketMetricDataRequest AWS API Documentation
|
6245
7036
|
#
|
6246
|
-
class
|
6247
|
-
:
|
7037
|
+
class GetBucketMetricDataRequest < Struct.new(
|
7038
|
+
:bucket_name,
|
7039
|
+
:metric_name,
|
7040
|
+
:start_time,
|
7041
|
+
:end_time,
|
7042
|
+
:period,
|
7043
|
+
:statistics,
|
7044
|
+
:unit)
|
6248
7045
|
SENSITIVE = []
|
6249
7046
|
include Aws::Structure
|
6250
7047
|
end
|
6251
7048
|
|
6252
|
-
# @!attribute [rw]
|
6253
|
-
# The name of the
|
6254
|
-
# @return [String]
|
6255
|
-
#
|
6256
|
-
# @!attribute [rw] resource_type
|
6257
|
-
# The resource type (e.g., `Instance` or `Disk`).
|
7049
|
+
# @!attribute [rw] metric_name
|
7050
|
+
# The name of the metric returned.
|
6258
7051
|
# @return [String]
|
6259
7052
|
#
|
6260
|
-
# @!attribute [rw]
|
6261
|
-
# An array of objects that describe the
|
6262
|
-
#
|
6263
|
-
# @return [Array<Types::AutoSnapshotDetails>]
|
7053
|
+
# @!attribute [rw] metric_data
|
7054
|
+
# An array of objects that describe the metric data returned.
|
7055
|
+
# @return [Array<Types::MetricDatapoint>]
|
6264
7056
|
#
|
6265
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/
|
7057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketMetricDataResult AWS API Documentation
|
6266
7058
|
#
|
6267
|
-
class
|
6268
|
-
:
|
6269
|
-
:
|
6270
|
-
:auto_snapshots)
|
7059
|
+
class GetBucketMetricDataResult < Struct.new(
|
7060
|
+
:metric_name,
|
7061
|
+
:metric_data)
|
6271
7062
|
SENSITIVE = []
|
6272
7063
|
include Aws::Structure
|
6273
7064
|
end
|
6274
7065
|
|
6275
|
-
# @note When making an API call, you may pass
|
7066
|
+
# @note When making an API call, you may pass GetBucketsRequest
|
6276
7067
|
# data as a hash:
|
6277
7068
|
#
|
6278
7069
|
# {
|
6279
|
-
#
|
7070
|
+
# bucket_name: "BucketName",
|
6280
7071
|
# page_token: "string",
|
7072
|
+
# include_connected_resources: false,
|
6281
7073
|
# }
|
6282
7074
|
#
|
6283
|
-
# @!attribute [rw]
|
6284
|
-
#
|
6285
|
-
#
|
6286
|
-
#
|
7075
|
+
# @!attribute [rw] bucket_name
|
7076
|
+
# The name of the bucket for which to return information.
|
7077
|
+
#
|
7078
|
+
# When omitted, the response includes all of your buckets in the AWS
|
7079
|
+
# Region where the request is made.
|
7080
|
+
# @return [String]
|
6287
7081
|
#
|
6288
7082
|
# @!attribute [rw] page_token
|
6289
7083
|
# The token to advance to the next page of results from your request.
|
6290
7084
|
#
|
6291
|
-
# To get a page token, perform an initial `
|
7085
|
+
# To get a page token, perform an initial `GetBuckets` request. If
|
6292
7086
|
# your results are paginated, the response will return a next page
|
6293
7087
|
# token that you can specify as the page token in a subsequent
|
6294
7088
|
# request.
|
6295
7089
|
# @return [String]
|
6296
7090
|
#
|
6297
|
-
#
|
7091
|
+
# @!attribute [rw] include_connected_resources
|
7092
|
+
# A Boolean value that indicates whether to include Lightsail
|
7093
|
+
# instances that were given access to the bucket using the
|
7094
|
+
# SetResourceAccessForBucket action.
|
7095
|
+
# @return [Boolean]
|
6298
7096
|
#
|
6299
|
-
|
6300
|
-
|
6301
|
-
|
7097
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketsRequest AWS API Documentation
|
7098
|
+
#
|
7099
|
+
class GetBucketsRequest < Struct.new(
|
7100
|
+
:bucket_name,
|
7101
|
+
:page_token,
|
7102
|
+
:include_connected_resources)
|
6302
7103
|
SENSITIVE = []
|
6303
7104
|
include Aws::Structure
|
6304
7105
|
end
|
6305
7106
|
|
6306
|
-
# @!attribute [rw]
|
6307
|
-
# An array of
|
6308
|
-
#
|
6309
|
-
# @return [Array<Types::Blueprint>]
|
7107
|
+
# @!attribute [rw] buckets
|
7108
|
+
# An array of objects that describe buckets.
|
7109
|
+
# @return [Array<Types::Bucket>]
|
6310
7110
|
#
|
6311
7111
|
# @!attribute [rw] next_page_token
|
6312
7112
|
# The token to advance to the next page of results from your request.
|
@@ -6314,15 +7114,15 @@ module Aws::Lightsail
|
|
6314
7114
|
# A next page token is not returned if there are no more results to
|
6315
7115
|
# display.
|
6316
7116
|
#
|
6317
|
-
# To get the next page of results, perform another `
|
7117
|
+
# To get the next page of results, perform another `GetBuckets`
|
6318
7118
|
# request and specify the next page token using the `pageToken`
|
6319
7119
|
# parameter.
|
6320
7120
|
# @return [String]
|
6321
7121
|
#
|
6322
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/
|
7122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetBucketsResult AWS API Documentation
|
6323
7123
|
#
|
6324
|
-
class
|
6325
|
-
:
|
7124
|
+
class GetBucketsResult < Struct.new(
|
7125
|
+
:buckets,
|
6326
7126
|
:next_page_token)
|
6327
7127
|
SENSITIVE = []
|
6328
7128
|
include Aws::Structure
|
@@ -7316,9 +8116,6 @@ module Aws::Lightsail
|
|
7316
8116
|
# @!attribute [rw] distribution_name
|
7317
8117
|
# The name of the distribution for which to return information.
|
7318
8118
|
#
|
7319
|
-
# Use the `GetDistributions` action to get a list of distribution
|
7320
|
-
# names that you can specify.
|
7321
|
-
#
|
7322
8119
|
# When omitted, the response includes all of your distributions in the
|
7323
8120
|
# AWS Region where the request is made.
|
7324
8121
|
# @return [String]
|
@@ -9559,7 +10356,7 @@ module Aws::Lightsail
|
|
9559
10356
|
#
|
9560
10357
|
# {
|
9561
10358
|
# name: "ResourceName",
|
9562
|
-
# region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2
|
10359
|
+
# region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1
|
9563
10360
|
# protocol_policy: "http-only", # accepts http-only, https-only
|
9564
10361
|
# }
|
9565
10362
|
#
|
@@ -9620,12 +10417,12 @@ module Aws::Lightsail
|
|
9620
10417
|
#
|
9621
10418
|
# @!attribute [rw] tags
|
9622
10419
|
# The tag keys and optional values for the resource. For more
|
9623
|
-
# information about tags in Lightsail, see the [Lightsail
|
9624
|
-
# Guide][1].
|
10420
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
10421
|
+
# Developer Guide][1].
|
9625
10422
|
#
|
9626
10423
|
#
|
9627
10424
|
#
|
9628
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
10425
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
9629
10426
|
# @return [Array<Types::Tag>]
|
9630
10427
|
#
|
9631
10428
|
# @!attribute [rw] blueprint_id
|
@@ -10378,12 +11175,12 @@ module Aws::Lightsail
|
|
10378
11175
|
#
|
10379
11176
|
# @!attribute [rw] tags
|
10380
11177
|
# The tag keys and optional values for the resource. For more
|
10381
|
-
# information about tags in Lightsail, see the [Lightsail
|
10382
|
-
# Guide][1].
|
11178
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
11179
|
+
# Developer Guide][1].
|
10383
11180
|
#
|
10384
11181
|
#
|
10385
11182
|
#
|
10386
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
11183
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
10387
11184
|
# @return [Array<Types::Tag>]
|
10388
11185
|
#
|
10389
11186
|
# @!attribute [rw] state
|
@@ -10553,7 +11350,7 @@ module Aws::Lightsail
|
|
10553
11350
|
include Aws::Structure
|
10554
11351
|
end
|
10555
11352
|
|
10556
|
-
# Describes
|
11353
|
+
# Describes an SSH key pair.
|
10557
11354
|
#
|
10558
11355
|
# @!attribute [rw] name
|
10559
11356
|
# The friendly name of the SSH key pair.
|
@@ -10587,12 +11384,12 @@ module Aws::Lightsail
|
|
10587
11384
|
#
|
10588
11385
|
# @!attribute [rw] tags
|
10589
11386
|
# The tag keys and optional values for the resource. For more
|
10590
|
-
# information about tags in Lightsail, see the [Lightsail
|
10591
|
-
# Guide][1].
|
11387
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
11388
|
+
# Developer Guide][1].
|
10592
11389
|
#
|
10593
11390
|
#
|
10594
11391
|
#
|
10595
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
11392
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
10596
11393
|
# @return [Array<Types::Tag>]
|
10597
11394
|
#
|
10598
11395
|
# @!attribute [rw] fingerprint
|
@@ -10720,12 +11517,12 @@ module Aws::Lightsail
|
|
10720
11517
|
#
|
10721
11518
|
# @!attribute [rw] tags
|
10722
11519
|
# The tag keys and optional values for the resource. For more
|
10723
|
-
# information about tags in Lightsail, see the [Lightsail
|
10724
|
-
# Guide][1].
|
11520
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
11521
|
+
# Developer Guide][1].
|
10725
11522
|
#
|
10726
11523
|
#
|
10727
11524
|
#
|
10728
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
11525
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
10729
11526
|
# @return [Array<Types::Tag>]
|
10730
11527
|
#
|
10731
11528
|
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/LightsailDistribution AWS API Documentation
|
@@ -10755,7 +11552,7 @@ module Aws::Lightsail
|
|
10755
11552
|
include Aws::Structure
|
10756
11553
|
end
|
10757
11554
|
|
10758
|
-
# Describes
|
11555
|
+
# Describes a load balancer.
|
10759
11556
|
#
|
10760
11557
|
# @!attribute [rw] name
|
10761
11558
|
# The name of the load balancer (e.g., `my-load-balancer`).
|
@@ -10788,12 +11585,12 @@ module Aws::Lightsail
|
|
10788
11585
|
#
|
10789
11586
|
# @!attribute [rw] tags
|
10790
11587
|
# The tag keys and optional values for the resource. For more
|
10791
|
-
# information about tags in Lightsail, see the [Lightsail
|
10792
|
-
# Guide][1].
|
11588
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
11589
|
+
# Developer Guide][1].
|
10793
11590
|
#
|
10794
11591
|
#
|
10795
11592
|
#
|
10796
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
11593
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
10797
11594
|
# @return [Array<Types::Tag>]
|
10798
11595
|
#
|
10799
11596
|
# @!attribute [rw] dns_name
|
@@ -10934,12 +11731,12 @@ module Aws::Lightsail
|
|
10934
11731
|
#
|
10935
11732
|
# @!attribute [rw] tags
|
10936
11733
|
# The tag keys and optional values for the resource. For more
|
10937
|
-
# information about tags in Lightsail, see the [Lightsail
|
10938
|
-
# Guide][1].
|
11734
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
11735
|
+
# Developer Guide][1].
|
10939
11736
|
#
|
10940
11737
|
#
|
10941
11738
|
#
|
10942
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
11739
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
10943
11740
|
# @return [Array<Types::Tag>]
|
10944
11741
|
#
|
10945
11742
|
# @!attribute [rw] load_balancer_name
|
@@ -12350,12 +13147,12 @@ module Aws::Lightsail
|
|
12350
13147
|
#
|
12351
13148
|
# @!attribute [rw] tags
|
12352
13149
|
# The tag keys and optional values for the resource. For more
|
12353
|
-
# information about tags in Lightsail, see the [Lightsail
|
12354
|
-
# Guide][1].
|
13150
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
13151
|
+
# Developer Guide][1].
|
12355
13152
|
#
|
12356
13153
|
#
|
12357
13154
|
#
|
12358
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
13155
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
12359
13156
|
# @return [Array<Types::Tag>]
|
12360
13157
|
#
|
12361
13158
|
# @!attribute [rw] relational_database_blueprint_id
|
@@ -12751,12 +13548,12 @@ module Aws::Lightsail
|
|
12751
13548
|
#
|
12752
13549
|
# @!attribute [rw] tags
|
12753
13550
|
# The tag keys and optional values for the resource. For more
|
12754
|
-
# information about tags in Lightsail, see the [Lightsail
|
12755
|
-
# Guide][1].
|
13551
|
+
# information about tags in Lightsail, see the [Amazon Lightsail
|
13552
|
+
# Developer Guide][1].
|
12756
13553
|
#
|
12757
13554
|
#
|
12758
13555
|
#
|
12759
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
13556
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
12760
13557
|
# @return [Array<Types::Tag>]
|
12761
13558
|
#
|
12762
13559
|
# @!attribute [rw] engine
|
@@ -12973,6 +13770,26 @@ module Aws::Lightsail
|
|
12973
13770
|
include Aws::Structure
|
12974
13771
|
end
|
12975
13772
|
|
13773
|
+
# Describes an Amazon Lightsail instance that has access to a Lightsail
|
13774
|
+
# bucket.
|
13775
|
+
#
|
13776
|
+
# @!attribute [rw] name
|
13777
|
+
# The name of the Lightsail instance.
|
13778
|
+
# @return [String]
|
13779
|
+
#
|
13780
|
+
# @!attribute [rw] resource_type
|
13781
|
+
# The Lightsail resource type (for example, `Instance`).
|
13782
|
+
# @return [String]
|
13783
|
+
#
|
13784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/ResourceReceivingAccess AWS API Documentation
|
13785
|
+
#
|
13786
|
+
class ResourceReceivingAccess < Struct.new(
|
13787
|
+
:name,
|
13788
|
+
:resource_type)
|
13789
|
+
SENSITIVE = []
|
13790
|
+
include Aws::Structure
|
13791
|
+
end
|
13792
|
+
|
12976
13793
|
# Describes the domain name system (DNS) records to add to your
|
12977
13794
|
# domain's DNS to validate it for an Amazon Lightsail certificate.
|
12978
13795
|
#
|
@@ -13060,7 +13877,7 @@ module Aws::Lightsail
|
|
13060
13877
|
# data as a hash:
|
13061
13878
|
#
|
13062
13879
|
# {
|
13063
|
-
# resource_type: "ContainerService", # required, accepts ContainerService, Instance, StaticIp, KeyPair, InstanceSnapshot, Domain, PeeredVpc, LoadBalancer, LoadBalancerTlsCertificate, Disk, DiskSnapshot, RelationalDatabase, RelationalDatabaseSnapshot, ExportSnapshotRecord, CloudFormationStackRecord, Alarm, ContactMethod, Distribution, Certificate
|
13880
|
+
# resource_type: "ContainerService", # required, accepts ContainerService, Instance, StaticIp, KeyPair, InstanceSnapshot, Domain, PeeredVpc, LoadBalancer, LoadBalancerTlsCertificate, Disk, DiskSnapshot, RelationalDatabase, RelationalDatabaseSnapshot, ExportSnapshotRecord, CloudFormationStackRecord, Alarm, ContactMethod, Distribution, Certificate, Bucket
|
13064
13881
|
# resource_name: "ResourceName", # required
|
13065
13882
|
# ip_address_type: "dualstack", # required, accepts dualstack, ipv4
|
13066
13883
|
# }
|
@@ -13113,6 +13930,60 @@ module Aws::Lightsail
|
|
13113
13930
|
include Aws::Structure
|
13114
13931
|
end
|
13115
13932
|
|
13933
|
+
# @note When making an API call, you may pass SetResourceAccessForBucketRequest
|
13934
|
+
# data as a hash:
|
13935
|
+
#
|
13936
|
+
# {
|
13937
|
+
# resource_name: "ResourceName", # required
|
13938
|
+
# bucket_name: "BucketName", # required
|
13939
|
+
# access: "allow", # required, accepts allow, deny
|
13940
|
+
# }
|
13941
|
+
#
|
13942
|
+
# @!attribute [rw] resource_name
|
13943
|
+
# The name of the Lightsail instance for which to set bucket access.
|
13944
|
+
# The instance must be in a running or stopped state.
|
13945
|
+
# @return [String]
|
13946
|
+
#
|
13947
|
+
# @!attribute [rw] bucket_name
|
13948
|
+
# The name of the bucket for which to set access to another Lightsail
|
13949
|
+
# resource.
|
13950
|
+
# @return [String]
|
13951
|
+
#
|
13952
|
+
# @!attribute [rw] access
|
13953
|
+
# The access setting.
|
13954
|
+
#
|
13955
|
+
# The following access settings are available:
|
13956
|
+
#
|
13957
|
+
# * `allow` - Allows access to the bucket and its objects.
|
13958
|
+
#
|
13959
|
+
# * `deny` - Denies access to the bucket and its objects. Use this
|
13960
|
+
# setting to remove access for a resource previously set to `allow`.
|
13961
|
+
# @return [String]
|
13962
|
+
#
|
13963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SetResourceAccessForBucketRequest AWS API Documentation
|
13964
|
+
#
|
13965
|
+
class SetResourceAccessForBucketRequest < Struct.new(
|
13966
|
+
:resource_name,
|
13967
|
+
:bucket_name,
|
13968
|
+
:access)
|
13969
|
+
SENSITIVE = []
|
13970
|
+
include Aws::Structure
|
13971
|
+
end
|
13972
|
+
|
13973
|
+
# @!attribute [rw] operations
|
13974
|
+
# An array of objects that describe the result of the action, such as
|
13975
|
+
# the status of the request, the timestamp of the request, and the
|
13976
|
+
# resources affected by the request.
|
13977
|
+
# @return [Array<Types::Operation>]
|
13978
|
+
#
|
13979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/SetResourceAccessForBucketResult AWS API Documentation
|
13980
|
+
#
|
13981
|
+
class SetResourceAccessForBucketResult < Struct.new(
|
13982
|
+
:operations)
|
13983
|
+
SENSITIVE = []
|
13984
|
+
include Aws::Structure
|
13985
|
+
end
|
13986
|
+
|
13116
13987
|
# @note When making an API call, you may pass StartInstanceRequest
|
13117
13988
|
# data as a hash:
|
13118
13989
|
#
|
@@ -13179,7 +14050,7 @@ module Aws::Lightsail
|
|
13179
14050
|
include Aws::Structure
|
13180
14051
|
end
|
13181
14052
|
|
13182
|
-
# Describes
|
14053
|
+
# Describes a static IP.
|
13183
14054
|
#
|
13184
14055
|
# @!attribute [rw] name
|
13185
14056
|
# The name of the static IP (e.g., `StaticIP-Ohio-EXAMPLE`).
|
@@ -13326,12 +14197,12 @@ module Aws::Lightsail
|
|
13326
14197
|
# Describes a tag key and optional value assigned to an Amazon Lightsail
|
13327
14198
|
# resource.
|
13328
14199
|
#
|
13329
|
-
# For more information about tags in Lightsail, see the [
|
13330
|
-
# Guide][1].
|
14200
|
+
# For more information about tags in Lightsail, see the [Amazon
|
14201
|
+
# Lightsail Developer Guide][1].
|
13331
14202
|
#
|
13332
14203
|
#
|
13333
14204
|
#
|
13334
|
-
# [1]: https://lightsail.aws.amazon.com/ls/docs/
|
14205
|
+
# [1]: https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags
|
13335
14206
|
#
|
13336
14207
|
# @note When making an API call, you may pass Tag
|
13337
14208
|
# data as a hash:
|
@@ -13556,6 +14427,119 @@ module Aws::Lightsail
|
|
13556
14427
|
include Aws::Structure
|
13557
14428
|
end
|
13558
14429
|
|
14430
|
+
# @note When making an API call, you may pass UpdateBucketBundleRequest
|
14431
|
+
# data as a hash:
|
14432
|
+
#
|
14433
|
+
# {
|
14434
|
+
# bucket_name: "BucketName", # required
|
14435
|
+
# bundle_id: "NonEmptyString", # required
|
14436
|
+
# }
|
14437
|
+
#
|
14438
|
+
# @!attribute [rw] bucket_name
|
14439
|
+
# The name of the bucket for which to update the bundle.
|
14440
|
+
# @return [String]
|
14441
|
+
#
|
14442
|
+
# @!attribute [rw] bundle_id
|
14443
|
+
# The ID of the new bundle to apply to the bucket.
|
14444
|
+
#
|
14445
|
+
# Use the GetBucketBundles action to get a list of bundle IDs that you
|
14446
|
+
# can specify.
|
14447
|
+
# @return [String]
|
14448
|
+
#
|
14449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateBucketBundleRequest AWS API Documentation
|
14450
|
+
#
|
14451
|
+
class UpdateBucketBundleRequest < Struct.new(
|
14452
|
+
:bucket_name,
|
14453
|
+
:bundle_id)
|
14454
|
+
SENSITIVE = []
|
14455
|
+
include Aws::Structure
|
14456
|
+
end
|
14457
|
+
|
14458
|
+
# @!attribute [rw] operations
|
14459
|
+
# An array of objects that describe the result of the action, such as
|
14460
|
+
# the status of the request, the timestamp of the request, and the
|
14461
|
+
# resources affected by the request.
|
14462
|
+
# @return [Array<Types::Operation>]
|
14463
|
+
#
|
14464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateBucketBundleResult AWS API Documentation
|
14465
|
+
#
|
14466
|
+
class UpdateBucketBundleResult < Struct.new(
|
14467
|
+
:operations)
|
14468
|
+
SENSITIVE = []
|
14469
|
+
include Aws::Structure
|
14470
|
+
end
|
14471
|
+
|
14472
|
+
# @note When making an API call, you may pass UpdateBucketRequest
|
14473
|
+
# data as a hash:
|
14474
|
+
#
|
14475
|
+
# {
|
14476
|
+
# bucket_name: "BucketName", # required
|
14477
|
+
# access_rules: {
|
14478
|
+
# get_object: "public", # accepts public, private
|
14479
|
+
# allow_public_overrides: false,
|
14480
|
+
# },
|
14481
|
+
# versioning: "NonEmptyString",
|
14482
|
+
# readonly_access_accounts: ["NonEmptyString"],
|
14483
|
+
# }
|
14484
|
+
#
|
14485
|
+
# @!attribute [rw] bucket_name
|
14486
|
+
# The name of the bucket to update.
|
14487
|
+
# @return [String]
|
14488
|
+
#
|
14489
|
+
# @!attribute [rw] access_rules
|
14490
|
+
# An object that sets the public accessibility of objects in the
|
14491
|
+
# specified bucket.
|
14492
|
+
# @return [Types::AccessRules]
|
14493
|
+
#
|
14494
|
+
# @!attribute [rw] versioning
|
14495
|
+
# Specifies whether to enable or suspend versioning of objects in the
|
14496
|
+
# bucket.
|
14497
|
+
#
|
14498
|
+
# The following options can be specified:
|
14499
|
+
#
|
14500
|
+
# * `Enabled` - Enables versioning of objects in the specified bucket.
|
14501
|
+
#
|
14502
|
+
# * `Suspended` - Suspends versioning of objects in the specified
|
14503
|
+
# bucket. Existing object versions are retained.
|
14504
|
+
# @return [String]
|
14505
|
+
#
|
14506
|
+
# @!attribute [rw] readonly_access_accounts
|
14507
|
+
# An array of strings to specify the AWS account IDs that can access
|
14508
|
+
# the bucket.
|
14509
|
+
#
|
14510
|
+
# You can give a maximum of 10 AWS accounts access to a bucket.
|
14511
|
+
# @return [Array<String>]
|
14512
|
+
#
|
14513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateBucketRequest AWS API Documentation
|
14514
|
+
#
|
14515
|
+
class UpdateBucketRequest < Struct.new(
|
14516
|
+
:bucket_name,
|
14517
|
+
:access_rules,
|
14518
|
+
:versioning,
|
14519
|
+
:readonly_access_accounts)
|
14520
|
+
SENSITIVE = []
|
14521
|
+
include Aws::Structure
|
14522
|
+
end
|
14523
|
+
|
14524
|
+
# @!attribute [rw] bucket
|
14525
|
+
# An object that describes the bucket that is updated.
|
14526
|
+
# @return [Types::Bucket]
|
14527
|
+
#
|
14528
|
+
# @!attribute [rw] operations
|
14529
|
+
# An array of objects that describe the result of the action, such as
|
14530
|
+
# the status of the request, the timestamp of the request, and the
|
14531
|
+
# resources affected by the request.
|
14532
|
+
# @return [Array<Types::Operation>]
|
14533
|
+
#
|
14534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/UpdateBucketResult AWS API Documentation
|
14535
|
+
#
|
14536
|
+
class UpdateBucketResult < Struct.new(
|
14537
|
+
:bucket,
|
14538
|
+
:operations)
|
14539
|
+
SENSITIVE = []
|
14540
|
+
include Aws::Structure
|
14541
|
+
end
|
14542
|
+
|
13559
14543
|
# @note When making an API call, you may pass UpdateContainerServiceRequest
|
13560
14544
|
# data as a hash:
|
13561
14545
|
#
|
@@ -13697,7 +14681,7 @@ module Aws::Lightsail
|
|
13697
14681
|
# distribution_name: "ResourceName", # required
|
13698
14682
|
# origin: {
|
13699
14683
|
# name: "ResourceName",
|
13700
|
-
# region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2
|
14684
|
+
# region_name: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ca-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, eu-north-1
|
13701
14685
|
# protocol_policy: "http-only", # accepts http-only, https-only
|
13702
14686
|
# },
|
13703
14687
|
# default_cache_behavior: {
|