aws-sdk-storagegateway 1.40.0 → 1.45.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-storagegateway.rb +3 -1
- data/lib/aws-sdk-storagegateway/client.rb +393 -211
- data/lib/aws-sdk-storagegateway/client_api.rb +26 -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 +816 -335
- 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: a09a0f53b6c568dda3f0b6fa19ba505f18ac7eea2db3f0f954df33cf91265e6c
|
4
|
+
data.tar.gz: 1e6f616b6b5d77c7b038de8e7ad9b251fdd88f1aee1fb43d10e1cdba4fbb700e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fe347436c349c66f15dcabc8b79e9bf6c70cc4ca24ec8a7fb1d0c08ce734038a627f1c356a8f07b0940f98185a4ad8a91502f1f6f0c69c5b338ac52402573f5b
|
7
|
+
data.tar.gz: 678df12d15ecd03022173fce4b65548bf89c0fb514358c52c57964c1ce7e3281ad8c44ddd0319afa479c8dfc5242a0bacf2ad89378b5e7a223451bcbc8e8a800
|
@@ -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.45.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
|
|
@@ -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 a valid HTTP(S) URI.
|
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,61 +1141,72 @@ 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
|
1140
1157
|
# file gateway assumes when it accesses the underlying storage.
|
1141
1158
|
#
|
1142
1159
|
# @option params [required, String] :location_arn
|
1143
|
-
# The ARN of the
|
1160
|
+
# The ARN of the backend storage used for storing file data. A prefix
|
1161
|
+
# name can be added to the S3 bucket name. It must end with a "/".
|
1144
1162
|
#
|
1145
1163
|
# @option params [String] :default_storage_class
|
1146
1164
|
# The default storage class for objects put into an Amazon S3 bucket by
|
1147
|
-
# the file gateway.
|
1148
|
-
#
|
1149
|
-
#
|
1165
|
+
# the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
1166
|
+
# Optional.
|
1167
|
+
#
|
1168
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
1169
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
1150
1170
|
#
|
1151
1171
|
# @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
|
1172
|
+
# A value that sets the access control list (ACL) permission for objects
|
1173
|
+
# in the S3 bucket that a file gateway puts objects into. The default
|
1174
|
+
# value is `private`.
|
1155
1175
|
#
|
1156
1176
|
# @option params [Array<String>] :client_list
|
1157
1177
|
# The list of clients that are allowed to access the file gateway. The
|
1158
1178
|
# list must contain either valid IP addresses or valid CIDR blocks.
|
1159
1179
|
#
|
1160
1180
|
# @option params [String] :squash
|
1161
|
-
# A value that maps a user to anonymous user.
|
1162
|
-
# following:
|
1181
|
+
# A value that maps a user to anonymous user.
|
1163
1182
|
#
|
1164
|
-
#
|
1183
|
+
# Valid values are the following:
|
1165
1184
|
#
|
1166
|
-
# * `
|
1185
|
+
# * `RootSquash`\: Only root is mapped to anonymous user.
|
1167
1186
|
#
|
1168
|
-
# * `
|
1187
|
+
# * `NoSquash`\: No one is mapped to anonymous user.
|
1188
|
+
#
|
1189
|
+
# * `AllSquash`\: Everyone is mapped to anonymous user.
|
1169
1190
|
#
|
1170
1191
|
# @option params [Boolean] :read_only
|
1171
|
-
# A value that sets the write status of a file share.
|
1172
|
-
#
|
1192
|
+
# A value that sets the write status of a file share. Set this value to
|
1193
|
+
# `true` to set the write status to read-only, otherwise set to `false`.
|
1194
|
+
#
|
1195
|
+
# Valid Values: `true` \| `false`
|
1173
1196
|
#
|
1174
1197
|
# @option params [Boolean] :guess_mime_type_enabled
|
1175
1198
|
# 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,
|
1199
|
+
# based on file extensions. Set this value to `true` to enable MIME type
|
1200
|
+
# guessing, otherwise set to `false`. The default value is `true`.
|
1201
|
+
#
|
1202
|
+
# Valid Values: `true` \| `false`
|
1178
1203
|
#
|
1179
1204
|
# @option params [Boolean] :requester_pays
|
1180
1205
|
# A value that sets who pays the cost of the request and the cost
|
1181
1206
|
# 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.
|
1207
|
+
# to `true`, the requester pays the costs; otherwise, the S3 bucket
|
1208
|
+
# owner pays. However, the S3 bucket owner always pays the cost of
|
1209
|
+
# storing data.
|
1185
1210
|
#
|
1186
1211
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
1187
1212
|
# file share, so make sure that the configuration on the file share is
|
@@ -1189,6 +1214,8 @@ module Aws::StorageGateway
|
|
1189
1214
|
#
|
1190
1215
|
# </note>
|
1191
1216
|
#
|
1217
|
+
# Valid Values: `true` \| `false`
|
1218
|
+
#
|
1192
1219
|
# @option params [Array<Types::Tag>] :tags
|
1193
1220
|
# A list of up to 50 tags that can be assigned to the NFS file share.
|
1194
1221
|
# Each tag is a key-value pair.
|
@@ -1200,6 +1227,17 @@ module Aws::StorageGateway
|
|
1200
1227
|
#
|
1201
1228
|
# </note>
|
1202
1229
|
#
|
1230
|
+
# @option params [String] :file_share_name
|
1231
|
+
# The name of the file share. Optional.
|
1232
|
+
#
|
1233
|
+
# <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
|
1234
|
+
# `LocationARN`.
|
1235
|
+
#
|
1236
|
+
# </note>
|
1237
|
+
#
|
1238
|
+
# @option params [Types::CacheAttributes] :cache_attributes
|
1239
|
+
# Refresh cache information.
|
1240
|
+
#
|
1203
1241
|
# @return [Types::CreateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1204
1242
|
#
|
1205
1243
|
# * {Types::CreateNFSFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -1232,6 +1270,10 @@ module Aws::StorageGateway
|
|
1232
1270
|
# value: "TagValue", # required
|
1233
1271
|
# },
|
1234
1272
|
# ],
|
1273
|
+
# file_share_name: "FileShareName",
|
1274
|
+
# cache_attributes: {
|
1275
|
+
# cache_stale_timeout_in_seconds: 1,
|
1276
|
+
# },
|
1235
1277
|
# })
|
1236
1278
|
#
|
1237
1279
|
# @example Response structure
|
@@ -1258,8 +1300,8 @@ module Aws::StorageGateway
|
|
1258
1300
|
# is activated in the AWS Region you are creating your file gateway in.
|
1259
1301
|
# If AWS STS is not activated in this AWS Region, activate it. For
|
1260
1302
|
# information about how to activate AWS STS, see [Activating and
|
1261
|
-
#
|
1262
|
-
# Access Management User Guide
|
1303
|
+
# deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
|
1304
|
+
# Access Management User Guide*.
|
1263
1305
|
#
|
1264
1306
|
# File gateways don't support creating hard or symbolic links on a
|
1265
1307
|
# file
|
@@ -1277,47 +1319,57 @@ module Aws::StorageGateway
|
|
1277
1319
|
# The ARN of the file gateway on which you want to create a file share.
|
1278
1320
|
#
|
1279
1321
|
# @option params [Boolean] :kms_encrypted
|
1280
|
-
#
|
1281
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1322
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1323
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1324
|
+
#
|
1325
|
+
# Valid Values: `true` \| `false`
|
1282
1326
|
#
|
1283
1327
|
# @option params [String] :kms_key
|
1284
|
-
# The Amazon Resource Name (ARN) of
|
1285
|
-
# server-side encryption.
|
1286
|
-
#
|
1328
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1329
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1330
|
+
# not support asymmetric CMKs. This value can only be set when
|
1331
|
+
# `KMSEncrypted` is `true`. Optional.
|
1287
1332
|
#
|
1288
1333
|
# @option params [required, String] :role
|
1289
1334
|
# The ARN of the AWS Identity and Access Management (IAM) role that a
|
1290
1335
|
# file gateway assumes when it accesses the underlying storage.
|
1291
1336
|
#
|
1292
1337
|
# @option params [required, String] :location_arn
|
1293
|
-
# The ARN of the
|
1338
|
+
# The ARN of the backend storage used for storing file data. A prefix
|
1339
|
+
# name can be added to the S3 bucket name. It must end with a "/".
|
1294
1340
|
#
|
1295
1341
|
# @option params [String] :default_storage_class
|
1296
1342
|
# The default storage class for objects put into an Amazon S3 bucket by
|
1297
|
-
# the file gateway.
|
1298
|
-
#
|
1299
|
-
#
|
1343
|
+
# the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
1344
|
+
# Optional.
|
1345
|
+
#
|
1346
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
1347
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
1300
1348
|
#
|
1301
1349
|
# @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
|
1350
|
+
# A value that sets the access control list (ACL) permission for objects
|
1351
|
+
# in the S3 bucket that a file gateway puts objects into. The default
|
1352
|
+
# value is `private`.
|
1305
1353
|
#
|
1306
1354
|
# @option params [Boolean] :read_only
|
1307
|
-
# A value that sets the write status of a file share.
|
1308
|
-
#
|
1355
|
+
# A value that sets the write status of a file share. Set this value to
|
1356
|
+
# `true` to set the write status to read-only, otherwise set to `false`.
|
1357
|
+
#
|
1358
|
+
# Valid Values: `true` \| `false`
|
1309
1359
|
#
|
1310
1360
|
# @option params [Boolean] :guess_mime_type_enabled
|
1311
1361
|
# 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,
|
1362
|
+
# based on file extensions. Set this value to `true` to enable MIME type
|
1363
|
+
# guessing, otherwise set to `false`. The default value is `true`.
|
1364
|
+
#
|
1365
|
+
# Valid Values: `true` \| `false`
|
1314
1366
|
#
|
1315
1367
|
# @option params [Boolean] :requester_pays
|
1316
1368
|
# A value that sets who pays the cost of the request and the cost
|
1317
1369
|
# 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.
|
1370
|
+
# to `true`, the requester pays the costs; otherwise, the S3 bucket
|
1371
|
+
# owner pays. However, the S3 bucket owner always pays the cost of
|
1372
|
+
# storing data.
|
1321
1373
|
#
|
1322
1374
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
1323
1375
|
# file share, so make sure that the configuration on the file share is
|
@@ -1325,43 +1377,60 @@ module Aws::StorageGateway
|
|
1325
1377
|
#
|
1326
1378
|
# </note>
|
1327
1379
|
#
|
1380
|
+
# Valid Values: `true` \| `false`
|
1381
|
+
#
|
1328
1382
|
# @option params [Boolean] :smbacl_enabled
|
1329
|
-
# Set this value to
|
1330
|
-
# SMB file share. Set it to
|
1383
|
+
# Set this value to `true` to enable access control list (ACL) on the
|
1384
|
+
# SMB file share. Set it to `false` to map file and directory
|
1331
1385
|
# permissions to the POSIX permissions.
|
1332
1386
|
#
|
1333
|
-
# For more information, see
|
1334
|
-
#
|
1335
|
-
#
|
1387
|
+
# For more information, see [Using Microsoft Windows ACLs to control
|
1388
|
+
# access to an SMB file share][1] in the *AWS Storage Gateway User
|
1389
|
+
# Guide*.
|
1390
|
+
#
|
1391
|
+
# Valid Values: `true` \| `false`
|
1392
|
+
#
|
1393
|
+
#
|
1394
|
+
#
|
1395
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
1336
1396
|
#
|
1337
1397
|
# @option params [Array<String>] :admin_user_list
|
1338
|
-
# A list of users in the Active Directory that will be granted
|
1398
|
+
# A list of users or groups in the Active Directory that will be granted
|
1339
1399
|
# administrator privileges on the file share. These users can do all
|
1340
|
-
# file operations as the super-user.
|
1400
|
+
# file operations as the super-user. Acceptable formats include:
|
1401
|
+
# `DOMAIN\User1`, `user1`, `@group1`, and `@DOMAIN\group1`.
|
1341
1402
|
#
|
1342
1403
|
# Use this option very carefully, because any user in this list can do
|
1343
1404
|
# anything they like on the file share, regardless of file permissions.
|
1344
1405
|
#
|
1345
1406
|
# @option params [Array<String>] :valid_user_list
|
1346
1407
|
# A list of users or groups in the Active Directory that are allowed to
|
1347
|
-
# access the file share. A group must be prefixed with the @
|
1348
|
-
#
|
1349
|
-
#
|
1408
|
+
# access the file []() share. A group must be prefixed with the @
|
1409
|
+
# character. Acceptable formats include: `DOMAIN\User1`, `user1`,
|
1410
|
+
# `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
|
1411
|
+
# set to `ActiveDirectory`.
|
1350
1412
|
#
|
1351
1413
|
# @option params [Array<String>] :invalid_user_list
|
1352
1414
|
# A list of users or groups in the Active Directory that are not allowed
|
1353
1415
|
# to access the file share. A group must be prefixed with the @
|
1354
|
-
# character.
|
1355
|
-
#
|
1416
|
+
# character. Acceptable formats include: `DOMAIN\User1`, `user1`,
|
1417
|
+
# `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
|
1418
|
+
# set to `ActiveDirectory`.
|
1356
1419
|
#
|
1357
1420
|
# @option params [String] :audit_destination_arn
|
1358
1421
|
# The Amazon Resource Name (ARN) of the storage used for the audit logs.
|
1359
1422
|
#
|
1360
1423
|
# @option params [String] :authentication
|
1361
|
-
# The authentication method that users use to access the file share.
|
1424
|
+
# The authentication method that users use to access the file share. The
|
1425
|
+
# default is `ActiveDirectory`.
|
1362
1426
|
#
|
1363
|
-
# Valid
|
1364
|
-
#
|
1427
|
+
# Valid Values: `ActiveDirectory` \| `GuestAccess`
|
1428
|
+
#
|
1429
|
+
# @option params [String] :case_sensitivity
|
1430
|
+
# The case of an object name in an Amazon S3 bucket. For
|
1431
|
+
# `ClientSpecified`, the client determines the case sensitivity. For
|
1432
|
+
# `CaseSensitive`, the gateway determines the case sensitivity. The
|
1433
|
+
# default value is `ClientSpecified`.
|
1365
1434
|
#
|
1366
1435
|
# @option params [Array<Types::Tag>] :tags
|
1367
1436
|
# A list of up to 50 tags that can be assigned to the NFS file share.
|
@@ -1374,6 +1443,17 @@ module Aws::StorageGateway
|
|
1374
1443
|
#
|
1375
1444
|
# </note>
|
1376
1445
|
#
|
1446
|
+
# @option params [String] :file_share_name
|
1447
|
+
# The name of the file share. Optional.
|
1448
|
+
#
|
1449
|
+
# <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
|
1450
|
+
# `LocationARN`.
|
1451
|
+
#
|
1452
|
+
# </note>
|
1453
|
+
#
|
1454
|
+
# @option params [Types::CacheAttributes] :cache_attributes
|
1455
|
+
# Refresh cache information.
|
1456
|
+
#
|
1377
1457
|
# @return [Types::CreateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1378
1458
|
#
|
1379
1459
|
# * {Types::CreateSMBFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -1398,12 +1478,17 @@ module Aws::StorageGateway
|
|
1398
1478
|
# invalid_user_list: ["FileShareUser"],
|
1399
1479
|
# audit_destination_arn: "AuditDestinationARN",
|
1400
1480
|
# authentication: "Authentication",
|
1481
|
+
# case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
|
1401
1482
|
# tags: [
|
1402
1483
|
# {
|
1403
1484
|
# key: "TagKey", # required
|
1404
1485
|
# value: "TagValue", # required
|
1405
1486
|
# },
|
1406
1487
|
# ],
|
1488
|
+
# file_share_name: "FileShareName",
|
1489
|
+
# cache_attributes: {
|
1490
|
+
# cache_stale_timeout_in_seconds: 1,
|
1491
|
+
# },
|
1407
1492
|
# })
|
1408
1493
|
#
|
1409
1494
|
# @example Response structure
|
@@ -1422,12 +1507,12 @@ module Aws::StorageGateway
|
|
1422
1507
|
# Initiates a snapshot of a volume.
|
1423
1508
|
#
|
1424
1509
|
# AWS Storage Gateway provides the ability to back up point-in-time
|
1425
|
-
# snapshots of your data to Amazon Simple Storage
|
1426
|
-
#
|
1510
|
+
# snapshots of your data to Amazon Simple Storage (Amazon S3) for
|
1511
|
+
# durable off-site recovery, as well as import the data to an Amazon
|
1427
1512
|
# Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud
|
1428
1513
|
# (EC2). You can take snapshots of your gateway volume on a scheduled or
|
1429
|
-
# ad hoc basis. This API enables you to take
|
1430
|
-
#
|
1514
|
+
# ad hoc basis. This API enables you to take ad-hoc snapshot. For more
|
1515
|
+
# information, see [Editing a snapshot schedule][1].
|
1431
1516
|
#
|
1432
1517
|
# In the CreateSnapshot request you identify the volume by providing its
|
1433
1518
|
# Amazon Resource Name (ARN). You must also provide description for the
|
@@ -1440,19 +1525,20 @@ module Aws::StorageGateway
|
|
1440
1525
|
# gateway type.
|
1441
1526
|
#
|
1442
1527
|
# <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
|
1528
|
+
# more information, see [DescribeSnapshots][2] or [DeleteSnapshot][3] in
|
1529
|
+
# the *Amazon Elastic Compute Cloud API Reference*.
|
1445
1530
|
#
|
1446
1531
|
# </note>
|
1447
1532
|
#
|
1448
1533
|
# Volume and snapshot IDs are changing to a longer length ID format. For
|
1449
|
-
# more information, see the important note on the [Welcome][
|
1534
|
+
# more information, see the important note on the [Welcome][4] page.
|
1450
1535
|
#
|
1451
1536
|
#
|
1452
1537
|
#
|
1453
1538
|
# [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/
|
1539
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
|
1540
|
+
# [3]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
|
1541
|
+
# [4]: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html
|
1456
1542
|
#
|
1457
1543
|
# @option params [required, String] :volume_arn
|
1458
1544
|
# The Amazon Resource Name (ARN) of the volume. Use the ListVolumes
|
@@ -1462,7 +1548,7 @@ module Aws::StorageGateway
|
|
1462
1548
|
# Textual description of the snapshot that appears in the Amazon EC2
|
1463
1549
|
# console, Elastic Block Store snapshots panel in the **Description**
|
1464
1550
|
# field, and in the AWS Storage Gateway snapshot **Details** pane,
|
1465
|
-
# **Description** field
|
1551
|
+
# **Description** field.
|
1466
1552
|
#
|
1467
1553
|
# @option params [Array<Types::Tag>] :tags
|
1468
1554
|
# A list of up to 50 tags that can be assigned to a snapshot. Each tag
|
@@ -1541,10 +1627,16 @@ module Aws::StorageGateway
|
|
1541
1627
|
# from a snapshot.
|
1542
1628
|
#
|
1543
1629
|
# <note markdown="1"> To list or delete a snapshot, you must use the Amazon EC2 API. For
|
1544
|
-
# more information,
|
1630
|
+
# more information, see [DescribeSnapshots][1] or [DeleteSnapshot][2] in
|
1631
|
+
# the *Amazon Elastic Compute Cloud API Reference*.
|
1545
1632
|
#
|
1546
1633
|
# </note>
|
1547
1634
|
#
|
1635
|
+
#
|
1636
|
+
#
|
1637
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
|
1638
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteSnapshot.html
|
1639
|
+
#
|
1548
1640
|
# @option params [required, String] :volume_arn
|
1549
1641
|
# The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
|
1550
1642
|
# DescribeStorediSCSIVolumes operation to return to retrieve the
|
@@ -1554,7 +1646,7 @@ module Aws::StorageGateway
|
|
1554
1646
|
# Textual description of the snapshot that appears in the Amazon EC2
|
1555
1647
|
# console, Elastic Block Store snapshots panel in the **Description**
|
1556
1648
|
# field, and in the AWS Storage Gateway snapshot **Details** pane,
|
1557
|
-
# **Description** field
|
1649
|
+
# **Description** field.
|
1558
1650
|
#
|
1559
1651
|
# @option params [Array<Types::Tag>] :tags
|
1560
1652
|
# A list of up to 50 tags that can be assigned to a snapshot. Each tag
|
@@ -1650,7 +1742,7 @@ module Aws::StorageGateway
|
|
1650
1742
|
# @option params [String] :snapshot_id
|
1651
1743
|
# The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
|
1652
1744
|
# 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
|
1745
|
+
# iSCSI storage volume from a snapshot; otherwise, do not include this
|
1654
1746
|
# field. To list snapshots for your account use [DescribeSnapshots][1]
|
1655
1747
|
# in the *Amazon Elastic Compute Cloud API Reference*.
|
1656
1748
|
#
|
@@ -1659,11 +1751,10 @@ module Aws::StorageGateway
|
|
1659
1751
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
|
1660
1752
|
#
|
1661
1753
|
# @option params [required, Boolean] :preserve_existing_data
|
1662
|
-
#
|
1663
|
-
#
|
1664
|
-
# volume.
|
1754
|
+
# Set to true `true` if you want to preserve the data on the local disk.
|
1755
|
+
# Otherwise, set to `false` to create an empty volume.
|
1665
1756
|
#
|
1666
|
-
# Valid Values: true
|
1757
|
+
# Valid Values: `true` \| `false`
|
1667
1758
|
#
|
1668
1759
|
# @option params [required, String] :target_name
|
1669
1760
|
# The name of the iSCSI target used by an initiator to connect to a
|
@@ -1684,13 +1775,16 @@ module Aws::StorageGateway
|
|
1684
1775
|
# Valid Values: A valid IP address.
|
1685
1776
|
#
|
1686
1777
|
# @option params [Boolean] :kms_encrypted
|
1687
|
-
#
|
1688
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1778
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1779
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1780
|
+
#
|
1781
|
+
# Valid Values: `true` \| `false`
|
1689
1782
|
#
|
1690
1783
|
# @option params [String] :kms_key
|
1691
|
-
# The Amazon Resource Name (ARN) of
|
1692
|
-
# server-side encryption.
|
1693
|
-
#
|
1784
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1785
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1786
|
+
# not support asymmetric CMKs. This value can only be set when
|
1787
|
+
# `KMSEncrypted` is `true`. Optional.
|
1694
1788
|
#
|
1695
1789
|
# @option params [Array<Types::Tag>] :tags
|
1696
1790
|
# A list of up to 50 tags that can be assigned to a stored volume. Each
|
@@ -1766,7 +1860,7 @@ module Aws::StorageGateway
|
|
1766
1860
|
|
1767
1861
|
# Creates a virtual tape by using your own barcode. You write data to
|
1768
1862
|
# the virtual tape and then archive the tape. A barcode is unique and
|
1769
|
-
#
|
1863
|
+
# can not be reused if it has already been used on a tape. This applies
|
1770
1864
|
# to barcodes used on deleted tapes. This operation is only supported in
|
1771
1865
|
# the tape gateway type.
|
1772
1866
|
#
|
@@ -1797,22 +1891,25 @@ module Aws::StorageGateway
|
|
1797
1891
|
# </note>
|
1798
1892
|
#
|
1799
1893
|
# @option params [Boolean] :kms_encrypted
|
1800
|
-
#
|
1801
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
1894
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
1895
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
1896
|
+
#
|
1897
|
+
# Valid Values: `true` \| `false`
|
1802
1898
|
#
|
1803
1899
|
# @option params [String] :kms_key
|
1804
|
-
# The Amazon Resource Name (ARN) of
|
1805
|
-
# server-side encryption.
|
1806
|
-
#
|
1900
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
1901
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
1902
|
+
# not support asymmetric CMKs. This value can only be set when
|
1903
|
+
# `KMSEncrypted` is `true`. Optional.
|
1807
1904
|
#
|
1808
1905
|
# @option params [String] :pool_id
|
1809
1906
|
# The ID of the pool that you want to add your tape to for archiving.
|
1810
1907
|
# The tape in this pool is archived in the S3 storage class that is
|
1811
1908
|
# associated with the pool. When you use your backup application to
|
1812
1909
|
# eject the tape, the tape is archived directly into the storage class
|
1813
|
-
# (S3 Glacier or S3
|
1910
|
+
# (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
|
1814
1911
|
#
|
1815
|
-
# Valid
|
1912
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1816
1913
|
#
|
1817
1914
|
# @option params [Array<Types::Tag>] :tags
|
1818
1915
|
# A list of up to 50 tags that can be assigned to a virtual tape that
|
@@ -1920,13 +2017,16 @@ module Aws::StorageGateway
|
|
1920
2017
|
# </note>
|
1921
2018
|
#
|
1922
2019
|
# @option params [Boolean] :kms_encrypted
|
1923
|
-
#
|
1924
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
2020
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
2021
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
2022
|
+
#
|
2023
|
+
# Valid Values: `true` \| `false`
|
1925
2024
|
#
|
1926
2025
|
# @option params [String] :kms_key
|
1927
|
-
# The Amazon Resource Name (ARN) of
|
1928
|
-
# server-side encryption.
|
1929
|
-
#
|
2026
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
2027
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
2028
|
+
# not support asymmetric CMKs. This value can only be set when
|
2029
|
+
# `KMSEncrypted` is `true`. Optional.
|
1930
2030
|
#
|
1931
2031
|
# @option params [String] :pool_id
|
1932
2032
|
# The ID of the pool that you want to add your tape to for archiving.
|
@@ -1935,7 +2035,7 @@ module Aws::StorageGateway
|
|
1935
2035
|
# eject the tape, the tape is archived directly into the storage class
|
1936
2036
|
# (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
|
1937
2037
|
#
|
1938
|
-
# Valid
|
2038
|
+
# Valid Values: `GLACIER` \| `DEEP_ARCHIVE`
|
1939
2039
|
#
|
1940
2040
|
# @option params [Array<Types::Tag>] :tags
|
1941
2041
|
# A list of up to 50 tags that can be assigned to a virtual tape. Each
|
@@ -2056,7 +2156,7 @@ module Aws::StorageGateway
|
|
2056
2156
|
# One of the BandwidthType values that indicates the gateway bandwidth
|
2057
2157
|
# rate limit to delete.
|
2058
2158
|
#
|
2059
|
-
# Valid Values: `Upload
|
2159
|
+
# Valid Values: `Upload` \| `Download` \| `All`
|
2060
2160
|
#
|
2061
2161
|
# @return [Types::DeleteBandwidthRateLimitOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2062
2162
|
#
|
@@ -2158,11 +2258,13 @@ module Aws::StorageGateway
|
|
2158
2258
|
# The Amazon Resource Name (ARN) of the file share to be deleted.
|
2159
2259
|
#
|
2160
2260
|
# @option params [Boolean] :force_delete
|
2161
|
-
# If this value is set to true
|
2261
|
+
# If this value is set to `true`, the operation deletes a file share
|
2162
2262
|
# immediately and aborts all data uploads to AWS. Otherwise, the file
|
2163
2263
|
# share is not deleted until all data is uploaded to AWS. This process
|
2164
2264
|
# aborts the data upload process, and the file share enters the
|
2165
|
-
#
|
2265
|
+
# `FORCE_DELETING` status.
|
2266
|
+
#
|
2267
|
+
# Valid Values: `true` \| `false`
|
2166
2268
|
#
|
2167
2269
|
# @return [Types::DeleteFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2168
2270
|
#
|
@@ -2205,8 +2307,8 @@ module Aws::StorageGateway
|
|
2205
2307
|
# all remaining Amazon EBS snapshots by canceling your Amazon EC2
|
2206
2308
|
# subscription. If you prefer not to cancel your Amazon EC2
|
2207
2309
|
# subscription, you can delete your snapshots using the Amazon EC2
|
2208
|
-
# console. For more information, see the [
|
2209
|
-
#
|
2310
|
+
# console. For more information, see the [AWS Storage Gateway detail
|
2311
|
+
# page][1].
|
2210
2312
|
#
|
2211
2313
|
#
|
2212
2314
|
#
|
@@ -2258,7 +2360,7 @@ module Aws::StorageGateway
|
|
2258
2360
|
#
|
2259
2361
|
# You can take snapshots of your gateway volumes on a scheduled or ad
|
2260
2362
|
# hoc basis. This API action enables you to delete a snapshot schedule
|
2261
|
-
# for a volume. For more information, see [
|
2363
|
+
# for a volume. For more information, see [Backing up your volumes][1].
|
2262
2364
|
# In the `DeleteSnapshotSchedule` request, you identify the volume by
|
2263
2365
|
# providing its Amazon Resource Name (ARN). This operation is only
|
2264
2366
|
# supported in stored and cached volume gateway types.
|
@@ -2271,7 +2373,7 @@ module Aws::StorageGateway
|
|
2271
2373
|
#
|
2272
2374
|
#
|
2273
2375
|
#
|
2274
|
-
# [1]: https://docs.aws.amazon.com/
|
2376
|
+
# [1]: https://docs.aws.amazon.com/storagegatewaylatest/userguide/backing-up-volumes.html
|
2275
2377
|
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html
|
2276
2378
|
#
|
2277
2379
|
# @option params [required, String] :volume_arn
|
@@ -2511,7 +2613,7 @@ module Aws::StorageGateway
|
|
2511
2613
|
# Returns the bandwidth rate limits of a gateway. By default, these
|
2512
2614
|
# limits are not set, which means no bandwidth rate limiting is in
|
2513
2615
|
# effect. This operation is supported for the stored volume, cached
|
2514
|
-
# volume and tape gateway types.
|
2616
|
+
# volume and tape gateway types.
|
2515
2617
|
#
|
2516
2618
|
# This operation only returns a value for a bandwidth rate limit only if
|
2517
2619
|
# the limit is set. If no limits are set for the gateway, then this
|
@@ -2807,6 +2909,7 @@ module Aws::StorageGateway
|
|
2807
2909
|
# * {Types::DescribeGatewayInformationOutput#vpc_endpoint #vpc_endpoint} => String
|
2808
2910
|
# * {Types::DescribeGatewayInformationOutput#cloud_watch_log_group_arn #cloud_watch_log_group_arn} => String
|
2809
2911
|
# * {Types::DescribeGatewayInformationOutput#host_environment #host_environment} => String
|
2912
|
+
# * {Types::DescribeGatewayInformationOutput#endpoint_type #endpoint_type} => String
|
2810
2913
|
#
|
2811
2914
|
#
|
2812
2915
|
# @example Example: To describe metadata about the gateway
|
@@ -2863,6 +2966,7 @@ module Aws::StorageGateway
|
|
2863
2966
|
# resp.vpc_endpoint #=> String
|
2864
2967
|
# resp.cloud_watch_log_group_arn #=> String
|
2865
2968
|
# resp.host_environment #=> String, one of "VMWARE", "HYPER-V", "EC2", "KVM", "OTHER"
|
2969
|
+
# resp.endpoint_type #=> String
|
2866
2970
|
#
|
2867
2971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformation AWS API Documentation
|
2868
2972
|
#
|
@@ -2978,6 +3082,8 @@ module Aws::StorageGateway
|
|
2978
3082
|
# resp.nfs_file_share_info_list[0].tags #=> Array
|
2979
3083
|
# resp.nfs_file_share_info_list[0].tags[0].key #=> String
|
2980
3084
|
# resp.nfs_file_share_info_list[0].tags[0].value #=> String
|
3085
|
+
# resp.nfs_file_share_info_list[0].file_share_name #=> String
|
3086
|
+
# resp.nfs_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
|
2981
3087
|
#
|
2982
3088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeNFSFileShares AWS API Documentation
|
2983
3089
|
#
|
@@ -3032,9 +3138,12 @@ module Aws::StorageGateway
|
|
3032
3138
|
# resp.smb_file_share_info_list[0].invalid_user_list[0] #=> String
|
3033
3139
|
# resp.smb_file_share_info_list[0].audit_destination_arn #=> String
|
3034
3140
|
# resp.smb_file_share_info_list[0].authentication #=> String
|
3141
|
+
# resp.smb_file_share_info_list[0].case_sensitivity #=> String, one of "ClientSpecified", "CaseSensitive"
|
3035
3142
|
# resp.smb_file_share_info_list[0].tags #=> Array
|
3036
3143
|
# resp.smb_file_share_info_list[0].tags[0].key #=> String
|
3037
3144
|
# resp.smb_file_share_info_list[0].tags[0].value #=> String
|
3145
|
+
# resp.smb_file_share_info_list[0].file_share_name #=> String
|
3146
|
+
# resp.smb_file_share_info_list[0].cache_attributes.cache_stale_timeout_in_seconds #=> Integer
|
3038
3147
|
#
|
3039
3148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBFileShares AWS API Documentation
|
3040
3149
|
#
|
@@ -3150,7 +3259,7 @@ module Aws::StorageGateway
|
|
3150
3259
|
|
3151
3260
|
# Returns the description of the gateway volumes specified in the
|
3152
3261
|
# request. The list of gateway volumes in the request must be from one
|
3153
|
-
# gateway. In the response AWS Storage Gateway returns volume
|
3262
|
+
# gateway. In the response, AWS Storage Gateway returns volume
|
3154
3263
|
# information sorted by volume ARNs. This operation is only supported in
|
3155
3264
|
# stored volume gateway type.
|
3156
3265
|
#
|
@@ -3517,7 +3626,7 @@ module Aws::StorageGateway
|
|
3517
3626
|
end
|
3518
3627
|
|
3519
3628
|
# Returns information about the upload buffer of a gateway. This
|
3520
|
-
# operation is supported for the stored volume, cached volume and tape
|
3629
|
+
# operation is supported for the stored volume, cached volume, and tape
|
3521
3630
|
# gateway types.
|
3522
3631
|
#
|
3523
3632
|
# The response includes disk IDs that are configured as upload buffer
|
@@ -3814,6 +3923,8 @@ module Aws::StorageGateway
|
|
3814
3923
|
# set to `false`, you must manually disconnect the iSCSI connection from
|
3815
3924
|
# the target volume.
|
3816
3925
|
#
|
3926
|
+
# Valid Values: `true` \| `false`
|
3927
|
+
#
|
3817
3928
|
# @return [Types::DetachVolumeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3818
3929
|
#
|
3819
3930
|
# * {Types::DetachVolumeOutput#volume_arn #volume_arn} => String
|
@@ -4563,9 +4674,12 @@ module Aws::StorageGateway
|
|
4563
4674
|
# as Amazon SNS or AWS Lambda function. This operation is only supported
|
4564
4675
|
# for file gateways.
|
4565
4676
|
#
|
4566
|
-
# For more information, see Getting
|
4567
|
-
# Storage Gateway User Guide
|
4568
|
-
#
|
4677
|
+
# For more information, see [Getting file upload notification][1] in the
|
4678
|
+
# *AWS Storage Gateway User Guide*.
|
4679
|
+
#
|
4680
|
+
#
|
4681
|
+
#
|
4682
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification
|
4569
4683
|
#
|
4570
4684
|
# @option params [required, String] :file_share_arn
|
4571
4685
|
# The Amazon Resource Name (ARN) of the file share.
|
@@ -4596,12 +4710,13 @@ module Aws::StorageGateway
|
|
4596
4710
|
end
|
4597
4711
|
|
4598
4712
|
# Refreshes the cache for the specified file share. This operation finds
|
4599
|
-
# objects in the Amazon S3 bucket that were added, removed or replaced
|
4713
|
+
# objects in the Amazon S3 bucket that were added, removed, or replaced
|
4600
4714
|
# since the gateway last listed the bucket's contents and cached the
|
4601
4715
|
# results. This operation is only supported in the file gateway type.
|
4602
4716
|
# You can subscribe to be notified through an Amazon CloudWatch event
|
4603
4717
|
# when your RefreshCache operation completes. For more information, see
|
4604
|
-
# [Getting
|
4718
|
+
# [Getting notified about file operations][1] in the *AWS Storage
|
4719
|
+
# Gateway User Guide*.
|
4605
4720
|
#
|
4606
4721
|
# When this API is called, it only initiates the refresh operation. When
|
4607
4722
|
# the API call completes and returns a success code, it doesn't
|
@@ -4614,16 +4729,16 @@ module Aws::StorageGateway
|
|
4614
4729
|
# Throttle limit: This API is asynchronous so the gateway will accept no
|
4615
4730
|
# more than two refreshes at any time. We recommend using the
|
4616
4731
|
# refresh-complete CloudWatch event notification before issuing
|
4617
|
-
# additional requests. For more information, see [Getting
|
4618
|
-
#
|
4732
|
+
# additional requests. For more information, see [Getting notified about
|
4733
|
+
# file operations][1] in the *AWS Storage Gateway User Guide*.
|
4619
4734
|
#
|
4620
4735
|
# If you invoke the RefreshCache API when two requests are already being
|
4621
4736
|
# processed, any new request will cause an
|
4622
4737
|
# `InvalidGatewayRequestException` error because too many requests were
|
4623
4738
|
# sent to the server.
|
4624
4739
|
#
|
4625
|
-
# For more information, see
|
4626
|
-
#
|
4740
|
+
# For more information, see [Getting notified about file operations][1]
|
4741
|
+
# in the *AWS Storage Gateway User Guide*.
|
4627
4742
|
#
|
4628
4743
|
#
|
4629
4744
|
#
|
@@ -4636,18 +4751,19 @@ module Aws::StorageGateway
|
|
4636
4751
|
# A comma-separated list of the paths of folders to refresh in the
|
4637
4752
|
# cache. The default is \[`"/"`\]. The default refreshes objects and
|
4638
4753
|
# folders at the root of the Amazon S3 bucket. If `Recursive` is set to
|
4639
|
-
#
|
4754
|
+
# `true`, the entire S3 bucket that the file share has access to is
|
4640
4755
|
# refreshed.
|
4641
4756
|
#
|
4642
4757
|
# @option params [Boolean] :recursive
|
4643
4758
|
# A value that specifies whether to recursively refresh folders in the
|
4644
4759
|
# cache. The refresh includes folders that were in the cache the last
|
4645
4760
|
# time the gateway listed the folder's contents. If this value set to
|
4646
|
-
#
|
4761
|
+
# `true`, each folder that is listed in `FolderList` is recursively
|
4647
4762
|
# updated. Otherwise, subfolders listed in `FolderList` are not
|
4648
4763
|
# refreshed. Only objects that are in folders listed directly under
|
4649
|
-
# `FolderList` are found and used for the update. The default is
|
4650
|
-
#
|
4764
|
+
# `FolderList` are found and used for the update. The default is `true`.
|
4765
|
+
#
|
4766
|
+
# Valid Values: `true` \| `false`
|
4651
4767
|
#
|
4652
4768
|
# @return [Types::RefreshCacheOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4653
4769
|
#
|
@@ -4973,7 +5089,7 @@ module Aws::StorageGateway
|
|
4973
5089
|
# is associated with.
|
4974
5090
|
#
|
4975
5091
|
# @option params [required, String] :password
|
4976
|
-
# The password that you want to set for your SMB
|
5092
|
+
# The password that you want to set for your SMB server.
|
4977
5093
|
#
|
4978
5094
|
# @return [Types::SetSMBGuestPasswordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4979
5095
|
#
|
@@ -5012,7 +5128,7 @@ module Aws::StorageGateway
|
|
5012
5128
|
# </note>
|
5013
5129
|
#
|
5014
5130
|
# After the gateway is shutdown, you cannot call any other API except
|
5015
|
-
# StartGateway, DescribeGatewayInformation and ListGateways. For more
|
5131
|
+
# StartGateway, DescribeGatewayInformation, and ListGateways. For more
|
5016
5132
|
# information, see ActivateGateway. Your applications cannot read from
|
5017
5133
|
# or write to the gateway's storage volumes, and there are no snapshots
|
5018
5134
|
# taken.
|
@@ -5224,7 +5340,7 @@ module Aws::StorageGateway
|
|
5224
5340
|
# the upload and download bandwidth rate limit or specify only one of
|
5225
5341
|
# the two. If you don't set a bandwidth rate limit, the existing rate
|
5226
5342
|
# limit remains. This operation is supported for the stored volume,
|
5227
|
-
# cached volume and tape gateway types.
|
5343
|
+
# cached volume, and tape gateway types.
|
5228
5344
|
#
|
5229
5345
|
# By default, a gateway's bandwidth rate limits are not set. If you
|
5230
5346
|
# don't set any limit, the gateway does not have any limitations on its
|
@@ -5393,7 +5509,7 @@ module Aws::StorageGateway
|
|
5393
5509
|
# The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
|
5394
5510
|
# you want to use to monitor and log events in the gateway.
|
5395
5511
|
#
|
5396
|
-
# For more information, see [What
|
5512
|
+
# For more information, see [What is Amazon CloudWatch logs?][1].
|
5397
5513
|
#
|
5398
5514
|
#
|
5399
5515
|
#
|
@@ -5458,8 +5574,8 @@ module Aws::StorageGateway
|
|
5458
5574
|
# minimize the chance of any disruption to your applications by
|
5459
5575
|
# increasing your iSCSI Initiators' timeouts. For more information
|
5460
5576
|
# about increasing iSCSI Initiator timeouts for Windows and Linux, see
|
5461
|
-
# [Customizing
|
5462
|
-
# Linux iSCSI
|
5577
|
+
# [Customizing your Windows iSCSI settings][1] and [Customizing your
|
5578
|
+
# Linux iSCSI settings][2], respectively.
|
5463
5579
|
#
|
5464
5580
|
#
|
5465
5581
|
#
|
@@ -5537,10 +5653,6 @@ module Aws::StorageGateway
|
|
5537
5653
|
# represented as an ordinal number from 1 to 28, where 1 represents the
|
5538
5654
|
# first day of the month and 28 represents the last day of the month.
|
5539
5655
|
#
|
5540
|
-
# <note markdown="1"> This value is only available for tape and volume gateways.
|
5541
|
-
#
|
5542
|
-
# </note>
|
5543
|
-
#
|
5544
5656
|
# @return [Types::UpdateMaintenanceStartTimeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5545
5657
|
#
|
5546
5658
|
# * {Types::UpdateMaintenanceStartTimeOutput#gateway_arn #gateway_arn} => String
|
@@ -5615,56 +5727,67 @@ module Aws::StorageGateway
|
|
5615
5727
|
# The Amazon Resource Name (ARN) of the file share to be updated.
|
5616
5728
|
#
|
5617
5729
|
# @option params [Boolean] :kms_encrypted
|
5618
|
-
#
|
5619
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
5730
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
5731
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
5732
|
+
#
|
5733
|
+
# Valid Values: `true` \| `false`
|
5620
5734
|
#
|
5621
5735
|
# @option params [String] :kms_key
|
5622
|
-
# The Amazon Resource Name (ARN) of
|
5623
|
-
# server-side encryption.
|
5624
|
-
#
|
5736
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
5737
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
5738
|
+
# not support asymmetric CMKs. This value can only be set when
|
5739
|
+
# `KMSEncrypted` is `true`. Optional.
|
5625
5740
|
#
|
5626
5741
|
# @option params [Types::NFSFileShareDefaults] :nfs_file_share_defaults
|
5627
5742
|
# The default values for the file share. Optional.
|
5628
5743
|
#
|
5629
5744
|
# @option params [String] :default_storage_class
|
5630
5745
|
# The default storage class for objects put into an Amazon S3 bucket by
|
5631
|
-
# the file gateway.
|
5632
|
-
#
|
5633
|
-
#
|
5746
|
+
# the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
5747
|
+
# Optional.
|
5748
|
+
#
|
5749
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
5750
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
5634
5751
|
#
|
5635
5752
|
# @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
|
5753
|
+
# A value that sets the access control list (ACL) permission for objects
|
5754
|
+
# in the S3 bucket that a file gateway puts objects into. The default
|
5755
|
+
# value is `private`.
|
5639
5756
|
#
|
5640
5757
|
# @option params [Array<String>] :client_list
|
5641
5758
|
# The list of clients that are allowed to access the file gateway. The
|
5642
5759
|
# list must contain either valid IP addresses or valid CIDR blocks.
|
5643
5760
|
#
|
5644
5761
|
# @option params [String] :squash
|
5645
|
-
# The user mapped to anonymous user.
|
5762
|
+
# The user mapped to anonymous user.
|
5763
|
+
#
|
5764
|
+
# Valid values are the following:
|
5646
5765
|
#
|
5647
|
-
# * `RootSquash
|
5766
|
+
# * `RootSquash`\: Only root is mapped to anonymous user.
|
5648
5767
|
#
|
5649
|
-
# * `NoSquash
|
5768
|
+
# * `NoSquash`\: No one is mapped to anonymous user.
|
5650
5769
|
#
|
5651
|
-
# * `AllSquash
|
5770
|
+
# * `AllSquash`\: Everyone is mapped to anonymous user.
|
5652
5771
|
#
|
5653
5772
|
# @option params [Boolean] :read_only
|
5654
|
-
# A value that sets the write status of a file share.
|
5655
|
-
#
|
5773
|
+
# A value that sets the write status of a file share. Set this value to
|
5774
|
+
# `true` to set the write status to read-only, otherwise set to `false`.
|
5775
|
+
#
|
5776
|
+
# Valid Values: `true` \| `false`
|
5656
5777
|
#
|
5657
5778
|
# @option params [Boolean] :guess_mime_type_enabled
|
5658
5779
|
# 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,
|
5780
|
+
# based on file extensions. Set this value to `true` to enable MIME type
|
5781
|
+
# guessing, otherwise set to `false`. The default value is `true`.
|
5782
|
+
#
|
5783
|
+
# Valid Values: `true` \| `false`
|
5661
5784
|
#
|
5662
5785
|
# @option params [Boolean] :requester_pays
|
5663
5786
|
# A value that sets who pays the cost of the request and the cost
|
5664
5787
|
# 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.
|
5788
|
+
# to `true`, the requester pays the costs; otherwise, the S3 bucket
|
5789
|
+
# owner pays. However, the S3 bucket owner always pays the cost of
|
5790
|
+
# storing data.
|
5668
5791
|
#
|
5669
5792
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
5670
5793
|
# file share, so make sure that the configuration on the file share is
|
@@ -5672,6 +5795,19 @@ module Aws::StorageGateway
|
|
5672
5795
|
#
|
5673
5796
|
# </note>
|
5674
5797
|
#
|
5798
|
+
# Valid Values: `true` \| `false`
|
5799
|
+
#
|
5800
|
+
# @option params [String] :file_share_name
|
5801
|
+
# The name of the file share. Optional.
|
5802
|
+
#
|
5803
|
+
# <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
|
5804
|
+
# `LocationARN`.
|
5805
|
+
#
|
5806
|
+
# </note>
|
5807
|
+
#
|
5808
|
+
# @option params [Types::CacheAttributes] :cache_attributes
|
5809
|
+
# Refresh cache information.
|
5810
|
+
#
|
5675
5811
|
# @return [Types::UpdateNFSFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5676
5812
|
#
|
5677
5813
|
# * {Types::UpdateNFSFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -5695,6 +5831,10 @@ module Aws::StorageGateway
|
|
5695
5831
|
# read_only: false,
|
5696
5832
|
# guess_mime_type_enabled: false,
|
5697
5833
|
# requester_pays: false,
|
5834
|
+
# file_share_name: "FileShareName",
|
5835
|
+
# cache_attributes: {
|
5836
|
+
# cache_stale_timeout_in_seconds: 1,
|
5837
|
+
# },
|
5698
5838
|
# })
|
5699
5839
|
#
|
5700
5840
|
# @example Response structure
|
@@ -5722,8 +5862,8 @@ module Aws::StorageGateway
|
|
5722
5862
|
# is activated in the AWS Region you are creating your file gateway in.
|
5723
5863
|
# If AWS STS is not activated in this AWS Region, activate it. For
|
5724
5864
|
# information about how to activate AWS STS, see [Activating and
|
5725
|
-
#
|
5726
|
-
# Access Management User Guide
|
5865
|
+
# deactivating AWS STS in an AWS Region][1] in the *AWS Identity and
|
5866
|
+
# Access Management User Guide*.
|
5727
5867
|
#
|
5728
5868
|
# File gateways don't support creating hard or symbolic links on a
|
5729
5869
|
# file
|
@@ -5738,40 +5878,49 @@ module Aws::StorageGateway
|
|
5738
5878
|
# update.
|
5739
5879
|
#
|
5740
5880
|
# @option params [Boolean] :kms_encrypted
|
5741
|
-
#
|
5742
|
-
# key, or false to use a key managed by Amazon S3. Optional.
|
5881
|
+
# Set to `true` to use Amazon S3 server-side encryption with your own
|
5882
|
+
# AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
|
5883
|
+
#
|
5884
|
+
# Valid Values: `true` \| `false`
|
5743
5885
|
#
|
5744
5886
|
# @option params [String] :kms_key
|
5745
|
-
# The Amazon Resource Name (ARN) of
|
5746
|
-
# server-side encryption.
|
5747
|
-
#
|
5887
|
+
# The Amazon Resource Name (ARN) of a symmetric customer master key
|
5888
|
+
# (CMK) used for Amazon S3 server-side encryption. Storage Gateway does
|
5889
|
+
# not support asymmetric CMKs. This value can only be set when
|
5890
|
+
# `KMSEncrypted` is `true`. Optional.
|
5748
5891
|
#
|
5749
5892
|
# @option params [String] :default_storage_class
|
5750
5893
|
# The default storage class for objects put into an Amazon S3 bucket by
|
5751
|
-
# the file gateway.
|
5752
|
-
#
|
5753
|
-
#
|
5894
|
+
# the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
|
5895
|
+
# Optional.
|
5896
|
+
#
|
5897
|
+
# Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
|
5898
|
+
# `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
|
5754
5899
|
#
|
5755
5900
|
# @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
|
5901
|
+
# A value that sets the access control list (ACL) permission for objects
|
5902
|
+
# in the S3 bucket that a file gateway puts objects into. The default
|
5903
|
+
# value is `private`.
|
5759
5904
|
#
|
5760
5905
|
# @option params [Boolean] :read_only
|
5761
|
-
# A value that sets the write status of a file share.
|
5762
|
-
#
|
5906
|
+
# A value that sets the write status of a file share. Set this value to
|
5907
|
+
# `true` to set write status to read-only, otherwise set to `false`.
|
5908
|
+
#
|
5909
|
+
# Valid Values: `true` \| `false`
|
5763
5910
|
#
|
5764
5911
|
# @option params [Boolean] :guess_mime_type_enabled
|
5765
5912
|
# 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,
|
5913
|
+
# based on file extensions. Set this value to `true` to enable MIME type
|
5914
|
+
# guessing, otherwise set to `false`. The default value is `true`.
|
5915
|
+
#
|
5916
|
+
# Valid Values: `true` \| `false`
|
5768
5917
|
#
|
5769
5918
|
# @option params [Boolean] :requester_pays
|
5770
5919
|
# A value that sets who pays the cost of the request and the cost
|
5771
5920
|
# 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.
|
5921
|
+
# to `true`, the requester pays the costs; otherwise, the S3 bucket
|
5922
|
+
# owner pays. However, the S3 bucket owner always pays the cost of
|
5923
|
+
# storing data.
|
5775
5924
|
#
|
5776
5925
|
# <note markdown="1"> `RequesterPays` is a configuration for the S3 bucket that backs the
|
5777
5926
|
# file share, so make sure that the configuration on the file share is
|
@@ -5779,36 +5928,64 @@ module Aws::StorageGateway
|
|
5779
5928
|
#
|
5780
5929
|
# </note>
|
5781
5930
|
#
|
5931
|
+
# Valid Values: `true` \| `false`
|
5932
|
+
#
|
5782
5933
|
# @option params [Boolean] :smbacl_enabled
|
5783
|
-
# Set this value to
|
5784
|
-
# SMB file share. Set it to
|
5934
|
+
# Set this value to `true` to enable access control list (ACL) on the
|
5935
|
+
# SMB file share. Set it to `false` to map file and directory
|
5785
5936
|
# permissions to the POSIX permissions.
|
5786
5937
|
#
|
5787
|
-
# For more information, see
|
5788
|
-
#
|
5789
|
-
#
|
5938
|
+
# For more information, see [Using Microsoft Windows ACLs to control
|
5939
|
+
# access to an SMB file share][1] in the *AWS Storage Gateway User
|
5940
|
+
# Guide*.
|
5941
|
+
#
|
5942
|
+
# Valid Values: `true` \| `false`
|
5943
|
+
#
|
5944
|
+
#
|
5945
|
+
#
|
5946
|
+
# [1]: https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
|
5790
5947
|
#
|
5791
5948
|
# @option params [Array<String>] :admin_user_list
|
5792
|
-
# A list of users in the Active Directory that have
|
5793
|
-
# to the file share. A group must be prefixed with
|
5794
|
-
#
|
5795
|
-
#
|
5949
|
+
# A list of users or groups in the Active Directory that have
|
5950
|
+
# administrator rights to the file share. A group must be prefixed with
|
5951
|
+
# the @ character. Acceptable formats include: `DOMAIN\User1`, `user1`,
|
5952
|
+
# `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
|
5953
|
+
# set to `ActiveDirectory`.
|
5796
5954
|
#
|
5797
5955
|
# @option params [Array<String>] :valid_user_list
|
5798
5956
|
# A list of users or groups in the Active Directory that are allowed to
|
5799
5957
|
# access the file share. A group must be prefixed with the @ character.
|
5800
|
-
#
|
5958
|
+
# Acceptable formats include: `DOMAIN\User1`, `user1`, `@group1`, and
|
5959
|
+
# `@DOMAIN\group1`. Can only be set if Authentication is set to
|
5801
5960
|
# `ActiveDirectory`.
|
5802
5961
|
#
|
5803
5962
|
# @option params [Array<String>] :invalid_user_list
|
5804
5963
|
# A list of users or groups in the Active Directory that are not allowed
|
5805
5964
|
# to access the file share. A group must be prefixed with the @
|
5806
|
-
# character.
|
5965
|
+
# character. Acceptable formats include: `DOMAIN\User1`, `user1`,
|
5966
|
+
# `@group1`, and `@DOMAIN\group1`. Can only be set if Authentication is
|
5807
5967
|
# set to `ActiveDirectory`.
|
5808
5968
|
#
|
5809
5969
|
# @option params [String] :audit_destination_arn
|
5810
5970
|
# The Amazon Resource Name (ARN) of the storage used for the audit logs.
|
5811
5971
|
#
|
5972
|
+
# @option params [String] :case_sensitivity
|
5973
|
+
# The case of an object name in an Amazon S3 bucket. For
|
5974
|
+
# `ClientSpecified`, the client determines the case sensitivity. For
|
5975
|
+
# `CaseSensitive`, the gateway determines the case sensitivity. The
|
5976
|
+
# default value is `ClientSpecified`.
|
5977
|
+
#
|
5978
|
+
# @option params [String] :file_share_name
|
5979
|
+
# The name of the file share. Optional.
|
5980
|
+
#
|
5981
|
+
# <note markdown="1"> `FileShareName` must be set if an S3 prefix name is set in
|
5982
|
+
# `LocationARN`.
|
5983
|
+
#
|
5984
|
+
# </note>
|
5985
|
+
#
|
5986
|
+
# @option params [Types::CacheAttributes] :cache_attributes
|
5987
|
+
# Refresh cache information.
|
5988
|
+
#
|
5812
5989
|
# @return [Types::UpdateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5813
5990
|
#
|
5814
5991
|
# * {Types::UpdateSMBFileShareOutput#file_share_arn #file_share_arn} => String
|
@@ -5829,6 +6006,11 @@ module Aws::StorageGateway
|
|
5829
6006
|
# valid_user_list: ["FileShareUser"],
|
5830
6007
|
# invalid_user_list: ["FileShareUser"],
|
5831
6008
|
# audit_destination_arn: "AuditDestinationARN",
|
6009
|
+
# case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
|
6010
|
+
# file_share_name: "FileShareName",
|
6011
|
+
# cache_attributes: {
|
6012
|
+
# cache_stale_timeout_in_seconds: 1,
|
6013
|
+
# },
|
5832
6014
|
# })
|
5833
6015
|
#
|
5834
6016
|
# @example Response structure
|
@@ -6003,7 +6185,7 @@ module Aws::StorageGateway
|
|
6003
6185
|
# @option params [required, String] :device_type
|
6004
6186
|
# The type of medium changer you want to select.
|
6005
6187
|
#
|
6006
|
-
# Valid Values:
|
6188
|
+
# Valid Values: `STK-L700` \| `AWS-Gateway-VTL`
|
6007
6189
|
#
|
6008
6190
|
# @return [Types::UpdateVTLDeviceTypeOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6009
6191
|
#
|
@@ -6057,7 +6239,7 @@ module Aws::StorageGateway
|
|
6057
6239
|
params: params,
|
6058
6240
|
config: config)
|
6059
6241
|
context[:gem_name] = 'aws-sdk-storagegateway'
|
6060
|
-
context[:gem_version] = '1.
|
6242
|
+
context[:gem_version] = '1.45.0'
|
6061
6243
|
Seahorse::Client::Request.new(handlers, context)
|
6062
6244
|
end
|
6063
6245
|
|