aws-sdk-storagegateway 1.39.0 → 1.44.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-storagegateway.rb +3 -1
- data/lib/aws-sdk-storagegateway/client.rb +294 -199
- data/lib/aws-sdk-storagegateway/client_api.rb +4 -0
- data/lib/aws-sdk-storagegateway/customizations.rb +1 -0
- data/lib/aws-sdk-storagegateway/errors.rb +2 -0
- data/lib/aws-sdk-storagegateway/resource.rb +2 -0
- data/lib/aws-sdk-storagegateway/types.rb +620 -311
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fbe6f9eb17ade1de4734d43b1ed137e3195e8ae0e6b442a8f856ecd7a7db654f
|
4
|
+
data.tar.gz: a3d6471335ae9a7a62d5987d497210160aaa553b38d310fb921737aa8e027472
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 83c55796d70d1b44c3543c40703cc2bf773d15eb80faf2a18bcd41d9f7434381e996bb5b8defd1a1639f9534efa7fbbd6812231347284f7569e8b034e9ab865d
|
7
|
+
data.tar.gz: 3a876ef14d17123bdd9d2ae184e64d34380e5580817b42649c0b74b2d4c20520330d3d23eafa85b694245c0082bfa7b4689eb467c666269a3190a345c07f8b95
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-storagegateway/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::StorageGateway
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.44.0'
|
49
51
|
|
50
52
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
32
|
|
@@ -69,6 +72,7 @@ module Aws::StorageGateway
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
74
78
|
|
@@ -105,7 +109,7 @@ module Aws::StorageGateway
|
|
105
109
|
# @option options [required, String] :region
|
106
110
|
# The AWS region to connect to. The configured `:region` is
|
107
111
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
112
|
+
# a default `:region` is searched for in the following locations:
|
109
113
|
#
|
110
114
|
# * `Aws.config[:region]`
|
111
115
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +165,7 @@ module Aws::StorageGateway
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +180,7 @@ module Aws::StorageGateway
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
181
|
#
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
184
|
#
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
186
|
# The log formatter.
|
@@ -323,7 +327,7 @@ module Aws::StorageGateway
|
|
323
327
|
# that you want to use for storing snapshots or tapes, the time zone for
|
324
328
|
# scheduled snapshots the gateway snapshot schedule window, an
|
325
329
|
# activation key, and a name for your gateway. The activation process
|
326
|
-
# also associates your gateway with your account
|
330
|
+
# also associates your gateway with your account. For more information,
|
327
331
|
# see UpdateGatewayInformation.
|
328
332
|
#
|
329
333
|
# <note markdown="1"> You must turn on the gateway VM before you can activate your gateway.
|
@@ -340,9 +344,12 @@ module Aws::StorageGateway
|
|
340
344
|
# pass to the `ActivateGateway` API call determine the actual
|
341
345
|
# configuration of your gateway.
|
342
346
|
#
|
343
|
-
# For more information, see
|
344
|
-
#
|
345
|
-
#
|
347
|
+
# For more information, see [Getting activation key][1] in the *AWS
|
348
|
+
# Storage Gateway User Guide*.
|
349
|
+
#
|
350
|
+
#
|
351
|
+
#
|
352
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html
|
346
353
|
#
|
347
354
|
# @option params [required, String] :gateway_name
|
348
355
|
# The name you configured for your gateway.
|
@@ -360,34 +367,34 @@ module Aws::StorageGateway
|
|
360
367
|
# data. The gateway AWS Region specified must be the same AWS Region as
|
361
368
|
# the AWS Region in your `Host` header in the request. For more
|
362
369
|
# information about available AWS Regions and endpoints for AWS Storage
|
363
|
-
# Gateway, see [
|
364
|
-
#
|
370
|
+
# Gateway, see [AWS Storage Gateway endpoints and quotas][1] in the *AWS
|
371
|
+
# General Reference*.
|
365
372
|
#
|
366
|
-
# Valid Values: See [AWS Storage Gateway
|
367
|
-
#
|
373
|
+
# Valid Values: See [AWS Storage Gateway endpoints and quotas][1] in the
|
374
|
+
# *AWS General Reference*.
|
368
375
|
#
|
369
376
|
#
|
370
377
|
#
|
371
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/
|
378
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/sg.html
|
372
379
|
#
|
373
380
|
# @option params [String] :gateway_type
|
374
381
|
# A value that defines the type of gateway to activate. The type
|
375
382
|
# specified is critical to all later functions of the gateway and cannot
|
376
383
|
# be changed after activation. The default value is `CACHED`.
|
377
384
|
#
|
378
|
-
# Valid Values:
|
385
|
+
# Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3`
|
379
386
|
#
|
380
387
|
# @option params [String] :tape_drive_type
|
381
388
|
# The value that indicates the type of tape drive to use for tape
|
382
389
|
# gateway. This field is optional.
|
383
390
|
#
|
384
|
-
# Valid Values:
|
391
|
+
# Valid Values: `IBM-ULT3580-TD5`
|
385
392
|
#
|
386
393
|
# @option params [String] :medium_changer_type
|
387
394
|
# The value that indicates the type of medium changer to use for tape
|
388
395
|
# gateway. This field is optional.
|
389
396
|
#
|
390
|
-
# Valid Values:
|
397
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
391
398
|
#
|
392
399
|
# @option params [Array<Types::Tag>] :tags
|
393
400
|
# A list of up to 50 tags that you can assign to the gateway. Each tag
|
@@ -457,8 +464,8 @@ module Aws::StorageGateway
|
|
457
464
|
end
|
458
465
|
|
459
466
|
# Configures one or more gateway local disks as cache for a gateway.
|
460
|
-
# This operation is only supported in the cached volume, tape and file
|
461
|
-
# gateway type (see [Storage Gateway
|
467
|
+
# This operation is only supported in the cached volume, tape, and file
|
468
|
+
# gateway type (see [How AWS Storage Gateway works (architecture)][1].
|
462
469
|
#
|
463
470
|
# In the request, you specify the gateway Amazon Resource Name (ARN) to
|
464
471
|
# which you want to add cache, and one or more disk IDs that you want to
|
@@ -737,7 +744,7 @@ module Aws::StorageGateway
|
|
737
744
|
# is archived directly into the S3 storage class (S3 Glacier or S3
|
738
745
|
# Glacier Deep Archive) that corresponds to the pool.
|
739
746
|
#
|
740
|
-
# Valid
|
747
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
741
748
|
#
|
742
749
|
# @option params [required, String] :tape_arn
|
743
750
|
# The unique Amazon Resource Name (ARN) of the virtual tape that you
|
@@ -750,7 +757,7 @@ module Aws::StorageGateway
|
|
750
757
|
# eject the tape, the tape is archived directly into the storage class
|
751
758
|
# (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
|
752
759
|
#
|
753
|
-
# Valid
|
760
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
754
761
|
#
|
755
762
|
# @return [Types::AssignTapePoolOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
756
763
|
#
|
@@ -981,7 +988,7 @@ module Aws::StorageGateway
|
|
981
988
|
# @option params [String] :snapshot_id
|
982
989
|
# The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
|
983
990
|
# the new cached volume. Specify this field if you want to create the
|
984
|
-
# iSCSI storage volume from a snapshot otherwise do not include this
|
991
|
+
# iSCSI storage volume from a snapshot; otherwise, do not include this
|
985
992
|
# field. To list snapshots for your account use [DescribeSnapshots][1]
|
986
993
|
# in the *Amazon Elastic Compute Cloud API Reference*.
|
987
994
|
#
|
@@ -1019,13 +1026,16 @@ module Aws::StorageGateway
|
|
1019
1026
|
# request.
|
1020
1027
|
#
|
1021
1028
|
# @option params [Boolean] :kms_encrypted
|
1022
|
-
#
|
1023
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1029
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1030
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1031
|
+
#
|
1032
|
+
# Valid Values: `true` \| `false`
|
1024
1033
|
#
|
1025
1034
|
# @option params [String] :kms_key
|
1026
|
-
# The Amazon Resource Name (ARN) of
|
1027
|
-
# server-side encryption.
|
1028
|
-
#
|
1035
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1036
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1037
|
+
# not support asymmetric CMKs. This value can only be set when
|
1038
|
+
# `KMSEncrypted` is `true`. Optional.
|
1029
1039
|
#
|
1030
1040
|
# @option params [Array<Types::Tag>] :tags
|
1031
1041
|
# A list of up to 50 tags that you can assign to a cached volume. Each
|
@@ -1108,13 +1118,17 @@ module Aws::StorageGateway
|
|
1108
1118
|
# activated to enable you to create a file share. Make sure AWS STS is
|
1109
1119
|
# activated in the AWS Region you are creating your file gateway in. If
|
1110
1120
|
# AWS STS is not activated in the AWS Region, activate it. For
|
1111
|
-
# information about how to activate AWS STS, see Activating and
|
1112
|
-
#
|
1113
|
-
# Management User Guide
|
1121
|
+
# information about how to activate AWS STS, see [Activating and
|
1122
|
+
# deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
|
1123
|
+
# Access Management User Guide*.
|
1114
1124
|
#
|
1115
1125
|
# File gateway does not support creating hard or symbolic links on a
|
1116
1126
|
# file share.
|
1117
1127
|
#
|
1128
|
+
#
|
1129
|
+
#
|
1130
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html
|
1131
|
+
#
|
1118
1132
|
# @option params [required, String] :client_token
|
1119
1133
|
# A unique string value that you supply that is used by file gateway to
|
1120
1134
|
# ensure idempotent file share creation.
|
@@ -1127,13 +1141,16 @@ module Aws::StorageGateway
|
|
1127
1141
|
# to create a file share.
|
1128
1142
|
#
|
1129
1143
|
# @option params [Boolean] :kms_encrypted
|
1130
|
-
#
|
1131
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1144
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1145
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1146
|
+
#
|
1147
|
+
# Valid Values: `true` \| `false`
|
1132
1148
|
#
|
1133
1149
|
# @option params [String] :kms_key
|
1134
|
-
# The Amazon Resource Name (ARN)
|
1135
|
-
# server-side encryption.
|
1136
|
-
#
|
1150
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1151
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1152
|
+
# not support asymmetric CMKs. This value can only be set when
|
1153
|
+
# `KMSEncrypted` is `true`. Optional.
|
1137
1154
|
#
|
1138
1155
|
# @option params [required, String] :role
|
1139
1156
|
# The ARN of the AWS Identity and Access Management (IAM) role that a
|
@@ -1144,44 +1161,51 @@ module Aws::StorageGateway
|
|
1144
1161
|
#
|
1145
1162
|
# @option params [String] :default_storage_class
|
1146
1163
|
# The default storage class for objects put into an Amazon S3 bucket by
|
1147
|
-
# the file gateway.
|
1148
|
-
#
|
1149
|
-
#
|
1164
|
+
# the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
1165
|
+
# Optional.
|
1166
|
+
#
|
1167
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
1168
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
1150
1169
|
#
|
1151
1170
|
# @option params [String] :object_acl
|
1152
|
-
# A value that sets the access control list permission for objects
|
1153
|
-
# the S3 bucket that a file gateway puts objects into. The default
|
1154
|
-
# is
|
1171
|
+
# A value that sets the access control list (ACL) permission for objects
|
1172
|
+
# in the S3 bucket that a file gateway puts objects into. The default
|
1173
|
+
# value is `private`.
|
1155
1174
|
#
|
1156
1175
|
# @option params [Array<String>] :client_list
|
1157
1176
|
# The list of clients that are allowed to access the file gateway. The
|
1158
1177
|
# list must contain either valid IP addresses or valid CIDR blocks.
|
1159
1178
|
#
|
1160
1179
|
# @option params [String] :squash
|
1161
|
-
# A value that maps a user to anonymous user.
|
1162
|
-
# following:
|
1180
|
+
# A value that maps a user to anonymous user.
|
1163
1181
|
#
|
1164
|
-
#
|
1182
|
+
# Valid values are the following:
|
1165
1183
|
#
|
1166
|
-
# * `
|
1184
|
+
# * `RootSquash`\: Only root is mapped to anonymous user.
|
1167
1185
|
#
|
1168
|
-
# * `
|
1186
|
+
# * `NoSquash`\: No one is mapped to anonymous user.
|
1187
|
+
#
|
1188
|
+
# * `AllSquash`\: Everyone is mapped to anonymous user.
|
1169
1189
|
#
|
1170
1190
|
# @option params [Boolean] :read_only
|
1171
|
-
# A value that sets the write status of a file share.
|
1172
|
-
#
|
1191
|
+
# A value that sets the write status of a file share. Set this value to
|
1192
|
+
# `true` to set the write status to read-only, otherwise set to `false`.
|
1193
|
+
#
|
1194
|
+
# Valid Values: `true` \| `false`
|
1173
1195
|
#
|
1174
1196
|
# @option params [Boolean] :guess_mime_type_enabled
|
1175
1197
|
# A value that enables guessing of the MIME type for uploaded objects
|
1176
|
-
# based on file extensions. Set this value to true to enable MIME type
|
1177
|
-
# guessing,
|
1198
|
+
# based on file extensions. Set this value to `true` to enable MIME type
|
1199
|
+
# guessing, otherwise set to `false`. The default value is `true`.
|
1200
|
+
#
|
1201
|
+
# Valid Values: `true` \| `false`
|
1178
1202
|
#
|
1179
1203
|
# @option params [Boolean] :requester_pays
|
1180
1204
|
# A value that sets who pays the cost of the request and the cost
|
1181
1205
|
# associated with data download from the S3 bucket. If this value is set
|
1182
|
-
# to true
|
1183
|
-
# pays. However, the S3 bucket owner always pays the cost of
|
1184
|
-
# data.
|
1206
|
+
# to `true`, the requester pays the costs; otherwise, the S3 bucket
|
1207
|
+
# owner pays. However, the S3 bucket owner always pays the cost of
|
1208
|
+
# storing data.
|
1185
1209
|
#
|
1186
1210
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
1187
1211
|
# file share, so make sure that the configuration on the file share is
|
@@ -1189,6 +1213,8 @@ module Aws::StorageGateway
|
|
1189
1213
|
#
|
1190
1214
|
# </note>
|
1191
1215
|
#
|
1216
|
+
# Valid Values: `true` \| `false`
|
1217
|
+
#
|
1192
1218
|
# @option params [Array<Types::Tag>] :tags
|
1193
1219
|
# A list of up to 50 tags that can be assigned to the NFS file share.
|
1194
1220
|
# Each tag is a key-value pair.
|
@@ -1258,8 +1284,8 @@ module Aws::StorageGateway
|
|
1258
1284
|
# is activated in the AWS Region you are creating your file gateway in.
|
1259
1285
|
# If AWS STS is not activated in this AWS Region, activate it. For
|
1260
1286
|
# information about how to activate AWS STS, see [Activating and
|
1261
|
-
#
|
1262
|
-
# Access Management User Guide
|
1287
|
+
# deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
|
1288
|
+
# Access Management User Guide*.
|
1263
1289
|
#
|
1264
1290
|
# File gateways don't support creating hard or symbolic links on a
|
1265
1291
|
# file
|
@@ -1277,13 +1303,16 @@ module Aws::StorageGateway
|
|
1277
1303
|
# The ARN of the file gateway on which you want to create a file share.
|
1278
1304
|
#
|
1279
1305
|
# @option params [Boolean] :kms_encrypted
|
1280
|
-
#
|
1281
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1306
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1307
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1308
|
+
#
|
1309
|
+
# Valid Values: `true` \| `false`
|
1282
1310
|
#
|
1283
1311
|
# @option params [String] :kms_key
|
1284
|
-
# The Amazon Resource Name (ARN) of
|
1285
|
-
# server-side encryption.
|
1286
|
-
#
|
1312
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1313
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1314
|
+
# not support asymmetric CMKs. This value can only be set when
|
1315
|
+
# `KMSEncrypted` is `true`. Optional.
|
1287
1316
|
#
|
1288
1317
|
# @option params [required, String] :role
|
1289
1318
|
# The ARN of the AWS Identity and Access Management (IAM) role that a
|
@@ -1294,30 +1323,36 @@ module Aws::StorageGateway
|
|
1294
1323
|
#
|
1295
1324
|
# @option params [String] :default_storage_class
|
1296
1325
|
# The default storage class for objects put into an Amazon S3 bucket by
|
1297
|
-
# the file gateway.
|
1298
|
-
#
|
1299
|
-
#
|
1326
|
+
# the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
1327
|
+
# Optional.
|
1328
|
+
#
|
1329
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
1330
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
1300
1331
|
#
|
1301
1332
|
# @option params [String] :object_acl
|
1302
|
-
# A value that sets the access control list permission for objects
|
1303
|
-
# the S3 bucket that a file gateway puts objects into. The default
|
1304
|
-
# is
|
1333
|
+
# A value that sets the access control list (ACL) permission for objects
|
1334
|
+
# in the S3 bucket that a file gateway puts objects into. The default
|
1335
|
+
# value is `private`.
|
1305
1336
|
#
|
1306
1337
|
# @option params [Boolean] :read_only
|
1307
|
-
# A value that sets the write status of a file share.
|
1308
|
-
#
|
1338
|
+
# A value that sets the write status of a file share. Set this value to
|
1339
|
+
# `true` to set the write status to read-only, otherwise set to `false`.
|
1340
|
+
#
|
1341
|
+
# Valid Values: `true` \| `false`
|
1309
1342
|
#
|
1310
1343
|
# @option params [Boolean] :guess_mime_type_enabled
|
1311
1344
|
# A value that enables guessing of the MIME type for uploaded objects
|
1312
|
-
# based on file extensions. Set this value to true to enable MIME type
|
1313
|
-
# guessing,
|
1345
|
+
# based on file extensions. Set this value to `true` to enable MIME type
|
1346
|
+
# guessing, otherwise set to `false`. The default value is `true`.
|
1347
|
+
#
|
1348
|
+
# Valid Values: `true` \| `false`
|
1314
1349
|
#
|
1315
1350
|
# @option params [Boolean] :requester_pays
|
1316
1351
|
# A value that sets who pays the cost of the request and the cost
|
1317
1352
|
# associated with data download from the S3 bucket. If this value is set
|
1318
|
-
# to true
|
1319
|
-
# pays. However, the S3 bucket owner always pays the cost of
|
1320
|
-
# data.
|
1353
|
+
# to `true`, the requester pays the costs; otherwise, the S3 bucket
|
1354
|
+
# owner pays. However, the S3 bucket owner always pays the cost of
|
1355
|
+
# storing data.
|
1321
1356
|
#
|
1322
1357
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
1323
1358
|
# file share, so make sure that the configuration on the file share is
|
@@ -1325,14 +1360,22 @@ module Aws::StorageGateway
|
|
1325
1360
|
#
|
1326
1361
|
# </note>
|
1327
1362
|
#
|
1363
|
+
# Valid Values: `true` \| `false`
|
1364
|
+
#
|
1328
1365
|
# @option params [Boolean] :smbacl_enabled
|
1329
|
-
# Set this value to
|
1330
|
-
# SMB file share. Set it to
|
1366
|
+
# Set this value to `true` to enable access control list (ACL) on the
|
1367
|
+
# SMB file share. Set it to `false` to map file and directory
|
1331
1368
|
# permissions to the POSIX permissions.
|
1332
1369
|
#
|
1333
|
-
# For more information, see
|
1334
|
-
#
|
1335
|
-
#
|
1370
|
+
# For more information, see [Using Microsoft Windows ACLs to control
|
1371
|
+
# access to an SMB file share][1] in the *AWS Storage Gateway User
|
1372
|
+
# Guide*.
|
1373
|
+
#
|
1374
|
+
# Valid Values: `true` \| `false`
|
1375
|
+
#
|
1376
|
+
#
|
1377
|
+
#
|
1378
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
1336
1379
|
#
|
1337
1380
|
# @option params [Array<String>] :admin_user_list
|
1338
1381
|
# A list of users in the Active Directory that will be granted
|
@@ -1345,7 +1388,7 @@ module Aws::StorageGateway
|
|
1345
1388
|
# @option params [Array<String>] :valid_user_list
|
1346
1389
|
# A list of users or groups in the Active Directory that are allowed to
|
1347
1390
|
# access the file share. A group must be prefixed with the @ character.
|
1348
|
-
# For example `@group1`. Can only be set if Authentication is set to
|
1391
|
+
# For example, `@group1`. Can only be set if Authentication is set to
|
1349
1392
|
# `ActiveDirectory`.
|
1350
1393
|
#
|
1351
1394
|
# @option params [Array<String>] :invalid_user_list
|
@@ -1358,10 +1401,10 @@ module Aws::StorageGateway
|
|
1358
1401
|
# The Amazon Resource Name (ARN) of the storage used for the audit logs.
|
1359
1402
|
#
|
1360
1403
|
# @option params [String] :authentication
|
1361
|
-
# The authentication method that users use to access the file share.
|
1404
|
+
# The authentication method that users use to access the file share. The
|
1405
|
+
# default is `ActiveDirectory`.
|
1362
1406
|
#
|
1363
|
-
# Valid
|
1364
|
-
# `ActiveDirectory`.
|
1407
|
+
# Valid Values: `ActiveDirectory` \| `GuestAccess`
|
1365
1408
|
#
|
1366
1409
|
# @option params [Array<Types::Tag>] :tags
|
1367
1410
|
# A list of up to 50 tags that can be assigned to the NFS file share.
|
@@ -1422,12 +1465,12 @@ module Aws::StorageGateway
|
|
1422
1465
|
# Initiates a snapshot of a volume.
|
1423
1466
|
#
|
1424
1467
|
# AWS Storage Gateway provides the ability to back up point-in-time
|
1425
|
-
# snapshots of your data to Amazon Simple Storage
|
1426
|
-
#
|
1468
|
+
# snapshots of your data to Amazon Simple Storage (Amazon S3) for
|
1469
|
+
# durable off-site recovery, as well as import the data to an Amazon
|
1427
1470
|
# Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud
|
1428
1471
|
# (EC2). You can take snapshots of your gateway volume on a scheduled or
|
1429
|
-
# ad hoc basis. This API enables you to take
|
1430
|
-
#
|
1472
|
+
# ad hoc basis. This API enables you to take ad-hoc snapshot. For more
|
1473
|
+
# information, see [Editing a snapshot schedule][1].
|
1431
1474
|
#
|
1432
1475
|
# In the CreateSnapshot request you identify the volume by providing its
|
1433
1476
|
# Amazon Resource Name (ARN). You must also provide description for the
|
@@ -1440,19 +1483,20 @@ module Aws::StorageGateway
|
|
1440
1483
|
# gateway type.
|
1441
1484
|
#
|
1442
1485
|
# <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. For
|
1443
|
-
# more information, see DescribeSnapshots or DeleteSnapshot in
|
1444
|
-
# API
|
1486
|
+
# more information, see [DescribeSnapshots][2] or [DeleteSnapshot][3] in
|
1487
|
+
# the *Amazon Elastic Compute Cloud API Reference*.
|
1445
1488
|
#
|
1446
1489
|
# </note>
|
1447
1490
|
#
|
1448
1491
|
# Volume and snapshot IDs are changing to a longer length ID format. For
|
1449
|
-
# more information, see the important note on the [Welcome][
|
1492
|
+
# more information, see the important note on the [Welcome][4] page.
|
1450
1493
|
#
|
1451
1494
|
#
|
1452
1495
|
#
|
1453
1496
|
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/managing-volumes.html#SchedulingSnapshot
|
1454
|
-
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/
|
1455
|
-
# [3]: https://docs.aws.amazon.com/
|
1497
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
|
1498
|
+
# [3]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
|
1499
|
+
# [4]: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html
|
1456
1500
|
#
|
1457
1501
|
# @option params [required, String] :volume_arn
|
1458
1502
|
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
@@ -1462,7 +1506,7 @@ module Aws::StorageGateway
|
|
1462
1506
|
# Textual description of the snapshot that appears in the Amazon EC2
|
1463
1507
|
# console, Elastic Block Store snapshots panel in the **Description**
|
1464
1508
|
# field, and in the AWS Storage Gateway snapshot **Details** pane,
|
1465
|
-
# **Description** field
|
1509
|
+
# **Description** field.
|
1466
1510
|
#
|
1467
1511
|
# @option params [Array<Types::Tag>] :tags
|
1468
1512
|
# A list of up to 50 tags that can be assigned to a snapshot. Each tag
|
@@ -1541,10 +1585,16 @@ module Aws::StorageGateway
|
|
1541
1585
|
# from a snapshot.
|
1542
1586
|
#
|
1543
1587
|
# <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. For
|
1544
|
-
# more information,
|
1588
|
+
# more information, see [DescribeSnapshots][1] or [DeleteSnapshot][2] in
|
1589
|
+
# the *Amazon Elastic Compute Cloud API Reference*.
|
1545
1590
|
#
|
1546
1591
|
# </note>
|
1547
1592
|
#
|
1593
|
+
#
|
1594
|
+
#
|
1595
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
|
1596
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
|
1597
|
+
#
|
1548
1598
|
# @option params [required, String] :volume_arn
|
1549
1599
|
# The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
|
1550
1600
|
# DescribeStorediSCSIVolumes operation to return to retrieve the
|
@@ -1554,7 +1604,7 @@ module Aws::StorageGateway
|
|
1554
1604
|
# Textual description of the snapshot that appears in the Amazon EC2
|
1555
1605
|
# console, Elastic Block Store snapshots panel in the **Description**
|
1556
1606
|
# field, and in the AWS Storage Gateway snapshot **Details** pane,
|
1557
|
-
# **Description** field
|
1607
|
+
# **Description** field.
|
1558
1608
|
#
|
1559
1609
|
# @option params [Array<Types::Tag>] :tags
|
1560
1610
|
# A list of up to 50 tags that can be assigned to a snapshot. Each tag
|
@@ -1650,7 +1700,7 @@ module Aws::StorageGateway
|
|
1650
1700
|
# @option params [String] :snapshot_id
|
1651
1701
|
# The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
|
1652
1702
|
# the new stored volume. Specify this field if you want to create the
|
1653
|
-
# iSCSI storage volume from a snapshot otherwise do not include this
|
1703
|
+
# iSCSI storage volume from a snapshot; otherwise, do not include this
|
1654
1704
|
# field. To list snapshots for your account use [DescribeSnapshots][1]
|
1655
1705
|
# in the *Amazon Elastic Compute Cloud API Reference*.
|
1656
1706
|
#
|
@@ -1659,11 +1709,10 @@ module Aws::StorageGateway
|
|
1659
1709
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
|
1660
1710
|
#
|
1661
1711
|
# @option params [required, Boolean] :preserve_existing_data
|
1662
|
-
#
|
1663
|
-
#
|
1664
|
-
# volume.
|
1712
|
+
# Set to true `true` if you want to preserve the data on the local disk.
|
1713
|
+
# Otherwise, set to `false` to create an empty volume.
|
1665
1714
|
#
|
1666
|
-
# Valid Values: true
|
1715
|
+
# Valid Values: `true` \| `false`
|
1667
1716
|
#
|
1668
1717
|
# @option params [required, String] :target_name
|
1669
1718
|
# The name of the iSCSI target used by an initiator to connect to a
|
@@ -1684,13 +1733,16 @@ module Aws::StorageGateway
|
|
1684
1733
|
# Valid Values: A valid IP address.
|
1685
1734
|
#
|
1686
1735
|
# @option params [Boolean] :kms_encrypted
|
1687
|
-
#
|
1688
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1736
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1737
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1738
|
+
#
|
1739
|
+
# Valid Values: `true` \| `false`
|
1689
1740
|
#
|
1690
1741
|
# @option params [String] :kms_key
|
1691
|
-
# The Amazon Resource Name (ARN) of
|
1692
|
-
# server-side encryption.
|
1693
|
-
#
|
1742
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1743
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1744
|
+
# not support asymmetric CMKs. This value can only be set when
|
1745
|
+
# `KMSEncrypted` is `true`. Optional.
|
1694
1746
|
#
|
1695
1747
|
# @option params [Array<Types::Tag>] :tags
|
1696
1748
|
# A list of up to 50 tags that can be assigned to a stored volume. Each
|
@@ -1766,7 +1818,7 @@ module Aws::StorageGateway
|
|
1766
1818
|
|
1767
1819
|
# Creates a virtual tape by using your own barcode. You write data to
|
1768
1820
|
# the virtual tape and then archive the tape. A barcode is unique and
|
1769
|
-
#
|
1821
|
+
# can not be reused if it has already been used on a tape. This applies
|
1770
1822
|
# to barcodes used on deleted tapes. This operation is only supported in
|
1771
1823
|
# the tape gateway type.
|
1772
1824
|
#
|
@@ -1797,22 +1849,25 @@ module Aws::StorageGateway
|
|
1797
1849
|
# </note>
|
1798
1850
|
#
|
1799
1851
|
# @option params [Boolean] :kms_encrypted
|
1800
|
-
#
|
1801
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1852
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1853
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1854
|
+
#
|
1855
|
+
# Valid Values: `true` \| `false`
|
1802
1856
|
#
|
1803
1857
|
# @option params [String] :kms_key
|
1804
|
-
# The Amazon Resource Name (ARN) of
|
1805
|
-
# server-side encryption.
|
1806
|
-
#
|
1858
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1859
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1860
|
+
# not support asymmetric CMKs. This value can only be set when
|
1861
|
+
# `KMSEncrypted` is `true`. Optional.
|
1807
1862
|
#
|
1808
1863
|
# @option params [String] :pool_id
|
1809
1864
|
# The ID of the pool that you want to add your tape to for archiving.
|
1810
1865
|
# The tape in this pool is archived in the S3 storage class that is
|
1811
1866
|
# associated with the pool. When you use your backup application to
|
1812
1867
|
# eject the tape, the tape is archived directly into the storage class
|
1813
|
-
# (S3 Glacier or S3
|
1868
|
+
# (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
|
1814
1869
|
#
|
1815
|
-
# Valid
|
1870
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1816
1871
|
#
|
1817
1872
|
# @option params [Array<Types::Tag>] :tags
|
1818
1873
|
# A list of up to 50 tags that can be assigned to a virtual tape that
|
@@ -1920,13 +1975,16 @@ module Aws::StorageGateway
|
|
1920
1975
|
# </note>
|
1921
1976
|
#
|
1922
1977
|
# @option params [Boolean] :kms_encrypted
|
1923
|
-
#
|
1924
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1978
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1979
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1980
|
+
#
|
1981
|
+
# Valid Values: `true` \| `false`
|
1925
1982
|
#
|
1926
1983
|
# @option params [String] :kms_key
|
1927
|
-
# The Amazon Resource Name (ARN) of
|
1928
|
-
# server-side encryption.
|
1929
|
-
#
|
1984
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1985
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1986
|
+
# not support asymmetric CMKs. This value can only be set when
|
1987
|
+
# `KMSEncrypted` is `true`. Optional.
|
1930
1988
|
#
|
1931
1989
|
# @option params [String] :pool_id
|
1932
1990
|
# The ID of the pool that you want to add your tape to for archiving.
|
@@ -1935,7 +1993,7 @@ module Aws::StorageGateway
|
|
1935
1993
|
# eject the tape, the tape is archived directly into the storage class
|
1936
1994
|
# (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
|
1937
1995
|
#
|
1938
|
-
# Valid
|
1996
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1939
1997
|
#
|
1940
1998
|
# @option params [Array<Types::Tag>] :tags
|
1941
1999
|
# A list of up to 50 tags that can be assigned to a virtual tape. Each
|
@@ -2056,7 +2114,7 @@ module Aws::StorageGateway
|
|
2056
2114
|
# One of the BandwidthType values that indicates the gateway bandwidth
|
2057
2115
|
# rate limit to delete.
|
2058
2116
|
#
|
2059
|
-
# Valid Values: `Upload
|
2117
|
+
# Valid Values: `Upload` \| `Download` \| `All`
|
2060
2118
|
#
|
2061
2119
|
# @return [Types::DeleteBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2062
2120
|
#
|
@@ -2158,11 +2216,13 @@ module Aws::StorageGateway
|
|
2158
2216
|
# The Amazon Resource Name (ARN) of the file share to be deleted.
|
2159
2217
|
#
|
2160
2218
|
# @option params [Boolean] :force_delete
|
2161
|
-
# If this value is set to true
|
2219
|
+
# If this value is set to `true`, the operation deletes a file share
|
2162
2220
|
# immediately and aborts all data uploads to AWS. Otherwise, the file
|
2163
2221
|
# share is not deleted until all data is uploaded to AWS. This process
|
2164
2222
|
# aborts the data upload process, and the file share enters the
|
2165
|
-
#
|
2223
|
+
# `FORCE_DELETING` status.
|
2224
|
+
#
|
2225
|
+
# Valid Values: `true` \| `false`
|
2166
2226
|
#
|
2167
2227
|
# @return [Types::DeleteFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2168
2228
|
#
|
@@ -2205,8 +2265,8 @@ module Aws::StorageGateway
|
|
2205
2265
|
# all remaining Amazon EBS snapshots by canceling your Amazon EC2
|
2206
2266
|
# subscription. If you prefer not to cancel your Amazon EC2
|
2207
2267
|
# subscription, you can delete your snapshots using the Amazon EC2
|
2208
|
-
# console. For more information, see the [
|
2209
|
-
#
|
2268
|
+
# console. For more information, see the [AWS Storage Gateway detail
|
2269
|
+
# page][1].
|
2210
2270
|
#
|
2211
2271
|
#
|
2212
2272
|
#
|
@@ -2258,7 +2318,7 @@ module Aws::StorageGateway
|
|
2258
2318
|
#
|
2259
2319
|
# You can take snapshots of your gateway volumes on a scheduled or ad
|
2260
2320
|
# hoc basis. This API action enables you to delete a snapshot schedule
|
2261
|
-
# for a volume. For more information, see [
|
2321
|
+
# for a volume. For more information, see [Backing up your volumes][1].
|
2262
2322
|
# In the `DeleteSnapshotSchedule` request, you identify the volume by
|
2263
2323
|
# providing its Amazon Resource Name (ARN). This operation is only
|
2264
2324
|
# supported in stored and cached volume gateway types.
|
@@ -2271,7 +2331,7 @@ module Aws::StorageGateway
|
|
2271
2331
|
#
|
2272
2332
|
#
|
2273
2333
|
#
|
2274
|
-
# [1]: https://docs.aws.amazon.com/
|
2334
|
+
# [1]: https://docs.aws.amazon.com/storagegatewaylatest/userguide/backing-up-volumes.html
|
2275
2335
|
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
|
2276
2336
|
#
|
2277
2337
|
# @option params [required, String] :volume_arn
|
@@ -2511,7 +2571,7 @@ module Aws::StorageGateway
|
|
2511
2571
|
# Returns the bandwidth rate limits of a gateway. By default, these
|
2512
2572
|
# limits are not set, which means no bandwidth rate limiting is in
|
2513
2573
|
# effect. This operation is supported for the stored volume, cached
|
2514
|
-
# volume and tape gateway types.
|
2574
|
+
# volume and tape gateway types.
|
2515
2575
|
#
|
2516
2576
|
# This operation only returns a value for a bandwidth rate limit only if
|
2517
2577
|
# the limit is set. If no limits are set for the gateway, then this
|
@@ -2807,6 +2867,7 @@ module Aws::StorageGateway
|
|
2807
2867
|
# * {Types::DescribeGatewayInformationOutput#vpc_endpoint #vpc_endpoint} => String
|
2808
2868
|
# * {Types::DescribeGatewayInformationOutput#cloud_watch_log_group_arn #cloud_watch_log_group_arn} => String
|
2809
2869
|
# * {Types::DescribeGatewayInformationOutput#host_environment #host_environment} => String
|
2870
|
+
# * {Types::DescribeGatewayInformationOutput#endpoint_type #endpoint_type} => String
|
2810
2871
|
#
|
2811
2872
|
#
|
2812
2873
|
# @example Example: To describe metadata about the gateway
|
@@ -2863,6 +2924,7 @@ module Aws::StorageGateway
|
|
2863
2924
|
# resp.vpc_endpoint #=> String
|
2864
2925
|
# resp.cloud_watch_log_group_arn #=> String
|
2865
2926
|
# resp.host_environment #=> String, one of "VMWARE", "HYPER-V", "EC2", "KVM", "OTHER"
|
2927
|
+
# resp.endpoint_type #=> String
|
2866
2928
|
#
|
2867
2929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation AWS API Documentation
|
2868
2930
|
#
|
@@ -3150,7 +3212,7 @@ module Aws::StorageGateway
|
|
3150
3212
|
|
3151
3213
|
# Returns the description of the gateway volumes specified in the
|
3152
3214
|
# request. The list of gateway volumes in the request must be from one
|
3153
|
-
# gateway. In the response AWS Storage Gateway returns volume
|
3215
|
+
# gateway. In the response, AWS Storage Gateway returns volume
|
3154
3216
|
# information sorted by volume ARNs. This operation is only supported in
|
3155
3217
|
# stored volume gateway type.
|
3156
3218
|
#
|
@@ -3517,7 +3579,7 @@ module Aws::StorageGateway
|
|
3517
3579
|
end
|
3518
3580
|
|
3519
3581
|
# Returns information about the upload buffer of a gateway. This
|
3520
|
-
# operation is supported for the stored volume, cached volume and tape
|
3582
|
+
# operation is supported for the stored volume, cached volume, and tape
|
3521
3583
|
# gateway types.
|
3522
3584
|
#
|
3523
3585
|
# The response includes disk IDs that are configured as upload buffer
|
@@ -3814,6 +3876,8 @@ module Aws::StorageGateway
|
|
3814
3876
|
# set to `false`, you must manually disconnect the iSCSI connection from
|
3815
3877
|
# the target volume.
|
3816
3878
|
#
|
3879
|
+
# Valid Values: `true` \| `false`
|
3880
|
+
#
|
3817
3881
|
# @return [Types::DetachVolumeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3818
3882
|
#
|
3819
3883
|
# * {Types::DetachVolumeOutput#volume_arn #volume_arn} => String
|
@@ -4563,9 +4627,12 @@ module Aws::StorageGateway
|
|
4563
4627
|
# as Amazon SNS or AWS Lambda function. This operation is only supported
|
4564
4628
|
# for file gateways.
|
4565
4629
|
#
|
4566
|
-
# For more information, see Getting
|
4567
|
-
# Storage Gateway User Guide
|
4568
|
-
#
|
4630
|
+
# For more information, see [Getting file upload notification][1] in the
|
4631
|
+
# *AWS Storage Gateway User Guide*.
|
4632
|
+
#
|
4633
|
+
#
|
4634
|
+
#
|
4635
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification
|
4569
4636
|
#
|
4570
4637
|
# @option params [required, String] :file_share_arn
|
4571
4638
|
# The Amazon Resource Name (ARN) of the file share.
|
@@ -4601,7 +4668,8 @@ module Aws::StorageGateway
|
|
4601
4668
|
# results. This operation is only supported in the file gateway type.
|
4602
4669
|
# You can subscribe to be notified through an Amazon CloudWatch event
|
4603
4670
|
# when your RefreshCache operation completes. For more information, see
|
4604
|
-
# [Getting
|
4671
|
+
# [Getting notified about file operations][1] in the *AWS Storage
|
4672
|
+
# Gateway User Guide*.
|
4605
4673
|
#
|
4606
4674
|
# When this API is called, it only initiates the refresh operation. When
|
4607
4675
|
# the API call completes and returns a success code, it doesn't
|
@@ -4614,16 +4682,16 @@ module Aws::StorageGateway
|
|
4614
4682
|
# Throttle limit: This API is asynchronous so the gateway will accept no
|
4615
4683
|
# more than two refreshes at any time. We recommend using the
|
4616
4684
|
# refresh-complete CloudWatch event notification before issuing
|
4617
|
-
# additional requests. For more information, see [Getting
|
4618
|
-
#
|
4685
|
+
# additional requests. For more information, see [Getting notified about
|
4686
|
+
# file operations][1] in the *AWS Storage Gateway User Guide*.
|
4619
4687
|
#
|
4620
4688
|
# If you invoke the RefreshCache API when two requests are already being
|
4621
4689
|
# processed, any new request will cause an
|
4622
4690
|
# `InvalidGatewayRequestException` error because too many requests were
|
4623
4691
|
# sent to the server.
|
4624
4692
|
#
|
4625
|
-
# For more information, see
|
4626
|
-
#
|
4693
|
+
# For more information, see [Getting notified about file operations][1]
|
4694
|
+
# in the *AWS Storage Gateway User Guide*.
|
4627
4695
|
#
|
4628
4696
|
#
|
4629
4697
|
#
|
@@ -4636,18 +4704,19 @@ module Aws::StorageGateway
|
|
4636
4704
|
# A comma-separated list of the paths of folders to refresh in the
|
4637
4705
|
# cache. The default is \[`"/"`\]. The default refreshes objects and
|
4638
4706
|
# folders at the root of the Amazon S3 bucket. If `Recursive` is set to
|
4639
|
-
#
|
4707
|
+
# `true`, the entire S3 bucket that the file share has access to is
|
4640
4708
|
# refreshed.
|
4641
4709
|
#
|
4642
4710
|
# @option params [Boolean] :recursive
|
4643
4711
|
# A value that specifies whether to recursively refresh folders in the
|
4644
4712
|
# cache. The refresh includes folders that were in the cache the last
|
4645
4713
|
# time the gateway listed the folder's contents. If this value set to
|
4646
|
-
#
|
4714
|
+
# `true`, each folder that is listed in `FolderList` is recursively
|
4647
4715
|
# updated. Otherwise, subfolders listed in `FolderList` are not
|
4648
4716
|
# refreshed. Only objects that are in folders listed directly under
|
4649
|
-
# `FolderList` are found and used for the update. The default is
|
4650
|
-
#
|
4717
|
+
# `FolderList` are found and used for the update. The default is `true`.
|
4718
|
+
#
|
4719
|
+
# Valid Values: `true` \| `false`
|
4651
4720
|
#
|
4652
4721
|
# @return [Types::RefreshCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4653
4722
|
#
|
@@ -4973,7 +5042,7 @@ module Aws::StorageGateway
|
|
4973
5042
|
# is associated with.
|
4974
5043
|
#
|
4975
5044
|
# @option params [required, String] :password
|
4976
|
-
# The password that you want to set for your SMB
|
5045
|
+
# The password that you want to set for your SMB server.
|
4977
5046
|
#
|
4978
5047
|
# @return [Types::SetSMBGuestPasswordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4979
5048
|
#
|
@@ -5012,7 +5081,7 @@ module Aws::StorageGateway
|
|
5012
5081
|
# </note>
|
5013
5082
|
#
|
5014
5083
|
# After the gateway is shutdown, you cannot call any other API except
|
5015
|
-
# StartGateway, DescribeGatewayInformation and ListGateways. For more
|
5084
|
+
# StartGateway, DescribeGatewayInformation, and ListGateways. For more
|
5016
5085
|
# information, see ActivateGateway. Your applications cannot read from
|
5017
5086
|
# or write to the gateway's storage volumes, and there are no snapshots
|
5018
5087
|
# taken.
|
@@ -5224,7 +5293,7 @@ module Aws::StorageGateway
|
|
5224
5293
|
# the upload and download bandwidth rate limit or specify only one of
|
5225
5294
|
# the two. If you don't set a bandwidth rate limit, the existing rate
|
5226
5295
|
# limit remains. This operation is supported for the stored volume,
|
5227
|
-
# cached volume and tape gateway types.
|
5296
|
+
# cached volume, and tape gateway types.
|
5228
5297
|
#
|
5229
5298
|
# By default, a gateway's bandwidth rate limits are not set. If you
|
5230
5299
|
# don't set any limit, the gateway does not have any limitations on its
|
@@ -5393,7 +5462,7 @@ module Aws::StorageGateway
|
|
5393
5462
|
# The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
|
5394
5463
|
# you want to use to monitor and log events in the gateway.
|
5395
5464
|
#
|
5396
|
-
# For more information, see [What
|
5465
|
+
# For more information, see [What is Amazon CloudWatch logs?][1].
|
5397
5466
|
#
|
5398
5467
|
#
|
5399
5468
|
#
|
@@ -5458,8 +5527,8 @@ module Aws::StorageGateway
|
|
5458
5527
|
# minimize the chance of any disruption to your applications by
|
5459
5528
|
# increasing your iSCSI Initiators' timeouts. For more information
|
5460
5529
|
# about increasing iSCSI Initiator timeouts for Windows and Linux, see
|
5461
|
-
# [Customizing
|
5462
|
-
# Linux iSCSI
|
5530
|
+
# [Customizing your Windows iSCSI settings][1] and [Customizing your
|
5531
|
+
# Linux iSCSI settings][2], respectively.
|
5463
5532
|
#
|
5464
5533
|
#
|
5465
5534
|
#
|
@@ -5537,10 +5606,6 @@ module Aws::StorageGateway
|
|
5537
5606
|
# represented as an ordinal number from 1 to 28, where 1 represents the
|
5538
5607
|
# first day of the month and 28 represents the last day of the month.
|
5539
5608
|
#
|
5540
|
-
# <note markdown="1"> This value is only available for tape and volume gateways.
|
5541
|
-
#
|
5542
|
-
# </note>
|
5543
|
-
#
|
5544
5609
|
# @return [Types::UpdateMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5545
5610
|
#
|
5546
5611
|
# * {Types::UpdateMaintenanceStartTimeOutput#gateway_arn #gateway_arn} => String
|
@@ -5615,56 +5680,67 @@ module Aws::StorageGateway
|
|
5615
5680
|
# The Amazon Resource Name (ARN) of the file share to be updated.
|
5616
5681
|
#
|
5617
5682
|
# @option params [Boolean] :kms_encrypted
|
5618
|
-
#
|
5619
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
5683
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
5684
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
5685
|
+
#
|
5686
|
+
# Valid Values: `true` \| `false`
|
5620
5687
|
#
|
5621
5688
|
# @option params [String] :kms_key
|
5622
|
-
# The Amazon Resource Name (ARN) of
|
5623
|
-
# server-side encryption.
|
5624
|
-
#
|
5689
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
5690
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
5691
|
+
# not support asymmetric CMKs. This value can only be set when
|
5692
|
+
# `KMSEncrypted` is `true`. Optional.
|
5625
5693
|
#
|
5626
5694
|
# @option params [Types::NFSFileShareDefaults] :nfs_file_share_defaults
|
5627
5695
|
# The default values for the file share. Optional.
|
5628
5696
|
#
|
5629
5697
|
# @option params [String] :default_storage_class
|
5630
5698
|
# The default storage class for objects put into an Amazon S3 bucket by
|
5631
|
-
# the file gateway.
|
5632
|
-
#
|
5633
|
-
#
|
5699
|
+
# the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
5700
|
+
# Optional.
|
5701
|
+
#
|
5702
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
5703
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
5634
5704
|
#
|
5635
5705
|
# @option params [String] :object_acl
|
5636
|
-
# A value that sets the access control list permission for objects
|
5637
|
-
# the S3 bucket that a file gateway puts objects into. The default
|
5638
|
-
# is
|
5706
|
+
# A value that sets the access control list (ACL) permission for objects
|
5707
|
+
# in the S3 bucket that a file gateway puts objects into. The default
|
5708
|
+
# value is `private`.
|
5639
5709
|
#
|
5640
5710
|
# @option params [Array<String>] :client_list
|
5641
5711
|
# The list of clients that are allowed to access the file gateway. The
|
5642
5712
|
# list must contain either valid IP addresses or valid CIDR blocks.
|
5643
5713
|
#
|
5644
5714
|
# @option params [String] :squash
|
5645
|
-
# The user mapped to anonymous user.
|
5715
|
+
# The user mapped to anonymous user.
|
5716
|
+
#
|
5717
|
+
# Valid values are the following:
|
5646
5718
|
#
|
5647
|
-
# * `RootSquash
|
5719
|
+
# * `RootSquash`\: Only root is mapped to anonymous user.
|
5648
5720
|
#
|
5649
|
-
# * `NoSquash
|
5721
|
+
# * `NoSquash`\: No one is mapped to anonymous user.
|
5650
5722
|
#
|
5651
|
-
# * `AllSquash
|
5723
|
+
# * `AllSquash`\: Everyone is mapped to anonymous user.
|
5652
5724
|
#
|
5653
5725
|
# @option params [Boolean] :read_only
|
5654
|
-
# A value that sets the write status of a file share.
|
5655
|
-
#
|
5726
|
+
# A value that sets the write status of a file share. Set this value to
|
5727
|
+
# `true` to set the write status to read-only, otherwise set to `false`.
|
5728
|
+
#
|
5729
|
+
# Valid Values: `true` \| `false`
|
5656
5730
|
#
|
5657
5731
|
# @option params [Boolean] :guess_mime_type_enabled
|
5658
5732
|
# A value that enables guessing of the MIME type for uploaded objects
|
5659
|
-
# based on file extensions. Set this value to true to enable MIME type
|
5660
|
-
# guessing,
|
5733
|
+
# based on file extensions. Set this value to `true` to enable MIME type
|
5734
|
+
# guessing, otherwise set to `false`. The default value is `true`.
|
5735
|
+
#
|
5736
|
+
# Valid Values: `true` \| `false`
|
5661
5737
|
#
|
5662
5738
|
# @option params [Boolean] :requester_pays
|
5663
5739
|
# A value that sets who pays the cost of the request and the cost
|
5664
5740
|
# associated with data download from the S3 bucket. If this value is set
|
5665
|
-
# to true
|
5666
|
-
# pays. However, the S3 bucket owner always pays the cost of
|
5667
|
-
# data.
|
5741
|
+
# to `true`, the requester pays the costs; otherwise, the S3 bucket
|
5742
|
+
# owner pays. However, the S3 bucket owner always pays the cost of
|
5743
|
+
# storing data.
|
5668
5744
|
#
|
5669
5745
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
5670
5746
|
# file share, so make sure that the configuration on the file share is
|
@@ -5672,6 +5748,8 @@ module Aws::StorageGateway
|
|
5672
5748
|
#
|
5673
5749
|
# </note>
|
5674
5750
|
#
|
5751
|
+
# Valid Values: `true` \| `false`
|
5752
|
+
#
|
5675
5753
|
# @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5676
5754
|
#
|
5677
5755
|
# * {Types::UpdateNFSFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -5722,8 +5800,8 @@ module Aws::StorageGateway
|
|
5722
5800
|
# is activated in the AWS Region you are creating your file gateway in.
|
5723
5801
|
# If AWS STS is not activated in this AWS Region, activate it. For
|
5724
5802
|
# information about how to activate AWS STS, see [Activating and
|
5725
|
-
#
|
5726
|
-
# Access Management User Guide
|
5803
|
+
# deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
|
5804
|
+
# Access Management User Guide*.
|
5727
5805
|
#
|
5728
5806
|
# File gateways don't support creating hard or symbolic links on a
|
5729
5807
|
# file
|
@@ -5738,40 +5816,49 @@ module Aws::StorageGateway
|
|
5738
5816
|
# update.
|
5739
5817
|
#
|
5740
5818
|
# @option params [Boolean] :kms_encrypted
|
5741
|
-
#
|
5742
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
5819
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
5820
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
5821
|
+
#
|
5822
|
+
# Valid Values: `true` \| `false`
|
5743
5823
|
#
|
5744
5824
|
# @option params [String] :kms_key
|
5745
|
-
# The Amazon Resource Name (ARN) of
|
5746
|
-
# server-side encryption.
|
5747
|
-
#
|
5825
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
5826
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
5827
|
+
# not support asymmetric CMKs. This value can only be set when
|
5828
|
+
# `KMSEncrypted` is `true`. Optional.
|
5748
5829
|
#
|
5749
5830
|
# @option params [String] :default_storage_class
|
5750
5831
|
# The default storage class for objects put into an Amazon S3 bucket by
|
5751
|
-
# the file gateway.
|
5752
|
-
#
|
5753
|
-
#
|
5832
|
+
# the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
5833
|
+
# Optional.
|
5834
|
+
#
|
5835
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
5836
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
5754
5837
|
#
|
5755
5838
|
# @option params [String] :object_acl
|
5756
|
-
# A value that sets the access control list permission for objects
|
5757
|
-
# the S3 bucket that a file gateway puts objects into. The default
|
5758
|
-
# is
|
5839
|
+
# A value that sets the access control list (ACL) permission for objects
|
5840
|
+
# in the S3 bucket that a file gateway puts objects into. The default
|
5841
|
+
# value is `private`.
|
5759
5842
|
#
|
5760
5843
|
# @option params [Boolean] :read_only
|
5761
|
-
# A value that sets the write status of a file share.
|
5762
|
-
#
|
5844
|
+
# A value that sets the write status of a file share. Set this value to
|
5845
|
+
# `true` to set write status to read-only, otherwise set to `false`.
|
5846
|
+
#
|
5847
|
+
# Valid Values: `true` \| `false`
|
5763
5848
|
#
|
5764
5849
|
# @option params [Boolean] :guess_mime_type_enabled
|
5765
5850
|
# A value that enables guessing of the MIME type for uploaded objects
|
5766
|
-
# based on file extensions. Set this value to true to enable MIME type
|
5767
|
-
# guessing,
|
5851
|
+
# based on file extensions. Set this value to `true` to enable MIME type
|
5852
|
+
# guessing, otherwise set to `false`. The default value is `true`.
|
5853
|
+
#
|
5854
|
+
# Valid Values: `true` \| `false`
|
5768
5855
|
#
|
5769
5856
|
# @option params [Boolean] :requester_pays
|
5770
5857
|
# A value that sets who pays the cost of the request and the cost
|
5771
5858
|
# associated with data download from the S3 bucket. If this value is set
|
5772
|
-
# to true
|
5773
|
-
# pays. However, the S3 bucket owner always pays the cost of
|
5774
|
-
# data.
|
5859
|
+
# to `true`, the requester pays the costs; otherwise, the S3 bucket
|
5860
|
+
# owner pays. However, the S3 bucket owner always pays the cost of
|
5861
|
+
# storing data.
|
5775
5862
|
#
|
5776
5863
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
5777
5864
|
# file share, so make sure that the configuration on the file share is
|
@@ -5779,25 +5866,33 @@ module Aws::StorageGateway
|
|
5779
5866
|
#
|
5780
5867
|
# </note>
|
5781
5868
|
#
|
5869
|
+
# Valid Values: `true` \| `false`
|
5870
|
+
#
|
5782
5871
|
# @option params [Boolean] :smbacl_enabled
|
5783
|
-
# Set this value to
|
5784
|
-
# SMB file share. Set it to
|
5872
|
+
# Set this value to `true` to enable access control list (ACL) on the
|
5873
|
+
# SMB file share. Set it to `false` to map file and directory
|
5785
5874
|
# permissions to the POSIX permissions.
|
5786
5875
|
#
|
5787
|
-
# For more information, see
|
5788
|
-
#
|
5789
|
-
#
|
5876
|
+
# For more information, see [Using Microsoft Windows ACLs to control
|
5877
|
+
# access to an SMB file share][1] in the *AWS Storage Gateway User
|
5878
|
+
# Guide*.
|
5879
|
+
#
|
5880
|
+
# Valid Values: `true` \| `false`
|
5881
|
+
#
|
5882
|
+
#
|
5883
|
+
#
|
5884
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
5790
5885
|
#
|
5791
5886
|
# @option params [Array<String>] :admin_user_list
|
5792
5887
|
# A list of users in the Active Directory that have administrator rights
|
5793
5888
|
# to the file share. A group must be prefixed with the @ character. For
|
5794
|
-
# example `@group1`. Can only be set if Authentication is set to
|
5889
|
+
# example, `@group1`. Can only be set if Authentication is set to
|
5795
5890
|
# `ActiveDirectory`.
|
5796
5891
|
#
|
5797
5892
|
# @option params [Array<String>] :valid_user_list
|
5798
5893
|
# A list of users or groups in the Active Directory that are allowed to
|
5799
5894
|
# access the file share. A group must be prefixed with the @ character.
|
5800
|
-
# For example `@group1`. Can only be set if Authentication is set to
|
5895
|
+
# For example, `@group1`. Can only be set if Authentication is set to
|
5801
5896
|
# `ActiveDirectory`.
|
5802
5897
|
#
|
5803
5898
|
# @option params [Array<String>] :invalid_user_list
|
@@ -6003,7 +6098,7 @@ module Aws::StorageGateway
|
|
6003
6098
|
# @option params [required, String] :device_type
|
6004
6099
|
# The type of medium changer you want to select.
|
6005
6100
|
#
|
6006
|
-
# Valid Values:
|
6101
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
6007
6102
|
#
|
6008
6103
|
# @return [Types::UpdateVTLDeviceTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6009
6104
|
#
|
@@ -6057,7 +6152,7 @@ module Aws::StorageGateway
|
|
6057
6152
|
params: params,
|
6058
6153
|
config: config)
|
6059
6154
|
context[:gem_name] = 'aws-sdk-storagegateway'
|
6060
|
-
context[:gem_version] = '1.
|
6155
|
+
context[:gem_version] = '1.44.0'
|
6061
6156
|
Seahorse::Client::Request.new(handlers, context)
|
6062
6157
|
end
|
6063
6158
|
|