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