aws-sdk-storagegateway 1.53.0 → 1.57.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.
Files changed (12) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +368 -0
  3. data/LICENSE.txt +202 -0
  4. data/VERSION +1 -0
  5. data/lib/aws-sdk-storagegateway.rb +2 -2
  6. data/lib/aws-sdk-storagegateway/client.rb +687 -259
  7. data/lib/aws-sdk-storagegateway/client_api.rb +184 -13
  8. data/lib/aws-sdk-storagegateway/customizations.rb +1 -1
  9. data/lib/aws-sdk-storagegateway/errors.rb +1 -1
  10. data/lib/aws-sdk-storagegateway/resource.rb +1 -1
  11. data/lib/aws-sdk-storagegateway/types.rb +983 -322
  12. metadata +11 -9
data/lib/aws-sdk-storagegateway/errors.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
data/lib/aws-sdk-storagegateway/resource.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
data/lib/aws-sdk-storagegateway/types.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -55,8 +55,8 @@ module Aws::StorageGateway
55
55
  # the arguments you pass to the `ActivateGateway` API call determine
56
56
  # the actual configuration of your gateway.
57
57
  #
58
- # For more information, see [Getting activation key][1] in the *AWS
59
- # Storage Gateway User Guide*.
58
+ # For more information, see [Getting activation key][1] in the
59
+ # *Storage Gateway User Guide*.
60
60
  #
61
61
  #
62
62
  #
@@ -77,15 +77,15 @@ module Aws::StorageGateway
77
77
  # @return [String]
78
78
  #
79
79
  # @!attribute [rw] gateway_region
80
- # A value that indicates the AWS Region where you want to store your
81
- # data. The gateway AWS Region specified must be the same AWS Region
82
- # as the AWS Region in your `Host` header in the request. For more
83
- # information about available AWS Regions and endpoints for AWS
84
- # Storage Gateway, see [AWS Storage Gateway endpoints and quotas][1]
85
- # in the *AWS General Reference*.
80
+ # A value that indicates the Region where you want to store your data.
81
+ # The gateway Region specified must be the same Region as the Region
82
+ # in your `Host` header in the request. For more information about
83
+ # available Regions and endpoints for Storage Gateway, see [ Storage
84
+ # Gateway endpoints and quotas][1] in the *Amazon Web Services General
85
+ # Reference*.
86
86
  #
87
- # Valid Values: See [AWS Storage Gateway endpoints and quotas][1] in
88
- # the *AWS General Reference*.
87
+ # Valid Values: See [ Storage Gateway endpoints and quotas][1] in the
88
+ # *Amazon Web Services General Reference*.
89
89
  #
90
90
  #
91
91
  #
@@ -97,7 +97,8 @@ module Aws::StorageGateway
97
97
  # specified is critical to all later functions of the gateway and
98
98
  # cannot be changed after activation. The default value is `CACHED`.
99
99
  #
100
- # Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3`
100
+ # Valid Values: `STORED` \| `CACHED` \| `VTL` \| `FILE_S3` \|
101
+ # `FILE_FSX_SMB|`
101
102
  # @return [String]
102
103
  #
103
104
  # @!attribute [rw] tape_drive_type
@@ -142,10 +143,10 @@ module Aws::StorageGateway
142
143
  include Aws::Structure
143
144
  end
144
145
 
145
- # AWS Storage Gateway returns the Amazon Resource Name (ARN) of the
146
+ # Storage Gateway returns the Amazon Resource Name (ARN) of the
146
147
  # activated gateway. It is a string made of information such as your
147
- # account, gateway name, and AWS Region. This ARN is used to reference
148
- # the gateway in other API operations as well as resource-based
148
+ # account, gateway name, and Region. This ARN is used to reference the
149
+ # gateway in other API operations as well as resource-based
149
150
  # authorization.
150
151
  #
151
152
  # <note markdown="1"> For gateways activated prior to September 02, 2015, the gateway ARN
@@ -156,8 +157,7 @@ module Aws::StorageGateway
156
157
  #
157
158
  # @!attribute [rw] gateway_arn
158
159
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
159
- # operation to return a list of gateways for your account and AWS
160
- # Region.
160
+ # operation to return a list of gateways for your account and Region.
161
161
  # @return [String]
162
162
  #
163
163
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ActivateGatewayOutput AWS API Documentation
@@ -178,8 +178,7 @@ module Aws::StorageGateway
178
178
  #
179
179
  # @!attribute [rw] gateway_arn
180
180
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
181
- # operation to return a list of gateways for your account and AWS
182
- # Region.
181
+ # operation to return a list of gateways for your account and Region.
183
182
  # @return [String]
184
183
  #
185
184
  # @!attribute [rw] disk_ids
@@ -199,8 +198,7 @@ module Aws::StorageGateway
199
198
 
200
199
  # @!attribute [rw] gateway_arn
201
200
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
202
- # operation to return a list of gateways for your account and AWS
203
- # Region.
201
+ # operation to return a list of gateways for your account and Region.
204
202
  # @return [String]
205
203
  #
206
204
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddCacheOutput AWS API Documentation
@@ -277,8 +275,7 @@ module Aws::StorageGateway
277
275
  #
278
276
  # @!attribute [rw] gateway_arn
279
277
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
280
- # operation to return a list of gateways for your account and AWS
281
- # Region.
278
+ # operation to return a list of gateways for your account and Region.
282
279
  # @return [String]
283
280
  #
284
281
  # @!attribute [rw] disk_ids
@@ -298,8 +295,7 @@ module Aws::StorageGateway
298
295
 
299
296
  # @!attribute [rw] gateway_arn
300
297
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
301
- # operation to return a list of gateways for your account and AWS
302
- # Region.
298
+ # operation to return a list of gateways for your account and Region.
303
299
  # @return [String]
304
300
  #
305
301
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddUploadBufferOutput AWS API Documentation
@@ -326,8 +322,7 @@ module Aws::StorageGateway
326
322
  #
327
323
  # @!attribute [rw] gateway_arn
328
324
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
329
- # operation to return a list of gateways for your account and AWS
330
- # Region.
325
+ # operation to return a list of gateways for your account and Region.
331
326
  # @return [String]
332
327
  #
333
328
  # @!attribute [rw] disk_ids
@@ -350,8 +345,7 @@ module Aws::StorageGateway
350
345
  #
351
346
  # @!attribute [rw] gateway_arn
352
347
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
353
- # operation to return a list of gateways for your account and AWS
354
- # Region.
348
+ # operation to return a list of gateways for your account and Region.
355
349
  # @return [String]
356
350
  #
357
351
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AddWorkingStorageOutput AWS API Documentation
@@ -421,6 +415,108 @@ module Aws::StorageGateway
421
415
  include Aws::Structure
422
416
  end
423
417
 
418
+ # @note When making an API call, you may pass AssociateFileSystemInput
419
+ # data as a hash:
420
+ #
421
+ # {
422
+ # user_name: "DomainUserName", # required
423
+ # password: "DomainUserPassword", # required
424
+ # client_token: "ClientToken", # required
425
+ # gateway_arn: "GatewayARN", # required
426
+ # location_arn: "FileSystemLocationARN", # required
427
+ # tags: [
428
+ # {
429
+ # key: "TagKey", # required
430
+ # value: "TagValue", # required
431
+ # },
432
+ # ],
433
+ # audit_destination_arn: "AuditDestinationARN",
434
+ # cache_attributes: {
435
+ # cache_stale_timeout_in_seconds: 1,
436
+ # },
437
+ # endpoint_network_configuration: {
438
+ # ip_addresses: ["IPV4Address"],
439
+ # },
440
+ # }
441
+ #
442
+ # @!attribute [rw] user_name
443
+ # The user name of the user credential that has permission to access
444
+ # the root share D$ of the Amazon FSx file system. The user account
445
+ # must belong to the Amazon FSx delegated admin user group.
446
+ # @return [String]
447
+ #
448
+ # @!attribute [rw] password
449
+ # The password of the user credential.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] client_token
453
+ # A unique string value that you supply that is used by the FSx File
454
+ # Gateway to ensure idempotent file system association creation.
455
+ # @return [String]
456
+ #
457
+ # @!attribute [rw] gateway_arn
458
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
459
+ # operation to return a list of gateways for your account and Region.
460
+ # @return [String]
461
+ #
462
+ # @!attribute [rw] location_arn
463
+ # The Amazon Resource Name (ARN) of the Amazon FSx file system to
464
+ # associate with the FSx File Gateway.
465
+ # @return [String]
466
+ #
467
+ # @!attribute [rw] tags
468
+ # A list of up to 50 tags that can be assigned to the file system
469
+ # association. Each tag is a key-value pair.
470
+ # @return [Array<Types::Tag>]
471
+ #
472
+ # @!attribute [rw] audit_destination_arn
473
+ # The Amazon Resource Name (ARN) of the storage used for the audit
474
+ # logs.
475
+ # @return [String]
476
+ #
477
+ # @!attribute [rw] cache_attributes
478
+ # The refresh cache information for the file share or FSx file
479
+ # systems.
480
+ # @return [Types::CacheAttributes]
481
+ #
482
+ # @!attribute [rw] endpoint_network_configuration
483
+ # Specifies the network configuration information for the gateway
484
+ # associated with the Amazon FSx file system.
485
+ #
486
+ # <note markdown="1"> If multiple file systems are associated with this gateway, this
487
+ # parameter's `IpAddresses` field is required.
488
+ #
489
+ # </note>
490
+ # @return [Types::EndpointNetworkConfiguration]
491
+ #
492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssociateFileSystemInput AWS API Documentation
493
+ #
494
+ class AssociateFileSystemInput < Struct.new(
495
+ :user_name,
496
+ :password,
497
+ :client_token,
498
+ :gateway_arn,
499
+ :location_arn,
500
+ :tags,
501
+ :audit_destination_arn,
502
+ :cache_attributes,
503
+ :endpoint_network_configuration)
504
+ SENSITIVE = [:password]
505
+ include Aws::Structure
506
+ end
507
+
508
+ # @!attribute [rw] file_system_association_arn
509
+ # The ARN of the newly created file system association.
510
+ # @return [String]
511
+ #
512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssociateFileSystemOutput AWS API Documentation
513
+ #
514
+ class AssociateFileSystemOutput < Struct.new(
515
+ :file_system_association_arn)
516
+ SENSITIVE = []
517
+ include Aws::Structure
518
+ end
519
+
424
520
  # AttachVolumeInput
425
521
  #
426
522
  # @note When making an API call, you may pass AttachVolumeInput
@@ -516,8 +612,7 @@ module Aws::StorageGateway
516
612
  #
517
613
  # @!attribute [rw] gateway_arn
518
614
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
519
- # operation to return a list of gateways for your account and AWS
520
- # Region.
615
+ # operation to return a list of gateways for your account and Region.
521
616
  # @return [String]
522
617
  #
523
618
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AutomaticTapeCreationPolicyInfo AWS API Documentation
@@ -648,7 +743,7 @@ module Aws::StorageGateway
648
743
  # @!attribute [rw] days_of_week
649
744
  # The days of the week component of the bandwidth rate limit interval,
650
745
  # represented as ordinal numbers from 0 to 6, where 0 represents
651
- # Sunday and 6 Saturday.
746
+ # Sunday and 6 represents Saturday.
652
747
  # @return [Array<Integer>]
653
748
  #
654
749
  # @!attribute [rw] average_upload_rate_limit_in_bits_per_sec
@@ -677,7 +772,7 @@ module Aws::StorageGateway
677
772
  include Aws::Structure
678
773
  end
679
774
 
680
- # Lists refresh cache information.
775
+ # The refresh cache information for the file share or FSx file systems.
681
776
  #
682
777
  # @note When making an API call, you may pass CacheAttributes
683
778
  # data as a hash:
@@ -690,10 +785,10 @@ module Aws::StorageGateway
690
785
  # Refreshes a file share's cache by using Time To Live (TTL). TTL is
691
786
  # the length of time since the last refresh after which access to the
692
787
  # directory would cause the file gateway to first refresh that
693
- # directory's contents from the Amazon S3 bucket. The TTL duration is
694
- # in seconds.
788
+ # directory's contents from the Amazon S3 bucket or Amazon FSx file
789
+ # system. The TTL duration is in seconds.
695
790
  #
696
- # Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
791
+ # Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
697
792
  # @return [Integer]
698
793
  #
699
794
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CacheAttributes AWS API Documentation
@@ -826,8 +921,7 @@ module Aws::StorageGateway
826
921
  #
827
922
  # @!attribute [rw] gateway_arn
828
923
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
829
- # operation to return a list of gateways for your account and AWS
830
- # Region.
924
+ # operation to return a list of gateways for your account and Region.
831
925
  # @return [String]
832
926
  #
833
927
  # @!attribute [rw] tape_arn
@@ -871,8 +965,7 @@ module Aws::StorageGateway
871
965
  #
872
966
  # @!attribute [rw] gateway_arn
873
967
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
874
- # operation to return a list of gateways for your account and AWS
875
- # Region.
968
+ # operation to return a list of gateways for your account and Region.
876
969
  # @return [String]
877
970
  #
878
971
  # @!attribute [rw] tape_arn
@@ -963,8 +1056,7 @@ module Aws::StorageGateway
963
1056
  #
964
1057
  # @!attribute [rw] gateway_arn
965
1058
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
966
- # operation to return a list of gateways for your account and AWS
967
- # Region.
1059
+ # operation to return a list of gateways for your account and Region.
968
1060
  # @return [String]
969
1061
  #
970
1062
  # @!attribute [rw] volume_size_in_bytes
@@ -1020,7 +1112,7 @@ module Aws::StorageGateway
1020
1112
  #
1021
1113
  # @!attribute [rw] kms_encrypted
1022
1114
  # Set to `true` to use Amazon S3 server-side encryption with your own
1023
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1115
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1024
1116
  #
1025
1117
  # Valid Values: `true` \| `false`
1026
1118
  # @return [Boolean]
@@ -1116,11 +1208,13 @@ module Aws::StorageGateway
1116
1208
  # cache_stale_timeout_in_seconds: 1,
1117
1209
  # },
1118
1210
  # notification_policy: "NotificationPolicy",
1211
+ # vpc_endpoint_dns_name: "DNSHostName",
1212
+ # bucket_region: "RegionId",
1119
1213
  # }
1120
1214
  #
1121
1215
  # @!attribute [rw] client_token
1122
- # A unique string value that you supply that is used by file gateway
1123
- # to ensure idempotent file share creation.
1216
+ # A unique string value that you supply that is used by S3 File
1217
+ # Gateway to ensure idempotent file share creation.
1124
1218
  # @return [String]
1125
1219
  #
1126
1220
  # @!attribute [rw] nfs_file_share_defaults
@@ -1128,13 +1222,13 @@ module Aws::StorageGateway
1128
1222
  # @return [Types::NFSFileShareDefaults]
1129
1223
  #
1130
1224
  # @!attribute [rw] gateway_arn
1131
- # The Amazon Resource Name (ARN) of the file gateway on which you want
1132
- # to create a file share.
1225
+ # The Amazon Resource Name (ARN) of the S3 File Gateway on which you
1226
+ # want to create a file share.
1133
1227
  # @return [String]
1134
1228
  #
1135
1229
  # @!attribute [rw] kms_encrypted
1136
1230
  # Set to `true` to use Amazon S3 server-side encryption with your own
1137
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1231
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1138
1232
  #
1139
1233
  # Valid Values: `true` \| `false`
1140
1234
  # @return [Boolean]
@@ -1147,19 +1241,35 @@ module Aws::StorageGateway
1147
1241
  # @return [String]
1148
1242
  #
1149
1243
  # @!attribute [rw] role
1150
- # The ARN of the AWS Identity and Access Management (IAM) role that a
1151
- # file gateway assumes when it accesses the underlying storage.
1244
+ # The ARN of the Identity and Access Management (IAM) role that an S3
1245
+ # File Gateway assumes when it accesses the underlying storage.
1152
1246
  # @return [String]
1153
1247
  #
1154
1248
  # @!attribute [rw] location_arn
1155
1249
  # The ARN of the backend storage used for storing file data. A prefix
1156
1250
  # name can be added to the S3 bucket name. It must end with a "/".
1251
+ #
1252
+ # <note markdown="1"> You can specify a bucket attached to an access point using a
1253
+ # complete ARN that includes the bucket region as shown:
1254
+ #
1255
+ # `arn:aws:s3:region:account-id:accesspoint/access-point-name `
1256
+ #
1257
+ # If you specify a bucket attached to an access point, the bucket
1258
+ # policy must be configured to delegate access control to the access
1259
+ # point. For information, see [Delegating access control to access
1260
+ # points][1] in the *Amazon S3 User Guide*.
1261
+ #
1262
+ # </note>
1263
+ #
1264
+ #
1265
+ #
1266
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control
1157
1267
  # @return [String]
1158
1268
  #
1159
1269
  # @!attribute [rw] default_storage_class
1160
1270
  # The default storage class for objects put into an Amazon S3 bucket
1161
- # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1162
- # Optional.
1271
+ # by the S3 File Gateway. The default value is
1272
+ # `S3_INTELLIGENT_TIERING`. Optional.
1163
1273
  #
1164
1274
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
1165
1275
  # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
@@ -1167,13 +1277,14 @@ module Aws::StorageGateway
1167
1277
  #
1168
1278
  # @!attribute [rw] object_acl
1169
1279
  # A value that sets the access control list (ACL) permission for
1170
- # objects in the S3 bucket that a file gateway puts objects into. The
1171
- # default value is `private`.
1280
+ # objects in the S3 bucket that a S3 File Gateway puts objects into.
1281
+ # The default value is `private`.
1172
1282
  # @return [String]
1173
1283
  #
1174
1284
  # @!attribute [rw] client_list
1175
- # The list of clients that are allowed to access the file gateway. The
1176
- # list must contain either valid IP addresses or valid CIDR blocks.
1285
+ # The list of clients that are allowed to access the S3 File Gateway.
1286
+ # The list must contain either valid IP addresses or valid CIDR
1287
+ # blocks.
1177
1288
  # @return [Array<String>]
1178
1289
  #
1179
1290
  # @!attribute [rw] squash
@@ -1243,11 +1354,53 @@ module Aws::StorageGateway
1243
1354
  # @return [String]
1244
1355
  #
1245
1356
  # @!attribute [rw] cache_attributes
1246
- # Refresh cache information.
1357
+ # Specifies refresh cache information for the file share.
1247
1358
  # @return [Types::CacheAttributes]
1248
1359
  #
1249
1360
  # @!attribute [rw] notification_policy
1250
- # The notification policy of the file share.
1361
+ # The notification policy of the file share. `SettlingTimeInSeconds`
1362
+ # controls the number of seconds to wait after the last point in time
1363
+ # a client wrote to a file before generating an `ObjectUploaded`
1364
+ # notification. Because clients can make many small writes to files,
1365
+ # it's best to set this parameter for as long as possible to avoid
1366
+ # generating multiple notifications for the same file in a small time
1367
+ # period.
1368
+ #
1369
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
1370
+ # uploading to Amazon S3, only the timing of the notification.
1371
+ #
1372
+ # </note>
1373
+ #
1374
+ # The following example sets `NotificationPolicy` on with
1375
+ # `SettlingTimeInSeconds` set to 60.
1376
+ #
1377
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
1378
+ #
1379
+ # The following example sets `NotificationPolicy` off.
1380
+ #
1381
+ # `\{\}`
1382
+ # @return [String]
1383
+ #
1384
+ # @!attribute [rw] vpc_endpoint_dns_name
1385
+ # Specifies the DNS name for the VPC endpoint that the NFS file share
1386
+ # uses to connect to Amazon S3.
1387
+ #
1388
+ # <note markdown="1"> This parameter is required for NFS file shares that connect to
1389
+ # Amazon S3 through a VPC endpoint, a VPC access point, or an access
1390
+ # point alias that points to a VPC access point.
1391
+ #
1392
+ # </note>
1393
+ # @return [String]
1394
+ #
1395
+ # @!attribute [rw] bucket_region
1396
+ # Specifies the Region of the S3 bucket where the NFS file share
1397
+ # stores files.
1398
+ #
1399
+ # <note markdown="1"> This parameter is required for NFS file shares that connect to
1400
+ # Amazon S3 through a VPC endpoint, a VPC access point, or an access
1401
+ # point alias that points to a VPC access point.
1402
+ #
1403
+ # </note>
1251
1404
  # @return [String]
1252
1405
  #
1253
1406
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateNFSFileShareInput AWS API Documentation
@@ -1270,7 +1423,9 @@ module Aws::StorageGateway
1270
1423
  :tags,
1271
1424
  :file_share_name,
1272
1425
  :cache_attributes,
1273
- :notification_policy)
1426
+ :notification_policy,
1427
+ :vpc_endpoint_dns_name,
1428
+ :bucket_region)
1274
1429
  SENSITIVE = []
1275
1430
  include Aws::Structure
1276
1431
  end
@@ -1308,9 +1463,9 @@ module Aws::StorageGateway
1308
1463
  # requester_pays: false,
1309
1464
  # smbacl_enabled: false,
1310
1465
  # access_based_enumeration: false,
1311
- # admin_user_list: ["FileShareUser"],
1312
- # valid_user_list: ["FileShareUser"],
1313
- # invalid_user_list: ["FileShareUser"],
1466
+ # admin_user_list: ["UserListUser"],
1467
+ # valid_user_list: ["UserListUser"],
1468
+ # invalid_user_list: ["UserListUser"],
1314
1469
  # audit_destination_arn: "AuditDestinationARN",
1315
1470
  # authentication: "Authentication",
1316
1471
  # case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
@@ -1325,21 +1480,24 @@ module Aws::StorageGateway
1325
1480
  # cache_stale_timeout_in_seconds: 1,
1326
1481
  # },
1327
1482
  # notification_policy: "NotificationPolicy",
1483
+ # vpc_endpoint_dns_name: "DNSHostName",
1484
+ # bucket_region: "RegionId",
1485
+ # oplocks_enabled: false,
1328
1486
  # }
1329
1487
  #
1330
1488
  # @!attribute [rw] client_token
1331
- # A unique string value that you supply that is used by file gateway
1332
- # to ensure idempotent file share creation.
1489
+ # A unique string value that you supply that is used by S3 File
1490
+ # Gateway to ensure idempotent file share creation.
1333
1491
  # @return [String]
1334
1492
  #
1335
1493
  # @!attribute [rw] gateway_arn
1336
- # The ARN of the file gateway on which you want to create a file
1494
+ # The ARN of the S3 File Gateway on which you want to create a file
1337
1495
  # share.
1338
1496
  # @return [String]
1339
1497
  #
1340
1498
  # @!attribute [rw] kms_encrypted
1341
1499
  # Set to `true` to use Amazon S3 server-side encryption with your own
1342
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
1500
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1343
1501
  #
1344
1502
  # Valid Values: `true` \| `false`
1345
1503
  # @return [Boolean]
@@ -1352,19 +1510,35 @@ module Aws::StorageGateway
1352
1510
  # @return [String]
1353
1511
  #
1354
1512
  # @!attribute [rw] role
1355
- # The ARN of the AWS Identity and Access Management (IAM) role that a
1356
- # file gateway assumes when it accesses the underlying storage.
1513
+ # The ARN of the Identity and Access Management (IAM) role that an S3
1514
+ # File Gateway assumes when it accesses the underlying storage.
1357
1515
  # @return [String]
1358
1516
  #
1359
1517
  # @!attribute [rw] location_arn
1360
1518
  # The ARN of the backend storage used for storing file data. A prefix
1361
1519
  # name can be added to the S3 bucket name. It must end with a "/".
1520
+ #
1521
+ # <note markdown="1"> You can specify a bucket attached to an access point using a
1522
+ # complete ARN that includes the bucket region as shown:
1523
+ #
1524
+ # `arn:aws:s3:region:account-id:accesspoint/access-point-name `
1525
+ #
1526
+ # If you specify a bucket attached to an access point, the bucket
1527
+ # policy must be configured to delegate access control to the access
1528
+ # point. For information, see [Delegating access control to access
1529
+ # points][1] in the *Amazon S3 User Guide*.
1530
+ #
1531
+ # </note>
1532
+ #
1533
+ #
1534
+ #
1535
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html#access-points-delegating-control
1362
1536
  # @return [String]
1363
1537
  #
1364
1538
  # @!attribute [rw] default_storage_class
1365
1539
  # The default storage class for objects put into an Amazon S3 bucket
1366
- # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
1367
- # Optional.
1540
+ # by the S3 File Gateway. The default value is
1541
+ # `S3_INTELLIGENT_TIERING`. Optional.
1368
1542
  #
1369
1543
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
1370
1544
  # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
@@ -1372,8 +1546,8 @@ module Aws::StorageGateway
1372
1546
  #
1373
1547
  # @!attribute [rw] object_acl
1374
1548
  # A value that sets the access control list (ACL) permission for
1375
- # objects in the S3 bucket that a file gateway puts objects into. The
1376
- # default value is `private`.
1549
+ # objects in the S3 bucket that a S3 File Gateway puts objects into.
1550
+ # The default value is `private`.
1377
1551
  # @return [String]
1378
1552
  #
1379
1553
  # @!attribute [rw] read_only
@@ -1415,8 +1589,7 @@ module Aws::StorageGateway
1415
1589
  # permissions to the POSIX permissions.
1416
1590
  #
1417
1591
  # For more information, see [Using Microsoft Windows ACLs to control
1418
- # access to an SMB file share][1] in the *AWS Storage Gateway User
1419
- # Guide*.
1592
+ # access to an SMB file share][1] in the *Storage Gateway User Guide*.
1420
1593
  #
1421
1594
  # Valid Values: `true` \| `false`
1422
1595
  #
@@ -1458,8 +1631,7 @@ module Aws::StorageGateway
1458
1631
  # @return [Array<String>]
1459
1632
  #
1460
1633
  # @!attribute [rw] audit_destination_arn
1461
- # The Amazon Resource Name (ARN) of the storage used for the audit
1462
- # logs.
1634
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
1463
1635
  # @return [String]
1464
1636
  #
1465
1637
  # @!attribute [rw] authentication
@@ -1498,13 +1670,68 @@ module Aws::StorageGateway
1498
1670
  # @return [String]
1499
1671
  #
1500
1672
  # @!attribute [rw] cache_attributes
1501
- # Refresh cache information.
1673
+ # Specifies refresh cache information for the file share.
1502
1674
  # @return [Types::CacheAttributes]
1503
1675
  #
1504
1676
  # @!attribute [rw] notification_policy
1505
- # The notification policy of the file share.
1677
+ # The notification policy of the file share. `SettlingTimeInSeconds`
1678
+ # controls the number of seconds to wait after the last point in time
1679
+ # a client wrote to a file before generating an `ObjectUploaded`
1680
+ # notification. Because clients can make many small writes to files,
1681
+ # it's best to set this parameter for as long as possible to avoid
1682
+ # generating multiple notifications for the same file in a small time
1683
+ # period.
1684
+ #
1685
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
1686
+ # uploading to Amazon S3, only the timing of the notification.
1687
+ #
1688
+ # </note>
1689
+ #
1690
+ # The following example sets `NotificationPolicy` on with
1691
+ # `SettlingTimeInSeconds` set to 60.
1692
+ #
1693
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
1694
+ #
1695
+ # The following example sets `NotificationPolicy` off.
1696
+ #
1697
+ # `\{\}`
1506
1698
  # @return [String]
1507
1699
  #
1700
+ # @!attribute [rw] vpc_endpoint_dns_name
1701
+ # Specifies the DNS name for the VPC endpoint that the SMB file share
1702
+ # uses to connect to Amazon S3.
1703
+ #
1704
+ # <note markdown="1"> This parameter is required for SMB file shares that connect to
1705
+ # Amazon S3 through a VPC endpoint, a VPC access point, or an access
1706
+ # point alias that points to a VPC access point.
1707
+ #
1708
+ # </note>
1709
+ # @return [String]
1710
+ #
1711
+ # @!attribute [rw] bucket_region
1712
+ # Specifies the Region of the S3 bucket where the SMB file share
1713
+ # stores files.
1714
+ #
1715
+ # <note markdown="1"> This parameter is required for SMB file shares that connect to
1716
+ # Amazon S3 through a VPC endpoint, a VPC access point, or an access
1717
+ # point alias that points to a VPC access point.
1718
+ #
1719
+ # </note>
1720
+ # @return [String]
1721
+ #
1722
+ # @!attribute [rw] oplocks_enabled
1723
+ # Specifies whether opportunistic locking is enabled for the SMB file
1724
+ # share.
1725
+ #
1726
+ # <note markdown="1"> Enabling opportunistic locking on case-sensitive shares is not
1727
+ # recommended for workloads that involve access to files with the same
1728
+ # name in different case.
1729
+ #
1730
+ # </note>
1731
+ #
1732
+ # Valid Values: `true` \| `false`
1733
+ # @return [Boolean]
1734
+ #
1508
1735
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateSMBFileShareInput AWS API Documentation
1509
1736
  #
1510
1737
  class CreateSMBFileShareInput < Struct.new(
@@ -1530,7 +1757,10 @@ module Aws::StorageGateway
1530
1757
  :tags,
1531
1758
  :file_share_name,
1532
1759
  :cache_attributes,
1533
- :notification_policy)
1760
+ :notification_policy,
1761
+ :vpc_endpoint_dns_name,
1762
+ :bucket_region,
1763
+ :oplocks_enabled)
1534
1764
  SENSITIVE = []
1535
1765
  include Aws::Structure
1536
1766
  end
@@ -1572,7 +1802,7 @@ module Aws::StorageGateway
1572
1802
  # @!attribute [rw] snapshot_description
1573
1803
  # Textual description of the snapshot that appears in the Amazon EC2
1574
1804
  # console, Elastic Block Store snapshots panel in the **Description**
1575
- # field, and in the AWS Storage Gateway snapshot **Details** pane,
1805
+ # field, and in the Storage Gateway snapshot **Details** pane,
1576
1806
  # **Description** field.
1577
1807
  # @return [String]
1578
1808
  #
@@ -1650,7 +1880,7 @@ module Aws::StorageGateway
1650
1880
  # @!attribute [rw] snapshot_description
1651
1881
  # Textual description of the snapshot that appears in the Amazon EC2
1652
1882
  # console, Elastic Block Store snapshots panel in the **Description**
1653
- # field, and in the AWS Storage Gateway snapshot **Details** pane,
1883
+ # field, and in the Storage Gateway snapshot **Details** pane,
1654
1884
  # **Description** field.
1655
1885
  # @return [String]
1656
1886
  #
@@ -1733,8 +1963,7 @@ module Aws::StorageGateway
1733
1963
  #
1734
1964
  # @!attribute [rw] gateway_arn
1735
1965
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
1736
- # operation to return a list of gateways for your account and AWS
1737
- # Region.
1966
+ # operation to return a list of gateways for your account and Region.
1738
1967
  # @return [String]
1739
1968
  #
1740
1969
  # @!attribute [rw] disk_id
@@ -1748,7 +1977,7 @@ module Aws::StorageGateway
1748
1977
  # @return [String]
1749
1978
  #
1750
1979
  # @!attribute [rw] snapshot_id
1751
- # The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore
1980
+ # The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore
1752
1981
  # as the new stored volume. Specify this field if you want to create
1753
1982
  # the iSCSI storage volume from a snapshot; otherwise, do not include
1754
1983
  # this field. To list snapshots for your account use
@@ -1761,8 +1990,8 @@ module Aws::StorageGateway
1761
1990
  # @return [String]
1762
1991
  #
1763
1992
  # @!attribute [rw] preserve_existing_data
1764
- # Set to true `true` if you want to preserve the data on the local
1765
- # disk. Otherwise, set to `false` to create an empty volume.
1993
+ # Set to `true` if you want to preserve the data on the local disk.
1994
+ # Otherwise, set to `false` to create an empty volume.
1766
1995
  #
1767
1996
  # Valid Values: `true` \| `false`
1768
1997
  # @return [Boolean]
@@ -1789,7 +2018,7 @@ module Aws::StorageGateway
1789
2018
  #
1790
2019
  # @!attribute [rw] kms_encrypted
1791
2020
  # Set to `true` to use Amazon S3 server-side encryption with your own
1792
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
2021
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1793
2022
  #
1794
2023
  # Valid Values: `true` \| `false`
1795
2024
  # @return [Boolean]
@@ -1883,10 +2112,10 @@ module Aws::StorageGateway
1883
2112
  #
1884
2113
  # @!attribute [rw] retention_lock_type
1885
2114
  # Tape retention lock can be configured in two modes. When configured
1886
- # in governance mode, AWS accounts with specific IAM permissions are
2115
+ # in governance mode, accounts with specific IAM permissions are
1887
2116
  # authorized to remove the tape retention lock from archived virtual
1888
2117
  # tapes. When configured in compliance mode, the tape retention lock
1889
- # cannot be removed by any user, including the root AWS account.
2118
+ # cannot be removed by any user, including the root account.
1890
2119
  # @return [String]
1891
2120
  #
1892
2121
  # @!attribute [rw] retention_lock_time_in_days
@@ -1921,7 +2150,7 @@ module Aws::StorageGateway
1921
2150
  # @!attribute [rw] pool_arn
1922
2151
  # The unique Amazon Resource Name (ARN) that represents the custom
1923
2152
  # tape pool. Use the ListTapePools operation to return a list of tape
1924
- # pools for your account and AWS Region.
2153
+ # pools for your account and Region.
1925
2154
  # @return [String]
1926
2155
  #
1927
2156
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateTapePoolOutput AWS API Documentation
@@ -1956,7 +2185,7 @@ module Aws::StorageGateway
1956
2185
  # @!attribute [rw] gateway_arn
1957
2186
  # The unique Amazon Resource Name (ARN) that represents the gateway to
1958
2187
  # associate the virtual tape with. Use the ListGateways operation to
1959
- # return a list of gateways for your account and AWS Region.
2188
+ # return a list of gateways for your account and Region.
1960
2189
  # @return [String]
1961
2190
  #
1962
2191
  # @!attribute [rw] tape_size_in_bytes
@@ -1978,7 +2207,7 @@ module Aws::StorageGateway
1978
2207
  #
1979
2208
  # @!attribute [rw] kms_encrypted
1980
2209
  # Set to `true` to use Amazon S3 server-side encryption with your own
1981
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
2210
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
1982
2211
  #
1983
2212
  # Valid Values: `true` \| `false`
1984
2213
  # @return [Boolean]
@@ -2073,7 +2302,7 @@ module Aws::StorageGateway
2073
2302
  # @!attribute [rw] gateway_arn
2074
2303
  # The unique Amazon Resource Name (ARN) that represents the gateway to
2075
2304
  # associate the virtual tapes with. Use the ListGateways operation to
2076
- # return a list of gateways for your account and AWS Region.
2305
+ # return a list of gateways for your account and Region.
2077
2306
  # @return [String]
2078
2307
  #
2079
2308
  # @!attribute [rw] tape_size_in_bytes
@@ -2103,15 +2332,15 @@ module Aws::StorageGateway
2103
2332
  # A prefix that you append to the barcode of the virtual tape you are
2104
2333
  # creating. This prefix makes the barcode unique.
2105
2334
  #
2106
- # <note markdown="1"> The prefix must be 1 to 4 characters in length and must be one of
2107
- # the uppercase letters from A to Z.
2335
+ # <note markdown="1"> The prefix must be 1-4 characters in length and must be one of the
2336
+ # uppercase letters from A to Z.
2108
2337
  #
2109
2338
  # </note>
2110
2339
  # @return [String]
2111
2340
  #
2112
2341
  # @!attribute [rw] kms_encrypted
2113
2342
  # Set to `true` to use Amazon S3 server-side encryption with your own
2114
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
2343
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
2115
2344
  #
2116
2345
  # Valid Values: `true` \| `false`
2117
2346
  # @return [Boolean]
@@ -2192,8 +2421,7 @@ module Aws::StorageGateway
2192
2421
  #
2193
2422
  # @!attribute [rw] gateway_arn
2194
2423
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2195
- # operation to return a list of gateways for your account and AWS
2196
- # Region.
2424
+ # operation to return a list of gateways for your account and Region.
2197
2425
  # @return [String]
2198
2426
  #
2199
2427
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicyInput AWS API Documentation
@@ -2206,8 +2434,7 @@ module Aws::StorageGateway
2206
2434
 
2207
2435
  # @!attribute [rw] gateway_arn
2208
2436
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2209
- # operation to return a list of gateways for your account and AWS
2210
- # Region.
2437
+ # operation to return a list of gateways for your account and Region.
2211
2438
  # @return [String]
2212
2439
  #
2213
2440
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteAutomaticTapeCreationPolicyOutput AWS API Documentation
@@ -2234,8 +2461,7 @@ module Aws::StorageGateway
2234
2461
  #
2235
2462
  # @!attribute [rw] gateway_arn
2236
2463
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2237
- # operation to return a list of gateways for your account and AWS
2238
- # Region.
2464
+ # operation to return a list of gateways for your account and Region.
2239
2465
  # @return [String]
2240
2466
  #
2241
2467
  # @!attribute [rw] bandwidth_type
@@ -2259,8 +2485,7 @@ module Aws::StorageGateway
2259
2485
  #
2260
2486
  # @!attribute [rw] gateway_arn
2261
2487
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2262
- # operation to return a list of gateways for your account and AWS
2263
- # Region.
2488
+ # operation to return a list of gateways for your account and Region.
2264
2489
  # @return [String]
2265
2490
  #
2266
2491
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteBandwidthRateLimitOutput AWS API Documentation
@@ -2339,10 +2564,10 @@ module Aws::StorageGateway
2339
2564
  #
2340
2565
  # @!attribute [rw] force_delete
2341
2566
  # If this value is set to `true`, the operation deletes a file share
2342
- # immediately and aborts all data uploads to AWS. Otherwise, the file
2343
- # share is not deleted until all data is uploaded to AWS. This process
2344
- # aborts the data upload process, and the file share enters the
2345
- # `FORCE_DELETING` status.
2567
+ # immediately and aborts all data uploads to Amazon Web Services.
2568
+ # Otherwise, the file share is not deleted until all data is uploaded
2569
+ # to Amazon Web Services. This process aborts the data upload process,
2570
+ # and the file share enters the `FORCE_DELETING` status.
2346
2571
  #
2347
2572
  # Valid Values: `true` \| `false`
2348
2573
  # @return [Boolean]
@@ -2381,8 +2606,7 @@ module Aws::StorageGateway
2381
2606
  #
2382
2607
  # @!attribute [rw] gateway_arn
2383
2608
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2384
- # operation to return a list of gateways for your account and AWS
2385
- # Region.
2609
+ # operation to return a list of gateways for your account and Region.
2386
2610
  # @return [String]
2387
2611
  #
2388
2612
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteGatewayInput AWS API Documentation
@@ -2397,8 +2621,7 @@ module Aws::StorageGateway
2397
2621
  #
2398
2622
  # @!attribute [rw] gateway_arn
2399
2623
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2400
- # operation to return a list of gateways for your account and AWS
2401
- # Region.
2624
+ # operation to return a list of gateways for your account and Region.
2402
2625
  # @return [String]
2403
2626
  #
2404
2627
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DeleteGatewayOutput AWS API Documentation
@@ -2500,8 +2723,7 @@ module Aws::StorageGateway
2500
2723
  # @!attribute [rw] gateway_arn
2501
2724
  # The unique Amazon Resource Name (ARN) of the gateway that the
2502
2725
  # virtual tape to delete is associated with. Use the ListGateways
2503
- # operation to return a list of gateways for your account and AWS
2504
- # Region.
2726
+ # operation to return a list of gateways for your account and Region.
2505
2727
  # @return [String]
2506
2728
  #
2507
2729
  # @!attribute [rw] tape_arn
@@ -2618,8 +2840,7 @@ module Aws::StorageGateway
2618
2840
  #
2619
2841
  # @!attribute [rw] gateway_arn
2620
2842
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2621
- # operation to return a list of gateways for your account and AWS
2622
- # Region.
2843
+ # operation to return a list of gateways for your account and Region.
2623
2844
  # @return [String]
2624
2845
  #
2625
2846
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeAvailabilityMonitorTestInput AWS API Documentation
@@ -2632,17 +2853,16 @@ module Aws::StorageGateway
2632
2853
 
2633
2854
  # @!attribute [rw] gateway_arn
2634
2855
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2635
- # operation to return a list of gateways for your account and AWS
2636
- # Region.
2856
+ # operation to return a list of gateways for your account and Region.
2637
2857
  # @return [String]
2638
2858
  #
2639
2859
  # @!attribute [rw] status
2640
- # The status of the High Availability monitoring test. If a test
2860
+ # The status of the high availability monitoring test. If a test
2641
2861
  # hasn't been performed, the value of this field is null.
2642
2862
  # @return [String]
2643
2863
  #
2644
2864
  # @!attribute [rw] start_time
2645
- # The time the High Availability monitoring test was started. If a
2865
+ # The time the high availability monitoring test was started. If a
2646
2866
  # test hasn't been performed, the value of this field is null.
2647
2867
  # @return [Time]
2648
2868
  #
@@ -2668,8 +2888,7 @@ module Aws::StorageGateway
2668
2888
  #
2669
2889
  # @!attribute [rw] gateway_arn
2670
2890
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2671
- # operation to return a list of gateways for your account and AWS
2672
- # Region.
2891
+ # operation to return a list of gateways for your account and Region.
2673
2892
  # @return [String]
2674
2893
  #
2675
2894
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeBandwidthRateLimitInput AWS API Documentation
@@ -2684,8 +2903,7 @@ module Aws::StorageGateway
2684
2903
  #
2685
2904
  # @!attribute [rw] gateway_arn
2686
2905
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2687
- # operation to return a list of gateways for your account and AWS
2688
- # Region.
2906
+ # operation to return a list of gateways for your account and Region.
2689
2907
  # @return [String]
2690
2908
  #
2691
2909
  # @!attribute [rw] average_upload_rate_limit_in_bits_per_sec
@@ -2719,8 +2937,7 @@ module Aws::StorageGateway
2719
2937
  #
2720
2938
  # @!attribute [rw] gateway_arn
2721
2939
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2722
- # operation to return a list of gateways for your account and AWS
2723
- # Region.
2940
+ # operation to return a list of gateways for your account and Region.
2724
2941
  # @return [String]
2725
2942
  #
2726
2943
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeBandwidthRateLimitScheduleInput AWS API Documentation
@@ -2733,8 +2950,7 @@ module Aws::StorageGateway
2733
2950
 
2734
2951
  # @!attribute [rw] gateway_arn
2735
2952
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2736
- # operation to return a list of gateways for your account and AWS
2737
- # Region.
2953
+ # operation to return a list of gateways for your account and Region.
2738
2954
  # @return [String]
2739
2955
  #
2740
2956
  # @!attribute [rw] bandwidth_rate_limit_intervals
@@ -2760,8 +2976,7 @@ module Aws::StorageGateway
2760
2976
  #
2761
2977
  # @!attribute [rw] gateway_arn
2762
2978
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2763
- # operation to return a list of gateways for your account and AWS
2764
- # Region.
2979
+ # operation to return a list of gateways for your account and Region.
2765
2980
  # @return [String]
2766
2981
  #
2767
2982
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeCacheInput AWS API Documentation
@@ -2774,8 +2989,7 @@ module Aws::StorageGateway
2774
2989
 
2775
2990
  # @!attribute [rw] gateway_arn
2776
2991
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2777
- # operation to return a list of gateways for your account and AWS
2778
- # Region.
2992
+ # operation to return a list of gateways for your account and Region.
2779
2993
  # @return [String]
2780
2994
  #
2781
2995
  # @!attribute [rw] disk_ids
@@ -2796,8 +3010,8 @@ module Aws::StorageGateway
2796
3010
  #
2797
3011
  # @!attribute [rw] cache_dirty_percentage
2798
3012
  # The file share's contribution to the overall percentage of the
2799
- # gateway's cache that has not been persisted to AWS. The sample is
2800
- # taken at the end of the reporting period.
3013
+ # gateway's cache that has not been persisted to Amazon Web Services.
3014
+ # The sample is taken at the end of the reporting period.
2801
3015
  # @return [Float]
2802
3016
  #
2803
3017
  # @!attribute [rw] cache_hit_percentage
@@ -2919,6 +3133,39 @@ module Aws::StorageGateway
2919
3133
  include Aws::Structure
2920
3134
  end
2921
3135
 
3136
+ # @note When making an API call, you may pass DescribeFileSystemAssociationsInput
3137
+ # data as a hash:
3138
+ #
3139
+ # {
3140
+ # file_system_association_arn_list: ["FileSystemAssociationARN"], # required
3141
+ # }
3142
+ #
3143
+ # @!attribute [rw] file_system_association_arn_list
3144
+ # An array containing the Amazon Resource Name (ARN) of each file
3145
+ # system association to be described.
3146
+ # @return [Array<String>]
3147
+ #
3148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeFileSystemAssociationsInput AWS API Documentation
3149
+ #
3150
+ class DescribeFileSystemAssociationsInput < Struct.new(
3151
+ :file_system_association_arn_list)
3152
+ SENSITIVE = []
3153
+ include Aws::Structure
3154
+ end
3155
+
3156
+ # @!attribute [rw] file_system_association_info_list
3157
+ # An array containing the `FileSystemAssociationInfo` data type of
3158
+ # each file system association to be described.
3159
+ # @return [Array<Types::FileSystemAssociationInfo>]
3160
+ #
3161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeFileSystemAssociationsOutput AWS API Documentation
3162
+ #
3163
+ class DescribeFileSystemAssociationsOutput < Struct.new(
3164
+ :file_system_association_info_list)
3165
+ SENSITIVE = []
3166
+ include Aws::Structure
3167
+ end
3168
+
2922
3169
  # A JSON object containing the ID of the gateway.
2923
3170
  #
2924
3171
  # @note When making an API call, you may pass DescribeGatewayInformationInput
@@ -2930,8 +3177,7 @@ module Aws::StorageGateway
2930
3177
  #
2931
3178
  # @!attribute [rw] gateway_arn
2932
3179
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2933
- # operation to return a list of gateways for your account and AWS
2934
- # Region.
3180
+ # operation to return a list of gateways for your account and Region.
2935
3181
  # @return [String]
2936
3182
  #
2937
3183
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformationInput AWS API Documentation
@@ -2946,8 +3192,7 @@ module Aws::StorageGateway
2946
3192
  #
2947
3193
  # @!attribute [rw] gateway_arn
2948
3194
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
2949
- # operation to return a list of gateways for your account and AWS
2950
- # Region.
3195
+ # operation to return a list of gateways for your account and Region.
2951
3196
  # @return [String]
2952
3197
  #
2953
3198
  # @!attribute [rw] gateway_id
@@ -2995,7 +3240,7 @@ module Aws::StorageGateway
2995
3240
  # @return [String]
2996
3241
  #
2997
3242
  # @!attribute [rw] ec2_instance_region
2998
- # The AWS Region where the Amazon EC2 instance is located.
3243
+ # The Region where the Amazon EC2 instance is located.
2999
3244
  # @return [String]
3000
3245
  #
3001
3246
  # @!attribute [rw] tags
@@ -3035,6 +3280,15 @@ module Aws::StorageGateway
3035
3280
  # new features and bug fixes.
3036
3281
  # @return [String]
3037
3282
  #
3283
+ # @!attribute [rw] gateway_capacity
3284
+ # Specifies the size of the gateway's metadata cache.
3285
+ # @return [String]
3286
+ #
3287
+ # @!attribute [rw] supported_gateway_capacities
3288
+ # A list of the metadata cache sizes that the gateway can support
3289
+ # based on its current hardware specifications.
3290
+ # @return [Array<String>]
3291
+ #
3038
3292
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeGatewayInformationOutput AWS API Documentation
3039
3293
  #
3040
3294
  class DescribeGatewayInformationOutput < Struct.new(
@@ -3055,7 +3309,9 @@ module Aws::StorageGateway
3055
3309
  :host_environment,
3056
3310
  :endpoint_type,
3057
3311
  :software_updates_end_date,
3058
- :deprecation_date)
3312
+ :deprecation_date,
3313
+ :gateway_capacity,
3314
+ :supported_gateway_capacities)
3059
3315
  SENSITIVE = []
3060
3316
  include Aws::Structure
3061
3317
  end
@@ -3072,8 +3328,7 @@ module Aws::StorageGateway
3072
3328
  #
3073
3329
  # @!attribute [rw] gateway_arn
3074
3330
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3075
- # operation to return a list of gateways for your account and AWS
3076
- # Region.
3331
+ # operation to return a list of gateways for your account and Region.
3077
3332
  # @return [String]
3078
3333
  #
3079
3334
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeMaintenanceStartTimeInput AWS API Documentation
@@ -3098,8 +3353,7 @@ module Aws::StorageGateway
3098
3353
  #
3099
3354
  # @!attribute [rw] gateway_arn
3100
3355
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3101
- # operation to return a list of gateways for your account and AWS
3102
- # Region.
3356
+ # operation to return a list of gateways for your account and Region.
3103
3357
  # @return [String]
3104
3358
  #
3105
3359
  # @!attribute [rw] hour_of_day
@@ -3227,8 +3481,7 @@ module Aws::StorageGateway
3227
3481
  #
3228
3482
  # @!attribute [rw] gateway_arn
3229
3483
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3230
- # operation to return a list of gateways for your account and AWS
3231
- # Region.
3484
+ # operation to return a list of gateways for your account and Region.
3232
3485
  # @return [String]
3233
3486
  #
3234
3487
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettingsInput AWS API Documentation
@@ -3241,8 +3494,7 @@ module Aws::StorageGateway
3241
3494
 
3242
3495
  # @!attribute [rw] gateway_arn
3243
3496
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3244
- # operation to return a list of gateways for your account and AWS
3245
- # Region.
3497
+ # operation to return a list of gateways for your account and Region.
3246
3498
  # @return [String]
3247
3499
  #
3248
3500
  # @!attribute [rw] domain_name
@@ -3276,7 +3528,7 @@ module Aws::StorageGateway
3276
3528
  #
3277
3529
  # @!attribute [rw] smb_guest_password_set
3278
3530
  # This value is `true` if a password for the guest user `smbguest` is
3279
- # set, otherwise `false`.
3531
+ # set, otherwise `false`. Only supported for S3 File Gateways.
3280
3532
  #
3281
3533
  # Valid Values: `true` \| `false`
3282
3534
  # @return [Boolean]
@@ -3287,7 +3539,8 @@ module Aws::StorageGateway
3287
3539
  # * `ClientSpecified`\: If you use this option, requests are
3288
3540
  # established based on what is negotiated by the client. This option
3289
3541
  # is recommended when you want to maximize compatibility across
3290
- # different clients in your environment.
3542
+ # different clients in your environment. Only supported for S3 File
3543
+ # Gateways.
3291
3544
  #
3292
3545
  # * `MandatorySigning`\: If you use this option, file gateway only
3293
3546
  # allows connections from SMBv2 or SMBv3 clients that have signing
@@ -3302,7 +3555,8 @@ module Aws::StorageGateway
3302
3555
  # @return [String]
3303
3556
  #
3304
3557
  # @!attribute [rw] file_shares_visible
3305
- # The shares on this gateway appear when listing shares.
3558
+ # The shares on this gateway appear when listing shares. Only
3559
+ # supported for S3 File Gateways.
3306
3560
  # @return [Boolean]
3307
3561
  #
3308
3562
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettingsOutput AWS API Documentation
@@ -3546,8 +3800,7 @@ module Aws::StorageGateway
3546
3800
  #
3547
3801
  # @!attribute [rw] gateway_arn
3548
3802
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3549
- # operation to return a list of gateways for your account and AWS
3550
- # Region.
3803
+ # operation to return a list of gateways for your account and Region.
3551
3804
  # @return [String]
3552
3805
  #
3553
3806
  # @!attribute [rw] marker
@@ -3574,8 +3827,7 @@ module Aws::StorageGateway
3574
3827
  #
3575
3828
  # @!attribute [rw] gateway_arn
3576
3829
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3577
- # operation to return a list of gateways for your account and AWS
3578
- # Region.
3830
+ # operation to return a list of gateways for your account and Region.
3579
3831
  # @return [String]
3580
3832
  #
3581
3833
  # @!attribute [rw] tape_recovery_point_infos
@@ -3616,8 +3868,7 @@ module Aws::StorageGateway
3616
3868
  #
3617
3869
  # @!attribute [rw] gateway_arn
3618
3870
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3619
- # operation to return a list of gateways for your account and AWS
3620
- # Region.
3871
+ # operation to return a list of gateways for your account and Region.
3621
3872
  # @return [String]
3622
3873
  #
3623
3874
  # @!attribute [rw] tape_arns
@@ -3662,8 +3913,8 @@ module Aws::StorageGateway
3662
3913
  # @return [Array<Types::Tape>]
3663
3914
  #
3664
3915
  # @!attribute [rw] marker
3665
- # An opaque string which can be used as part of a subsequent
3666
- # DescribeTapes call to retrieve the next page of results.
3916
+ # An opaque string that can be used as part of a subsequent
3917
+ # `DescribeTapes` call to retrieve the next page of results.
3667
3918
  #
3668
3919
  # If a response does not contain a marker, then there are no more
3669
3920
  # results to be retrieved.
@@ -3687,8 +3938,7 @@ module Aws::StorageGateway
3687
3938
  #
3688
3939
  # @!attribute [rw] gateway_arn
3689
3940
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3690
- # operation to return a list of gateways for your account and AWS
3691
- # Region.
3941
+ # operation to return a list of gateways for your account and Region.
3692
3942
  # @return [String]
3693
3943
  #
3694
3944
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeUploadBufferInput AWS API Documentation
@@ -3701,8 +3951,7 @@ module Aws::StorageGateway
3701
3951
 
3702
3952
  # @!attribute [rw] gateway_arn
3703
3953
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3704
- # operation to return a list of gateways for your account and AWS
3705
- # Region.
3954
+ # operation to return a list of gateways for your account and Region.
3706
3955
  # @return [String]
3707
3956
  #
3708
3957
  # @!attribute [rw] disk_ids
@@ -3747,8 +3996,7 @@ module Aws::StorageGateway
3747
3996
  #
3748
3997
  # @!attribute [rw] gateway_arn
3749
3998
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3750
- # operation to return a list of gateways for your account and AWS
3751
- # Region.
3999
+ # operation to return a list of gateways for your account and Region.
3752
4000
  # @return [String]
3753
4001
  #
3754
4002
  # @!attribute [rw] vtl_device_arns
@@ -3787,8 +4035,7 @@ module Aws::StorageGateway
3787
4035
  #
3788
4036
  # @!attribute [rw] gateway_arn
3789
4037
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3790
- # operation to return a list of gateways for your account and AWS
3791
- # Region.
4038
+ # operation to return a list of gateways for your account and Region.
3792
4039
  # @return [String]
3793
4040
  #
3794
4041
  # @!attribute [rw] vtl_devices
@@ -3826,8 +4073,7 @@ module Aws::StorageGateway
3826
4073
  #
3827
4074
  # @!attribute [rw] gateway_arn
3828
4075
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3829
- # operation to return a list of gateways for your account and AWS
3830
- # Region.
4076
+ # operation to return a list of gateways for your account and Region.
3831
4077
  # @return [String]
3832
4078
  #
3833
4079
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeWorkingStorageInput AWS API Documentation
@@ -3842,8 +4088,7 @@ module Aws::StorageGateway
3842
4088
  #
3843
4089
  # @!attribute [rw] gateway_arn
3844
4090
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3845
- # operation to return a list of gateways for your account and AWS
3846
- # Region.
4091
+ # operation to return a list of gateways for your account and Region.
3847
4092
  # @return [String]
3848
4093
  #
3849
4094
  # @!attribute [rw] disk_ids
@@ -3962,8 +4207,7 @@ module Aws::StorageGateway
3962
4207
  #
3963
4208
  # @!attribute [rw] gateway_arn
3964
4209
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
3965
- # operation to return a list of gateways for your account and AWS
3966
- # Region.
4210
+ # operation to return a list of gateways for your account and Region.
3967
4211
  # @return [String]
3968
4212
  #
3969
4213
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DisableGatewayInput AWS API Documentation
@@ -3988,6 +4232,49 @@ module Aws::StorageGateway
3988
4232
  include Aws::Structure
3989
4233
  end
3990
4234
 
4235
+ # @note When making an API call, you may pass DisassociateFileSystemInput
4236
+ # data as a hash:
4237
+ #
4238
+ # {
4239
+ # file_system_association_arn: "FileSystemAssociationARN", # required
4240
+ # force_delete: false,
4241
+ # }
4242
+ #
4243
+ # @!attribute [rw] file_system_association_arn
4244
+ # The Amazon Resource Name (ARN) of the file system association to be
4245
+ # deleted.
4246
+ # @return [String]
4247
+ #
4248
+ # @!attribute [rw] force_delete
4249
+ # If this value is set to true, the operation disassociates an Amazon
4250
+ # FSx file system immediately. It ends all data uploads to the file
4251
+ # system, and the file system association enters the `FORCE_DELETING`
4252
+ # status. If this value is set to false, the Amazon FSx file system
4253
+ # does not disassociate until all data is uploaded.
4254
+ # @return [Boolean]
4255
+ #
4256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DisassociateFileSystemInput AWS API Documentation
4257
+ #
4258
+ class DisassociateFileSystemInput < Struct.new(
4259
+ :file_system_association_arn,
4260
+ :force_delete)
4261
+ SENSITIVE = []
4262
+ include Aws::Structure
4263
+ end
4264
+
4265
+ # @!attribute [rw] file_system_association_arn
4266
+ # The Amazon Resource Name (ARN) of the deleted file system
4267
+ # association.
4268
+ # @return [String]
4269
+ #
4270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DisassociateFileSystemOutput AWS API Documentation
4271
+ #
4272
+ class DisassociateFileSystemOutput < Struct.new(
4273
+ :file_system_association_arn)
4274
+ SENSITIVE = []
4275
+ include Aws::Structure
4276
+ end
4277
+
3991
4278
  # Represents a gateway's local disk.
3992
4279
  #
3993
4280
  # @!attribute [rw] disk_id
@@ -4045,7 +4332,35 @@ module Aws::StorageGateway
4045
4332
  include Aws::Structure
4046
4333
  end
4047
4334
 
4048
- # Describes a file share.
4335
+ # Specifies network configuration information for the gateway associated
4336
+ # with the Amazon FSx file system.
4337
+ #
4338
+ # @note When making an API call, you may pass EndpointNetworkConfiguration
4339
+ # data as a hash:
4340
+ #
4341
+ # {
4342
+ # ip_addresses: ["IPV4Address"],
4343
+ # }
4344
+ #
4345
+ # @!attribute [rw] ip_addresses
4346
+ # A list of gateway IP addresses on which the associated Amazon FSx
4347
+ # file system is available.
4348
+ #
4349
+ # <note markdown="1"> If multiple file systems are associated with this gateway, this
4350
+ # field is required.
4351
+ #
4352
+ # </note>
4353
+ # @return [Array<String>]
4354
+ #
4355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/EndpointNetworkConfiguration AWS API Documentation
4356
+ #
4357
+ class EndpointNetworkConfiguration < Struct.new(
4358
+ :ip_addresses)
4359
+ SENSITIVE = []
4360
+ include Aws::Structure
4361
+ end
4362
+
4363
+ # Describes a file share. Only supported S3 File Gateway.
4049
4364
  #
4050
4365
  # @!attribute [rw] file_share_type
4051
4366
  # The type of the file share.
@@ -4067,8 +4382,7 @@ module Aws::StorageGateway
4067
4382
  #
4068
4383
  # @!attribute [rw] gateway_arn
4069
4384
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4070
- # operation to return a list of gateways for your account and AWS
4071
- # Region.
4385
+ # operation to return a list of gateways for your account and Region.
4072
4386
  # @return [String]
4073
4387
  #
4074
4388
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/FileShareInfo AWS API Documentation
@@ -4083,6 +4397,107 @@ module Aws::StorageGateway
4083
4397
  include Aws::Structure
4084
4398
  end
4085
4399
 
4400
+ # Describes the object returned by `DescribeFileSystemAssociations` that
4401
+ # describes a created file system association.
4402
+ #
4403
+ # @!attribute [rw] file_system_association_arn
4404
+ # The Amazon Resource Name (ARN) of the file system association.
4405
+ # @return [String]
4406
+ #
4407
+ # @!attribute [rw] location_arn
4408
+ # The ARN of the backend Amazon FSx file system used for storing file
4409
+ # data. For information, see [FileSystem][1] in the *Amazon FSx API
4410
+ # Reference*.
4411
+ #
4412
+ #
4413
+ #
4414
+ # [1]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_FileSystem.html
4415
+ # @return [String]
4416
+ #
4417
+ # @!attribute [rw] file_system_association_status
4418
+ # The status of the file system association. Valid Values: `AVAILABLE`
4419
+ # \| `CREATING` \| `DELETING` \| `FORCE_DELETING` \| `UPDATING` \|
4420
+ # `ERROR`
4421
+ # @return [String]
4422
+ #
4423
+ # @!attribute [rw] audit_destination_arn
4424
+ # The Amazon Resource Name (ARN) of the storage used for the audit
4425
+ # logs.
4426
+ # @return [String]
4427
+ #
4428
+ # @!attribute [rw] gateway_arn
4429
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4430
+ # operation to return a list of gateways for your account and Region.
4431
+ # @return [String]
4432
+ #
4433
+ # @!attribute [rw] tags
4434
+ # A list of up to 50 tags assigned to the SMB file share, sorted
4435
+ # alphabetically by key name. Each tag is a key-value pair.
4436
+ # @return [Array<Types::Tag>]
4437
+ #
4438
+ # @!attribute [rw] cache_attributes
4439
+ # The refresh cache information for the file share or FSx file
4440
+ # systems.
4441
+ # @return [Types::CacheAttributes]
4442
+ #
4443
+ # @!attribute [rw] endpoint_network_configuration
4444
+ # Specifies network configuration information for the gateway
4445
+ # associated with the Amazon FSx file system.
4446
+ #
4447
+ # <note markdown="1"> If multiple file systems are associated with this gateway, this
4448
+ # parameter's `IpAddresses` field is required.
4449
+ #
4450
+ # </note>
4451
+ # @return [Types::EndpointNetworkConfiguration]
4452
+ #
4453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/FileSystemAssociationInfo AWS API Documentation
4454
+ #
4455
+ class FileSystemAssociationInfo < Struct.new(
4456
+ :file_system_association_arn,
4457
+ :location_arn,
4458
+ :file_system_association_status,
4459
+ :audit_destination_arn,
4460
+ :gateway_arn,
4461
+ :tags,
4462
+ :cache_attributes,
4463
+ :endpoint_network_configuration)
4464
+ SENSITIVE = []
4465
+ include Aws::Structure
4466
+ end
4467
+
4468
+ # Gets the summary returned by `ListFileSystemAssociation`, which is a
4469
+ # summary of a created file system association.
4470
+ #
4471
+ # @!attribute [rw] file_system_association_id
4472
+ # The ID of the file system association.
4473
+ # @return [String]
4474
+ #
4475
+ # @!attribute [rw] file_system_association_arn
4476
+ # The Amazon Resource Name (ARN) of the file system association.
4477
+ # @return [String]
4478
+ #
4479
+ # @!attribute [rw] file_system_association_status
4480
+ # The status of the file share. Valid Values: `AVAILABLE` \|
4481
+ # `CREATING` \| `DELETING` \| `FORCE_DELETING` \| `UPDATING` \|
4482
+ # `ERROR`
4483
+ # @return [String]
4484
+ #
4485
+ # @!attribute [rw] gateway_arn
4486
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4487
+ # operation to return a list of gateways for your account and Region.
4488
+ # @return [String]
4489
+ #
4490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/FileSystemAssociationSummary AWS API Documentation
4491
+ #
4492
+ class FileSystemAssociationSummary < Struct.new(
4493
+ :file_system_association_id,
4494
+ :file_system_association_arn,
4495
+ :file_system_association_status,
4496
+ :gateway_arn)
4497
+ SENSITIVE = []
4498
+ include Aws::Structure
4499
+ end
4500
+
4086
4501
  # Describes a gateway object.
4087
4502
  #
4088
4503
  # @!attribute [rw] gateway_id
@@ -4093,8 +4508,7 @@ module Aws::StorageGateway
4093
4508
  #
4094
4509
  # @!attribute [rw] gateway_arn
4095
4510
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4096
- # operation to return a list of gateways for your account and AWS
4097
- # Region.
4511
+ # operation to return a list of gateways for your account and Region.
4098
4512
  # @return [String]
4099
4513
  #
4100
4514
  # @!attribute [rw] gateway_type
@@ -4117,7 +4531,7 @@ module Aws::StorageGateway
4117
4531
  # @return [String]
4118
4532
  #
4119
4533
  # @!attribute [rw] ec2_instance_region
4120
- # The AWS Region where the Amazon EC2 instance is located.
4534
+ # The Region where the Amazon EC2 instance is located.
4121
4535
  # @return [String]
4122
4536
  #
4123
4537
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/GatewayInfo AWS API Documentation
@@ -4194,7 +4608,7 @@ module Aws::StorageGateway
4194
4608
  # @!attribute [rw] gateway_arn
4195
4609
  # The Amazon Resource Name (ARN) of the gateway. Use the
4196
4610
  # `ListGateways` operation to return a list of gateways for your
4197
- # account and AWS Region.
4611
+ # account and Region.
4198
4612
  # @return [String]
4199
4613
  #
4200
4614
  # @!attribute [rw] domain_name
@@ -4296,8 +4710,7 @@ module Aws::StorageGateway
4296
4710
  #
4297
4711
  # @!attribute [rw] gateway_arn
4298
4712
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4299
- # operation to return a list of gateways for your account and AWS
4300
- # Region.
4713
+ # operation to return a list of gateways for your account and Region.
4301
4714
  # @return [String]
4302
4715
  #
4303
4716
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListAutomaticTapeCreationPoliciesInput AWS API Documentation
@@ -4374,7 +4787,7 @@ module Aws::StorageGateway
4374
4787
  # @return [String]
4375
4788
  #
4376
4789
  # @!attribute [rw] file_share_info_list
4377
- # An array of information about the file gateway's file shares.
4790
+ # An array of information about the S3 File Gateway's file shares.
4378
4791
  # @return [Array<Types::FileShareInfo>]
4379
4792
  #
4380
4793
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListFileSharesOutput AWS API Documentation
@@ -4387,6 +4800,69 @@ module Aws::StorageGateway
4387
4800
  include Aws::Structure
4388
4801
  end
4389
4802
 
4803
+ # @note When making an API call, you may pass ListFileSystemAssociationsInput
4804
+ # data as a hash:
4805
+ #
4806
+ # {
4807
+ # gateway_arn: "GatewayARN",
4808
+ # limit: 1,
4809
+ # marker: "Marker",
4810
+ # }
4811
+ #
4812
+ # @!attribute [rw] gateway_arn
4813
+ # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4814
+ # operation to return a list of gateways for your account and Region.
4815
+ # @return [String]
4816
+ #
4817
+ # @!attribute [rw] limit
4818
+ # The maximum number of file system associations to return in the
4819
+ # response. If present, `Limit` must be an integer with a value
4820
+ # greater than zero. Optional.
4821
+ # @return [Integer]
4822
+ #
4823
+ # @!attribute [rw] marker
4824
+ # Opaque pagination token returned from a previous
4825
+ # `ListFileSystemAssociations` operation. If present, `Marker`
4826
+ # specifies where to continue the list from after a previous call to
4827
+ # `ListFileSystemAssociations`. Optional.
4828
+ # @return [String]
4829
+ #
4830
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListFileSystemAssociationsInput AWS API Documentation
4831
+ #
4832
+ class ListFileSystemAssociationsInput < Struct.new(
4833
+ :gateway_arn,
4834
+ :limit,
4835
+ :marker)
4836
+ SENSITIVE = []
4837
+ include Aws::Structure
4838
+ end
4839
+
4840
+ # @!attribute [rw] marker
4841
+ # If the request includes `Marker`, the response returns that value in
4842
+ # this field.
4843
+ # @return [String]
4844
+ #
4845
+ # @!attribute [rw] next_marker
4846
+ # If a value is present, there are more file system associations to
4847
+ # return. In a subsequent request, use `NextMarker` as the value for
4848
+ # `Marker` to retrieve the next set of file system associations.
4849
+ # @return [String]
4850
+ #
4851
+ # @!attribute [rw] file_system_association_summary_list
4852
+ # An array of information about the Amazon FSx gateway's file system
4853
+ # associations.
4854
+ # @return [Array<Types::FileSystemAssociationSummary>]
4855
+ #
4856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListFileSystemAssociationsOutput AWS API Documentation
4857
+ #
4858
+ class ListFileSystemAssociationsOutput < Struct.new(
4859
+ :marker,
4860
+ :next_marker,
4861
+ :file_system_association_summary_list)
4862
+ SENSITIVE = []
4863
+ include Aws::Structure
4864
+ end
4865
+
4390
4866
  # A JSON object containing zero or more of the following fields:
4391
4867
  #
4392
4868
  # * ListGatewaysInput$Limit
@@ -4451,8 +4927,7 @@ module Aws::StorageGateway
4451
4927
  #
4452
4928
  # @!attribute [rw] gateway_arn
4453
4929
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4454
- # operation to return a list of gateways for your account and AWS
4455
- # Region.
4930
+ # operation to return a list of gateways for your account and Region.
4456
4931
  # @return [String]
4457
4932
  #
4458
4933
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListLocalDisksInput AWS API Documentation
@@ -4465,8 +4940,7 @@ module Aws::StorageGateway
4465
4940
 
4466
4941
  # @!attribute [rw] gateway_arn
4467
4942
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4468
- # operation to return a list of gateways for your account and AWS
4469
- # Region.
4943
+ # operation to return a list of gateways for your account and Region.
4470
4944
  # @return [String]
4471
4945
  #
4472
4946
  # @!attribute [rw] disks
@@ -4722,8 +5196,7 @@ module Aws::StorageGateway
4722
5196
  #
4723
5197
  # @!attribute [rw] gateway_arn
4724
5198
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4725
- # operation to return a list of gateways for your account and AWS
4726
- # Region.
5199
+ # operation to return a list of gateways for your account and Region.
4727
5200
  # @return [String]
4728
5201
  #
4729
5202
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ListVolumeRecoveryPointsInput AWS API Documentation
@@ -4736,8 +5209,7 @@ module Aws::StorageGateway
4736
5209
 
4737
5210
  # @!attribute [rw] gateway_arn
4738
5211
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4739
- # operation to return a list of gateways for your account and AWS
4740
- # Region.
5212
+ # operation to return a list of gateways for your account and Region.
4741
5213
  # @return [String]
4742
5214
  #
4743
5215
  # @!attribute [rw] volume_recovery_point_infos
@@ -4770,8 +5242,7 @@ module Aws::StorageGateway
4770
5242
  #
4771
5243
  # @!attribute [rw] gateway_arn
4772
5244
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4773
- # operation to return a list of gateways for your account and AWS
4774
- # Region.
5245
+ # operation to return a list of gateways for your account and Region.
4775
5246
  # @return [String]
4776
5247
  #
4777
5248
  # @!attribute [rw] marker
@@ -4803,8 +5274,7 @@ module Aws::StorageGateway
4803
5274
  #
4804
5275
  # @!attribute [rw] gateway_arn
4805
5276
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4806
- # operation to return a list of gateways for your account and AWS
4807
- # Region.
5277
+ # operation to return a list of gateways for your account and Region.
4808
5278
  # @return [String]
4809
5279
  #
4810
5280
  # @!attribute [rw] marker
@@ -4834,7 +5304,7 @@ module Aws::StorageGateway
4834
5304
  # default, have Unix file permissions assigned to them. Upon discovery
4835
5305
  # in an S3 bucket by Storage Gateway, the S3 objects that represent
4836
5306
  # files and folders are assigned these default Unix permissions. This
4837
- # operation is only supported for file gateways.
5307
+ # operation is only supported for S3 File Gateways.
4838
5308
  #
4839
5309
  # @note When making an API call, you may pass NFSFileShareDefaults
4840
5310
  # data as a hash:
@@ -4880,8 +5350,8 @@ module Aws::StorageGateway
4880
5350
  end
4881
5351
 
4882
5352
  # The Unix file permissions and ownership information assigned, by
4883
- # default, to native S3 objects when file gateway discovers them in S3
4884
- # buckets. This operation is only supported in file gateways.
5353
+ # default, to native S3 objects when an S3 File Gateway discovers them
5354
+ # in S3 buckets. This operation is only supported in S3 File Gateways.
4885
5355
  #
4886
5356
  # @!attribute [rw] nfs_file_share_defaults
4887
5357
  # Describes Network File System (NFS) file share default values. Files
@@ -4889,7 +5359,7 @@ module Aws::StorageGateway
4889
5359
  # default, have Unix file permissions assigned to them. Upon discovery
4890
5360
  # in an S3 bucket by Storage Gateway, the S3 objects that represent
4891
5361
  # files and folders are assigned these default Unix permissions. This
4892
- # operation is only supported for file gateways.
5362
+ # operation is only supported for S3 File Gateways.
4893
5363
  # @return [Types::NFSFileShareDefaults]
4894
5364
  #
4895
5365
  # @!attribute [rw] file_share_arn
@@ -4908,13 +5378,12 @@ module Aws::StorageGateway
4908
5378
  #
4909
5379
  # @!attribute [rw] gateway_arn
4910
5380
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
4911
- # operation to return a list of gateways for your account and AWS
4912
- # Region.
5381
+ # operation to return a list of gateways for your account and Region.
4913
5382
  # @return [String]
4914
5383
  #
4915
5384
  # @!attribute [rw] kms_encrypted
4916
5385
  # Set to `true` to use Amazon S3 server-side encryption with your own
4917
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
5386
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
4918
5387
  #
4919
5388
  # Valid Values: `true` \| `false`
4920
5389
  # @return [Boolean]
@@ -4932,8 +5401,8 @@ module Aws::StorageGateway
4932
5401
  # @return [String]
4933
5402
  #
4934
5403
  # @!attribute [rw] role
4935
- # The ARN of the IAM role that file gateway assumes when it accesses
4936
- # the underlying storage.
5404
+ # The ARN of the IAM role that an S3 File Gateway assumes when it
5405
+ # accesses the underlying storage.
4937
5406
  # @return [String]
4938
5407
  #
4939
5408
  # @!attribute [rw] location_arn
@@ -4943,8 +5412,8 @@ module Aws::StorageGateway
4943
5412
  #
4944
5413
  # @!attribute [rw] default_storage_class
4945
5414
  # The default storage class for objects put into an Amazon S3 bucket
4946
- # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
4947
- # Optional.
5415
+ # by the S3 File Gateway. The default value is
5416
+ # `S3_INTELLIGENT_TIERING`. Optional.
4948
5417
  #
4949
5418
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
4950
5419
  # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
@@ -4952,13 +5421,14 @@ module Aws::StorageGateway
4952
5421
  #
4953
5422
  # @!attribute [rw] object_acl
4954
5423
  # A value that sets the access control list (ACL) permission for
4955
- # objects in the S3 bucket that a file gateway puts objects into. The
4956
- # default value is `private`.
5424
+ # objects in the S3 bucket that an S3 File Gateway puts objects into.
5425
+ # The default value is `private`.
4957
5426
  # @return [String]
4958
5427
  #
4959
5428
  # @!attribute [rw] client_list
4960
- # The list of clients that are allowed to access the file gateway. The
4961
- # list must contain either valid IP addresses or valid CIDR blocks.
5429
+ # The list of clients that are allowed to access the S3 File Gateway.
5430
+ # The list must contain either valid IP addresses or valid CIDR
5431
+ # blocks.
4962
5432
  # @return [Array<String>]
4963
5433
  #
4964
5434
  # @!attribute [rw] squash
@@ -5021,11 +5491,53 @@ module Aws::StorageGateway
5021
5491
  # @return [String]
5022
5492
  #
5023
5493
  # @!attribute [rw] cache_attributes
5024
- # Refresh cache information.
5494
+ # Refresh cache information for the file share.
5025
5495
  # @return [Types::CacheAttributes]
5026
5496
  #
5027
5497
  # @!attribute [rw] notification_policy
5028
- # The notification policy of the file share.
5498
+ # The notification policy of the file share. `SettlingTimeInSeconds`
5499
+ # controls the number of seconds to wait after the last point in time
5500
+ # a client wrote to a file before generating an `ObjectUploaded`
5501
+ # notification. Because clients can make many small writes to files,
5502
+ # it's best to set this parameter for as long as possible to avoid
5503
+ # generating multiple notifications for the same file in a small time
5504
+ # period.
5505
+ #
5506
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
5507
+ # uploading to Amazon S3, only the timing of the notification.
5508
+ #
5509
+ # </note>
5510
+ #
5511
+ # The following example sets `NotificationPolicy` on with
5512
+ # `SettlingTimeInSeconds` set to 60.
5513
+ #
5514
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
5515
+ #
5516
+ # The following example sets `NotificationPolicy` off.
5517
+ #
5518
+ # `\{\}`
5519
+ # @return [String]
5520
+ #
5521
+ # @!attribute [rw] vpc_endpoint_dns_name
5522
+ # Specifies the DNS name for the VPC endpoint that the NFS file share
5523
+ # uses to connect to Amazon S3.
5524
+ #
5525
+ # <note markdown="1"> This parameter is required for NFS file shares that connect to
5526
+ # Amazon S3 through a VPC endpoint, a VPC access point, or an access
5527
+ # point alias that points to a VPC access point.
5528
+ #
5529
+ # </note>
5530
+ # @return [String]
5531
+ #
5532
+ # @!attribute [rw] bucket_region
5533
+ # Specifies the Region of the S3 bucket where the NFS file share
5534
+ # stores files.
5535
+ #
5536
+ # <note markdown="1"> This parameter is required for NFS file shares that connect to
5537
+ # Amazon S3 through a VPC endpoint, a VPC access point, or an access
5538
+ # point alias that points to a VPC access point.
5539
+ #
5540
+ # </note>
5029
5541
  # @return [String]
5030
5542
  #
5031
5543
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/NFSFileShareInfo AWS API Documentation
@@ -5051,7 +5563,9 @@ module Aws::StorageGateway
5051
5563
  :tags,
5052
5564
  :file_share_name,
5053
5565
  :cache_attributes,
5054
- :notification_policy)
5566
+ :notification_policy,
5567
+ :vpc_endpoint_dns_name,
5568
+ :bucket_region)
5055
5569
  SENSITIVE = []
5056
5570
  include Aws::Structure
5057
5571
  end
@@ -5127,7 +5641,7 @@ module Aws::StorageGateway
5127
5641
  # @!attribute [rw] pool_arn
5128
5642
  # The Amazon Resource Name (ARN) of the custom tape pool. Use the
5129
5643
  # ListTapePools operation to return a list of custom tape pools for
5130
- # your account and AWS Region.
5644
+ # your account and Region.
5131
5645
  # @return [String]
5132
5646
  #
5133
5647
  # @!attribute [rw] pool_name
@@ -5144,10 +5658,10 @@ module Aws::StorageGateway
5144
5658
  #
5145
5659
  # @!attribute [rw] retention_lock_type
5146
5660
  # Tape retention lock type, which can be configured in two modes. When
5147
- # configured in governance mode, AWS accounts with specific IAM
5661
+ # configured in governance mode, accounts with specific IAM
5148
5662
  # permissions are authorized to remove the tape retention lock from
5149
5663
  # archived virtual tapes. When configured in compliance mode, the tape
5150
- # retention lock cannot be removed by any user, including the root AWS
5664
+ # retention lock cannot be removed by any user, including the root
5151
5665
  # account.
5152
5666
  # @return [String]
5153
5667
  #
@@ -5293,8 +5807,7 @@ module Aws::StorageGateway
5293
5807
  #
5294
5808
  # @!attribute [rw] gateway_arn
5295
5809
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5296
- # operation to return a list of gateways for your account and AWS
5297
- # Region.
5810
+ # operation to return a list of gateways for your account and Region.
5298
5811
  # @return [String]
5299
5812
  #
5300
5813
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ResetCacheInput AWS API Documentation
@@ -5307,8 +5820,7 @@ module Aws::StorageGateway
5307
5820
 
5308
5821
  # @!attribute [rw] gateway_arn
5309
5822
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5310
- # operation to return a list of gateways for your account and AWS
5311
- # Region.
5823
+ # operation to return a list of gateways for your account and Region.
5312
5824
  # @return [String]
5313
5825
  #
5314
5826
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ResetCacheOutput AWS API Documentation
@@ -5337,7 +5849,7 @@ module Aws::StorageGateway
5337
5849
  # @!attribute [rw] gateway_arn
5338
5850
  # The Amazon Resource Name (ARN) of the gateway you want to retrieve
5339
5851
  # the virtual tape to. Use the ListGateways operation to return a list
5340
- # of gateways for your account and AWS Region.
5852
+ # of gateways for your account and Region.
5341
5853
  #
5342
5854
  # You retrieve archived virtual tapes to only one gateway and the
5343
5855
  # gateway must be a tape gateway.
@@ -5383,8 +5895,7 @@ module Aws::StorageGateway
5383
5895
  #
5384
5896
  # @!attribute [rw] gateway_arn
5385
5897
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5386
- # operation to return a list of gateways for your account and AWS
5387
- # Region.
5898
+ # operation to return a list of gateways for your account and Region.
5388
5899
  # @return [String]
5389
5900
  #
5390
5901
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/RetrieveTapeRecoveryPointInput AWS API Documentation
@@ -5412,8 +5923,8 @@ module Aws::StorageGateway
5412
5923
  end
5413
5924
 
5414
5925
  # The Windows file permissions and ownership information assigned, by
5415
- # default, to native S3 objects when file gateway discovers them in S3
5416
- # buckets. This operation is only supported for file gateways.
5926
+ # default, to native S3 objects when S3 File Gateway discovers them in
5927
+ # S3 buckets. This operation is only supported for S3 File Gateways.
5417
5928
  #
5418
5929
  # @!attribute [rw] file_share_arn
5419
5930
  # The Amazon Resource Name (ARN) of the file share.
@@ -5431,13 +5942,12 @@ module Aws::StorageGateway
5431
5942
  #
5432
5943
  # @!attribute [rw] gateway_arn
5433
5944
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5434
- # operation to return a list of gateways for your account and AWS
5435
- # Region.
5945
+ # operation to return a list of gateways for your account and Region.
5436
5946
  # @return [String]
5437
5947
  #
5438
5948
  # @!attribute [rw] kms_encrypted
5439
5949
  # Set to `true` to use Amazon S3 server-side encryption with your own
5440
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
5950
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
5441
5951
  #
5442
5952
  # Valid Values: `true` \| `false`
5443
5953
  # @return [Boolean]
@@ -5455,8 +5965,8 @@ module Aws::StorageGateway
5455
5965
  # @return [String]
5456
5966
  #
5457
5967
  # @!attribute [rw] role
5458
- # The ARN of the IAM role that file gateway assumes when it accesses
5459
- # the underlying storage.
5968
+ # The ARN of the IAM role that an S3 File Gateway assumes when it
5969
+ # accesses the underlying storage.
5460
5970
  # @return [String]
5461
5971
  #
5462
5972
  # @!attribute [rw] location_arn
@@ -5466,8 +5976,8 @@ module Aws::StorageGateway
5466
5976
  #
5467
5977
  # @!attribute [rw] default_storage_class
5468
5978
  # The default storage class for objects put into an Amazon S3 bucket
5469
- # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
5470
- # Optional.
5979
+ # by the S3 File Gateway. The default value is
5980
+ # `S3_INTELLIGENT_TIERING`. Optional.
5471
5981
  #
5472
5982
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
5473
5983
  # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
@@ -5475,8 +5985,8 @@ module Aws::StorageGateway
5475
5985
  #
5476
5986
  # @!attribute [rw] object_acl
5477
5987
  # A value that sets the access control list (ACL) permission for
5478
- # objects in the S3 bucket that a file gateway puts objects into. The
5479
- # default value is `private`.
5988
+ # objects in the S3 bucket that an S3 File Gateway puts objects into.
5989
+ # The default value is `private`.
5480
5990
  # @return [String]
5481
5991
  #
5482
5992
  # @!attribute [rw] read_only
@@ -5519,8 +6029,7 @@ module Aws::StorageGateway
5519
6029
  # to the POSIX permission.
5520
6030
  #
5521
6031
  # For more information, see [Using Microsoft Windows ACLs to control
5522
- # access to an SMB file share][1] in the *AWS Storage Gateway User
5523
- # Guide*.
6032
+ # access to an SMB file share][1] in the *Storage Gateway User Guide*.
5524
6033
  #
5525
6034
  #
5526
6035
  #
@@ -5556,8 +6065,7 @@ module Aws::StorageGateway
5556
6065
  # @return [Array<String>]
5557
6066
  #
5558
6067
  # @!attribute [rw] audit_destination_arn
5559
- # The Amazon Resource Name (ARN) of the storage used for the audit
5560
- # logs.
6068
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
5561
6069
  # @return [String]
5562
6070
  #
5563
6071
  # @!attribute [rw] authentication
@@ -5591,13 +6099,68 @@ module Aws::StorageGateway
5591
6099
  # @return [String]
5592
6100
  #
5593
6101
  # @!attribute [rw] cache_attributes
5594
- # Refresh cache information.
6102
+ # Refresh cache information for the file share.
5595
6103
  # @return [Types::CacheAttributes]
5596
6104
  #
5597
6105
  # @!attribute [rw] notification_policy
5598
- # The notification policy of the file share.
6106
+ # The notification policy of the file share. `SettlingTimeInSeconds`
6107
+ # controls the number of seconds to wait after the last point in time
6108
+ # a client wrote to a file before generating an `ObjectUploaded`
6109
+ # notification. Because clients can make many small writes to files,
6110
+ # it's best to set this parameter for as long as possible to avoid
6111
+ # generating multiple notifications for the same file in a small time
6112
+ # period.
6113
+ #
6114
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
6115
+ # uploading to Amazon S3, only the timing of the notification.
6116
+ #
6117
+ # </note>
6118
+ #
6119
+ # The following example sets `NotificationPolicy` on with
6120
+ # `SettlingTimeInSeconds` set to 60.
6121
+ #
6122
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
6123
+ #
6124
+ # The following example sets `NotificationPolicy` off.
6125
+ #
6126
+ # `\{\}`
6127
+ # @return [String]
6128
+ #
6129
+ # @!attribute [rw] vpc_endpoint_dns_name
6130
+ # Specifies the DNS name for the VPC endpoint that the SMB file share
6131
+ # uses to connect to Amazon S3.
6132
+ #
6133
+ # <note markdown="1"> This parameter is required for SMB file shares that connect to
6134
+ # Amazon S3 through a VPC endpoint, a VPC access point, or an access
6135
+ # point alias that points to a VPC access point.
6136
+ #
6137
+ # </note>
6138
+ # @return [String]
6139
+ #
6140
+ # @!attribute [rw] bucket_region
6141
+ # Specifies the Region of the S3 bucket where the SMB file share
6142
+ # stores files.
6143
+ #
6144
+ # <note markdown="1"> This parameter is required for SMB file shares that connect to
6145
+ # Amazon S3 through a VPC endpoint, a VPC access point, or an access
6146
+ # point alias that points to a VPC access point.
6147
+ #
6148
+ # </note>
5599
6149
  # @return [String]
5600
6150
  #
6151
+ # @!attribute [rw] oplocks_enabled
6152
+ # Specifies whether opportunistic locking is enabled for the SMB file
6153
+ # share.
6154
+ #
6155
+ # <note markdown="1"> Enabling opportunistic locking on case-sensitive shares is not
6156
+ # recommended for workloads that involve access to files with the same
6157
+ # name in different case.
6158
+ #
6159
+ # </note>
6160
+ #
6161
+ # Valid Values: `true` \| `false`
6162
+ # @return [Boolean]
6163
+ #
5601
6164
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SMBFileShareInfo AWS API Documentation
5602
6165
  #
5603
6166
  class SMBFileShareInfo < Struct.new(
@@ -5626,7 +6189,10 @@ module Aws::StorageGateway
5626
6189
  :tags,
5627
6190
  :file_share_name,
5628
6191
  :cache_attributes,
5629
- :notification_policy)
6192
+ :notification_policy,
6193
+ :vpc_endpoint_dns_name,
6194
+ :bucket_region,
6195
+ :oplocks_enabled)
5630
6196
  SENSITIVE = []
5631
6197
  include Aws::Structure
5632
6198
  end
@@ -5664,8 +6230,7 @@ module Aws::StorageGateway
5664
6230
  #
5665
6231
  # @!attribute [rw] gateway_arn
5666
6232
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5667
- # operation to return a list of gateways for your account and AWS
5668
- # Region.
6233
+ # operation to return a list of gateways for your account and Region.
5669
6234
  # @return [String]
5670
6235
  #
5671
6236
  # @!attribute [rw] local_console_password
@@ -5683,8 +6248,7 @@ module Aws::StorageGateway
5683
6248
 
5684
6249
  # @!attribute [rw] gateway_arn
5685
6250
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5686
- # operation to return a list of gateways for your account and AWS
5687
- # Region.
6251
+ # operation to return a list of gateways for your account and Region.
5688
6252
  # @return [String]
5689
6253
  #
5690
6254
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SetLocalConsolePasswordOutput AWS API Documentation
@@ -5706,7 +6270,7 @@ module Aws::StorageGateway
5706
6270
  # }
5707
6271
  #
5708
6272
  # @!attribute [rw] gateway_arn
5709
- # The Amazon Resource Name (ARN) of the file gateway the SMB file
6273
+ # The Amazon Resource Name (ARN) of the S3 File Gateway the SMB file
5710
6274
  # share is associated with.
5711
6275
  # @return [String]
5712
6276
  #
@@ -5725,8 +6289,7 @@ module Aws::StorageGateway
5725
6289
 
5726
6290
  # @!attribute [rw] gateway_arn
5727
6291
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5728
- # operation to return a list of gateways for your account and AWS
5729
- # Region.
6292
+ # operation to return a list of gateways for your account and Region.
5730
6293
  # @return [String]
5731
6294
  #
5732
6295
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SetSMBGuestPasswordOutput AWS API Documentation
@@ -5749,8 +6312,7 @@ module Aws::StorageGateway
5749
6312
  #
5750
6313
  # @!attribute [rw] gateway_arn
5751
6314
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5752
- # operation to return a list of gateways for your account and AWS
5753
- # Region.
6315
+ # operation to return a list of gateways for your account and Region.
5754
6316
  # @return [String]
5755
6317
  #
5756
6318
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ShutdownGatewayInput AWS API Documentation
@@ -5766,8 +6328,7 @@ module Aws::StorageGateway
5766
6328
  #
5767
6329
  # @!attribute [rw] gateway_arn
5768
6330
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5769
- # operation to return a list of gateways for your account and AWS
5770
- # Region.
6331
+ # operation to return a list of gateways for your account and Region.
5771
6332
  # @return [String]
5772
6333
  #
5773
6334
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/ShutdownGatewayOutput AWS API Documentation
@@ -5787,8 +6348,7 @@ module Aws::StorageGateway
5787
6348
  #
5788
6349
  # @!attribute [rw] gateway_arn
5789
6350
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5790
- # operation to return a list of gateways for your account and AWS
5791
- # Region.
6351
+ # operation to return a list of gateways for your account and Region.
5792
6352
  # @return [String]
5793
6353
  #
5794
6354
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartAvailabilityMonitorTestInput AWS API Documentation
@@ -5801,8 +6361,7 @@ module Aws::StorageGateway
5801
6361
 
5802
6362
  # @!attribute [rw] gateway_arn
5803
6363
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5804
- # operation to return a list of gateways for your account and AWS
5805
- # Region.
6364
+ # operation to return a list of gateways for your account and Region.
5806
6365
  # @return [String]
5807
6366
  #
5808
6367
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartAvailabilityMonitorTestOutput AWS API Documentation
@@ -5825,8 +6384,7 @@ module Aws::StorageGateway
5825
6384
  #
5826
6385
  # @!attribute [rw] gateway_arn
5827
6386
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5828
- # operation to return a list of gateways for your account and AWS
5829
- # Region.
6387
+ # operation to return a list of gateways for your account and Region.
5830
6388
  # @return [String]
5831
6389
  #
5832
6390
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartGatewayInput AWS API Documentation
@@ -5842,8 +6400,7 @@ module Aws::StorageGateway
5842
6400
  #
5843
6401
  # @!attribute [rw] gateway_arn
5844
6402
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
5845
- # operation to return a list of gateways for your account and AWS
5846
- # Region.
6403
+ # operation to return a list of gateways for your account and Region.
5847
6404
  # @return [String]
5848
6405
  #
5849
6406
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/StartGatewayOutput AWS API Documentation
@@ -6241,8 +6798,7 @@ module Aws::StorageGateway
6241
6798
  #
6242
6799
  # @!attribute [rw] gateway_arn
6243
6800
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6244
- # operation to return a list of gateways for your account and AWS
6245
- # Region.
6801
+ # operation to return a list of gateways for your account and Region.
6246
6802
  # @return [String]
6247
6803
  #
6248
6804
  # @!attribute [rw] pool_id
@@ -6337,8 +6893,7 @@ module Aws::StorageGateway
6337
6893
  #
6338
6894
  # @!attribute [rw] gateway_arn
6339
6895
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6340
- # operation to return a list of gateways for your account and AWS
6341
- # Region.
6896
+ # operation to return a list of gateways for your account and Region.
6342
6897
  # @return [String]
6343
6898
  #
6344
6899
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicyInput AWS API Documentation
@@ -6352,8 +6907,7 @@ module Aws::StorageGateway
6352
6907
 
6353
6908
  # @!attribute [rw] gateway_arn
6354
6909
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6355
- # operation to return a list of gateways for your account and AWS
6356
- # Region.
6910
+ # operation to return a list of gateways for your account and Region.
6357
6911
  # @return [String]
6358
6912
  #
6359
6913
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateAutomaticTapeCreationPolicyOutput AWS API Documentation
@@ -6381,8 +6935,7 @@ module Aws::StorageGateway
6381
6935
  #
6382
6936
  # @!attribute [rw] gateway_arn
6383
6937
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6384
- # operation to return a list of gateways for your account and AWS
6385
- # Region.
6938
+ # operation to return a list of gateways for your account and Region.
6386
6939
  # @return [String]
6387
6940
  #
6388
6941
  # @!attribute [rw] average_upload_rate_limit_in_bits_per_sec
@@ -6408,8 +6961,7 @@ module Aws::StorageGateway
6408
6961
  #
6409
6962
  # @!attribute [rw] gateway_arn
6410
6963
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6411
- # operation to return a list of gateways for your account and AWS
6412
- # Region.
6964
+ # operation to return a list of gateways for your account and Region.
6413
6965
  # @return [String]
6414
6966
  #
6415
6967
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateBandwidthRateLimitOutput AWS API Documentation
@@ -6440,8 +6992,7 @@ module Aws::StorageGateway
6440
6992
  #
6441
6993
  # @!attribute [rw] gateway_arn
6442
6994
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6443
- # operation to return a list of gateways for your account and AWS
6444
- # Region.
6995
+ # operation to return a list of gateways for your account and Region.
6445
6996
  # @return [String]
6446
6997
  #
6447
6998
  # @!attribute [rw] bandwidth_rate_limit_intervals
@@ -6461,8 +7012,7 @@ module Aws::StorageGateway
6461
7012
 
6462
7013
  # @!attribute [rw] gateway_arn
6463
7014
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6464
- # operation to return a list of gateways for your account and AWS
6465
- # Region.
7015
+ # operation to return a list of gateways for your account and Region.
6466
7016
  # @return [String]
6467
7017
  #
6468
7018
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateBandwidthRateLimitScheduleOutput AWS API Documentation
@@ -6557,6 +7107,68 @@ module Aws::StorageGateway
6557
7107
  include Aws::Structure
6558
7108
  end
6559
7109
 
7110
+ # @note When making an API call, you may pass UpdateFileSystemAssociationInput
7111
+ # data as a hash:
7112
+ #
7113
+ # {
7114
+ # file_system_association_arn: "FileSystemAssociationARN", # required
7115
+ # user_name: "DomainUserName",
7116
+ # password: "DomainUserPassword",
7117
+ # audit_destination_arn: "AuditDestinationARN",
7118
+ # cache_attributes: {
7119
+ # cache_stale_timeout_in_seconds: 1,
7120
+ # },
7121
+ # }
7122
+ #
7123
+ # @!attribute [rw] file_system_association_arn
7124
+ # The Amazon Resource Name (ARN) of the file system association that
7125
+ # you want to update.
7126
+ # @return [String]
7127
+ #
7128
+ # @!attribute [rw] user_name
7129
+ # The user name of the user credential that has permission to access
7130
+ # the root share D$ of the Amazon FSx file system. The user account
7131
+ # must belong to the Amazon FSx delegated admin user group.
7132
+ # @return [String]
7133
+ #
7134
+ # @!attribute [rw] password
7135
+ # The password of the user credential.
7136
+ # @return [String]
7137
+ #
7138
+ # @!attribute [rw] audit_destination_arn
7139
+ # The Amazon Resource Name (ARN) of the storage used for the audit
7140
+ # logs.
7141
+ # @return [String]
7142
+ #
7143
+ # @!attribute [rw] cache_attributes
7144
+ # The refresh cache information for the file share or FSx file
7145
+ # systems.
7146
+ # @return [Types::CacheAttributes]
7147
+ #
7148
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateFileSystemAssociationInput AWS API Documentation
7149
+ #
7150
+ class UpdateFileSystemAssociationInput < Struct.new(
7151
+ :file_system_association_arn,
7152
+ :user_name,
7153
+ :password,
7154
+ :audit_destination_arn,
7155
+ :cache_attributes)
7156
+ SENSITIVE = [:password]
7157
+ include Aws::Structure
7158
+ end
7159
+
7160
+ # @!attribute [rw] file_system_association_arn
7161
+ # The ARN of the updated file system association.
7162
+ # @return [String]
7163
+ #
7164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateFileSystemAssociationOutput AWS API Documentation
7165
+ #
7166
+ class UpdateFileSystemAssociationOutput < Struct.new(
7167
+ :file_system_association_arn)
7168
+ SENSITIVE = []
7169
+ include Aws::Structure
7170
+ end
7171
+
6560
7172
  # @note When making an API call, you may pass UpdateGatewayInformationInput
6561
7173
  # data as a hash:
6562
7174
  #
@@ -6565,12 +7177,12 @@ module Aws::StorageGateway
6565
7177
  # gateway_name: "GatewayName",
6566
7178
  # gateway_timezone: "GatewayTimezone",
6567
7179
  # cloud_watch_log_group_arn: "CloudWatchLogGroupARN",
7180
+ # gateway_capacity: "Small", # accepts Small, Medium, Large
6568
7181
  # }
6569
7182
  #
6570
7183
  # @!attribute [rw] gateway_arn
6571
7184
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6572
- # operation to return a list of gateways for your account and AWS
6573
- # Region.
7185
+ # operation to return a list of gateways for your account and Region.
6574
7186
  # @return [String]
6575
7187
  #
6576
7188
  # @!attribute [rw] gateway_name
@@ -6592,13 +7204,18 @@ module Aws::StorageGateway
6592
7204
  # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html
6593
7205
  # @return [String]
6594
7206
  #
7207
+ # @!attribute [rw] gateway_capacity
7208
+ # Specifies the size of the gateway's metadata cache.
7209
+ # @return [String]
7210
+ #
6595
7211
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateGatewayInformationInput AWS API Documentation
6596
7212
  #
6597
7213
  class UpdateGatewayInformationInput < Struct.new(
6598
7214
  :gateway_arn,
6599
7215
  :gateway_name,
6600
7216
  :gateway_timezone,
6601
- :cloud_watch_log_group_arn)
7217
+ :cloud_watch_log_group_arn,
7218
+ :gateway_capacity)
6602
7219
  SENSITIVE = []
6603
7220
  include Aws::Structure
6604
7221
  end
@@ -6608,8 +7225,7 @@ module Aws::StorageGateway
6608
7225
  #
6609
7226
  # @!attribute [rw] gateway_arn
6610
7227
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6611
- # operation to return a list of gateways for your account and AWS
6612
- # Region.
7228
+ # operation to return a list of gateways for your account and Region.
6613
7229
  # @return [String]
6614
7230
  #
6615
7231
  # @!attribute [rw] gateway_name
@@ -6637,8 +7253,7 @@ module Aws::StorageGateway
6637
7253
  #
6638
7254
  # @!attribute [rw] gateway_arn
6639
7255
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6640
- # operation to return a list of gateways for your account and AWS
6641
- # Region.
7256
+ # operation to return a list of gateways for your account and Region.
6642
7257
  # @return [String]
6643
7258
  #
6644
7259
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateGatewaySoftwareNowInput AWS API Documentation
@@ -6654,8 +7269,7 @@ module Aws::StorageGateway
6654
7269
  #
6655
7270
  # @!attribute [rw] gateway_arn
6656
7271
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6657
- # operation to return a list of gateways for your account and AWS
6658
- # Region.
7272
+ # operation to return a list of gateways for your account and Region.
6659
7273
  # @return [String]
6660
7274
  #
6661
7275
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateGatewaySoftwareNowOutput AWS API Documentation
@@ -6689,8 +7303,7 @@ module Aws::StorageGateway
6689
7303
  #
6690
7304
  # @!attribute [rw] gateway_arn
6691
7305
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6692
- # operation to return a list of gateways for your account and AWS
6693
- # Region.
7306
+ # operation to return a list of gateways for your account and Region.
6694
7307
  # @return [String]
6695
7308
  #
6696
7309
  # @!attribute [rw] hour_of_day
@@ -6735,8 +7348,7 @@ module Aws::StorageGateway
6735
7348
  #
6736
7349
  # @!attribute [rw] gateway_arn
6737
7350
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
6738
- # operation to return a list of gateways for your account and AWS
6739
- # Region.
7351
+ # operation to return a list of gateways for your account and Region.
6740
7352
  # @return [String]
6741
7353
  #
6742
7354
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateMaintenanceStartTimeOutput AWS API Documentation
@@ -6782,7 +7394,7 @@ module Aws::StorageGateway
6782
7394
  #
6783
7395
  # @!attribute [rw] kms_encrypted
6784
7396
  # Set to `true` to use Amazon S3 server-side encryption with your own
6785
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
7397
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
6786
7398
  #
6787
7399
  # Valid Values: `true` \| `false`
6788
7400
  # @return [Boolean]
@@ -6800,8 +7412,8 @@ module Aws::StorageGateway
6800
7412
  #
6801
7413
  # @!attribute [rw] default_storage_class
6802
7414
  # The default storage class for objects put into an Amazon S3 bucket
6803
- # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
6804
- # Optional.
7415
+ # by the S3 File Gateway. The default value is
7416
+ # `S3_INTELLIGENT_TIERING`. Optional.
6805
7417
  #
6806
7418
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
6807
7419
  # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
@@ -6809,13 +7421,14 @@ module Aws::StorageGateway
6809
7421
  #
6810
7422
  # @!attribute [rw] object_acl
6811
7423
  # A value that sets the access control list (ACL) permission for
6812
- # objects in the S3 bucket that a file gateway puts objects into. The
6813
- # default value is `private`.
7424
+ # objects in the S3 bucket that a S3 File Gateway puts objects into.
7425
+ # The default value is `private`.
6814
7426
  # @return [String]
6815
7427
  #
6816
7428
  # @!attribute [rw] client_list
6817
- # The list of clients that are allowed to access the file gateway. The
6818
- # list must contain either valid IP addresses or valid CIDR blocks.
7429
+ # The list of clients that are allowed to access the S3 File Gateway.
7430
+ # The list must contain either valid IP addresses or valid CIDR
7431
+ # blocks.
6819
7432
  # @return [Array<String>]
6820
7433
  #
6821
7434
  # @!attribute [rw] squash
@@ -6873,11 +7486,31 @@ module Aws::StorageGateway
6873
7486
  # @return [String]
6874
7487
  #
6875
7488
  # @!attribute [rw] cache_attributes
6876
- # Refresh cache information.
7489
+ # specifies refresh cache information for the file share.
6877
7490
  # @return [Types::CacheAttributes]
6878
7491
  #
6879
7492
  # @!attribute [rw] notification_policy
6880
- # The notification policy of the file share.
7493
+ # The notification policy of the file share. `SettlingTimeInSeconds`
7494
+ # controls the number of seconds to wait after the last point in time
7495
+ # a client wrote to a file before generating an `ObjectUploaded`
7496
+ # notification. Because clients can make many small writes to files,
7497
+ # it's best to set this parameter for as long as possible to avoid
7498
+ # generating multiple notifications for the same file in a small time
7499
+ # period.
7500
+ #
7501
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
7502
+ # uploading to Amazon S3, only the timing of the notification.
7503
+ #
7504
+ # </note>
7505
+ #
7506
+ # The following example sets `NotificationPolicy` on with
7507
+ # `SettlingTimeInSeconds` set to 60.
7508
+ #
7509
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
7510
+ #
7511
+ # The following example sets `NotificationPolicy` off.
7512
+ #
7513
+ # `\{\}`
6881
7514
  # @return [String]
6882
7515
  #
6883
7516
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateNFSFileShareInput AWS API Documentation
@@ -6931,9 +7564,9 @@ module Aws::StorageGateway
6931
7564
  # requester_pays: false,
6932
7565
  # smbacl_enabled: false,
6933
7566
  # access_based_enumeration: false,
6934
- # admin_user_list: ["FileShareUser"],
6935
- # valid_user_list: ["FileShareUser"],
6936
- # invalid_user_list: ["FileShareUser"],
7567
+ # admin_user_list: ["UserListUser"],
7568
+ # valid_user_list: ["UserListUser"],
7569
+ # invalid_user_list: ["UserListUser"],
6937
7570
  # audit_destination_arn: "AuditDestinationARN",
6938
7571
  # case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
6939
7572
  # file_share_name: "FileShareName",
@@ -6941,6 +7574,7 @@ module Aws::StorageGateway
6941
7574
  # cache_stale_timeout_in_seconds: 1,
6942
7575
  # },
6943
7576
  # notification_policy: "NotificationPolicy",
7577
+ # oplocks_enabled: false,
6944
7578
  # }
6945
7579
  #
6946
7580
  # @!attribute [rw] file_share_arn
@@ -6950,7 +7584,7 @@ module Aws::StorageGateway
6950
7584
  #
6951
7585
  # @!attribute [rw] kms_encrypted
6952
7586
  # Set to `true` to use Amazon S3 server-side encryption with your own
6953
- # AWS KMS key, or `false` to use a key managed by Amazon S3. Optional.
7587
+ # KMS key, or `false` to use a key managed by Amazon S3. Optional.
6954
7588
  #
6955
7589
  # Valid Values: `true` \| `false`
6956
7590
  # @return [Boolean]
@@ -6964,8 +7598,8 @@ module Aws::StorageGateway
6964
7598
  #
6965
7599
  # @!attribute [rw] default_storage_class
6966
7600
  # The default storage class for objects put into an Amazon S3 bucket
6967
- # by the file gateway. The default value is `S3_INTELLIGENT_TIERING`.
6968
- # Optional.
7601
+ # by the S3 File Gateway. The default value is
7602
+ # `S3_INTELLIGENT_TIERING`. Optional.
6969
7603
  #
6970
7604
  # Valid Values: `S3_STANDARD` \| `S3_INTELLIGENT_TIERING` \|
6971
7605
  # `S3_STANDARD_IA` \| `S3_ONEZONE_IA`
@@ -6973,8 +7607,8 @@ module Aws::StorageGateway
6973
7607
  #
6974
7608
  # @!attribute [rw] object_acl
6975
7609
  # A value that sets the access control list (ACL) permission for
6976
- # objects in the S3 bucket that a file gateway puts objects into. The
6977
- # default value is `private`.
7610
+ # objects in the S3 bucket that a S3 File Gateway puts objects into.
7611
+ # The default value is `private`.
6978
7612
  # @return [String]
6979
7613
  #
6980
7614
  # @!attribute [rw] read_only
@@ -7016,8 +7650,7 @@ module Aws::StorageGateway
7016
7650
  # permissions to the POSIX permissions.
7017
7651
  #
7018
7652
  # For more information, see [Using Microsoft Windows ACLs to control
7019
- # access to an SMB file share][1] in the *AWS Storage Gateway User
7020
- # Guide*.
7653
+ # access to an SMB file share][1] in the *Storage Gateway User Guide*.
7021
7654
  #
7022
7655
  # Valid Values: `true` \| `false`
7023
7656
  #
@@ -7056,8 +7689,7 @@ module Aws::StorageGateway
7056
7689
  # @return [Array<String>]
7057
7690
  #
7058
7691
  # @!attribute [rw] audit_destination_arn
7059
- # The Amazon Resource Name (ARN) of the storage used for the audit
7060
- # logs.
7692
+ # The Amazon Resource Name (ARN) of the storage used for audit logs.
7061
7693
  # @return [String]
7062
7694
  #
7063
7695
  # @!attribute [rw] case_sensitivity
@@ -7077,13 +7709,46 @@ module Aws::StorageGateway
7077
7709
  # @return [String]
7078
7710
  #
7079
7711
  # @!attribute [rw] cache_attributes
7080
- # Refresh cache information.
7712
+ # Specifies refresh cache information for the file share.
7081
7713
  # @return [Types::CacheAttributes]
7082
7714
  #
7083
7715
  # @!attribute [rw] notification_policy
7084
- # The notification policy of the file share.
7716
+ # The notification policy of the file share. `SettlingTimeInSeconds`
7717
+ # controls the number of seconds to wait after the last point in time
7718
+ # a client wrote to a file before generating an `ObjectUploaded`
7719
+ # notification. Because clients can make many small writes to files,
7720
+ # it's best to set this parameter for as long as possible to avoid
7721
+ # generating multiple notifications for the same file in a small time
7722
+ # period.
7723
+ #
7724
+ # <note markdown="1"> `SettlingTimeInSeconds` has no effect on the timing of the object
7725
+ # uploading to Amazon S3, only the timing of the notification.
7726
+ #
7727
+ # </note>
7728
+ #
7729
+ # The following example sets `NotificationPolicy` on with
7730
+ # `SettlingTimeInSeconds` set to 60.
7731
+ #
7732
+ # `\{"Upload": \{"SettlingTimeInSeconds": 60\}\}`
7733
+ #
7734
+ # The following example sets `NotificationPolicy` off.
7735
+ #
7736
+ # `\{\}`
7085
7737
  # @return [String]
7086
7738
  #
7739
+ # @!attribute [rw] oplocks_enabled
7740
+ # Specifies whether opportunistic locking is enabled for the SMB file
7741
+ # share.
7742
+ #
7743
+ # <note markdown="1"> Enabling opportunistic locking on case-sensitive shares is not
7744
+ # recommended for workloads that involve access to files with the same
7745
+ # name in different case.
7746
+ #
7747
+ # </note>
7748
+ #
7749
+ # Valid Values: `true` \| `false`
7750
+ # @return [Boolean]
7751
+ #
7087
7752
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBFileShareInput AWS API Documentation
7088
7753
  #
7089
7754
  class UpdateSMBFileShareInput < Struct.new(
@@ -7104,7 +7769,8 @@ module Aws::StorageGateway
7104
7769
  :case_sensitivity,
7105
7770
  :file_share_name,
7106
7771
  :cache_attributes,
7107
- :notification_policy)
7772
+ :notification_policy,
7773
+ :oplocks_enabled)
7108
7774
  SENSITIVE = []
7109
7775
  include Aws::Structure
7110
7776
  end
@@ -7133,8 +7799,7 @@ module Aws::StorageGateway
7133
7799
  #
7134
7800
  # @!attribute [rw] gateway_arn
7135
7801
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
7136
- # operation to return a list of gateways for your account and AWS
7137
- # Region.
7802
+ # operation to return a list of gateways for your account and Region.
7138
7803
  # @return [String]
7139
7804
  #
7140
7805
  # @!attribute [rw] file_shares_visible
@@ -7152,8 +7817,7 @@ module Aws::StorageGateway
7152
7817
 
7153
7818
  # @!attribute [rw] gateway_arn
7154
7819
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
7155
- # operation to return a list of gateways for your account and AWS
7156
- # Region.
7820
+ # operation to return a list of gateways for your account and Region.
7157
7821
  # @return [String]
7158
7822
  #
7159
7823
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBFileShareVisibilityOutput AWS API Documentation
@@ -7174,8 +7838,7 @@ module Aws::StorageGateway
7174
7838
  #
7175
7839
  # @!attribute [rw] gateway_arn
7176
7840
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
7177
- # operation to return a list of gateways for your account and AWS
7178
- # Region.
7841
+ # operation to return a list of gateways for your account and Region.
7179
7842
  # @return [String]
7180
7843
  #
7181
7844
  # @!attribute [rw] smb_security_strategy
@@ -7184,7 +7847,7 @@ module Aws::StorageGateway
7184
7847
  # ClientSpecified: if you use this option, requests are established
7185
7848
  # based on what is negotiated by the client. This option is
7186
7849
  # recommended when you want to maximize compatibility across different
7187
- # clients in your environment.
7850
+ # clients in your environment. Supported only in S3 File Gateway.
7188
7851
  #
7189
7852
  # MandatorySigning: if you use this option, file gateway only allows
7190
7853
  # connections from SMBv2 or SMBv3 clients that have signing enabled.
@@ -7209,8 +7872,7 @@ module Aws::StorageGateway
7209
7872
 
7210
7873
  # @!attribute [rw] gateway_arn
7211
7874
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
7212
- # operation to return a list of gateways for your account and AWS
7213
- # Region.
7875
+ # operation to return a list of gateways for your account and Region.
7214
7876
  # @return [String]
7215
7877
  #
7216
7878
  # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBSecurityStrategyOutput AWS API Documentation
@@ -7410,8 +8072,7 @@ module Aws::StorageGateway
7410
8072
  #
7411
8073
  # @!attribute [rw] gateway_arn
7412
8074
  # The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
7413
- # operation to return a list of gateways for your account and AWS
7414
- # Region.
8075
+ # operation to return a list of gateways for your account and Region.
7415
8076
  # @return [String]
7416
8077
  #
7417
8078
  # @!attribute [rw] gateway_id