aws-sdk-efs 1.8.0 → 1.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-efs.rb +1 -1
- data/lib/aws-sdk-efs/client.rb +93 -52
- data/lib/aws-sdk-efs/client_api.rb +2 -0
- data/lib/aws-sdk-efs/types.rb +91 -69
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cc9569c24b39a000de80da163573d0a579c82b21
|
4
|
+
data.tar.gz: 1779d55de03cdcfc0a41a465b2de9c5d409d80ab
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3fe6362c0026ad439135812cbc29595ecd973dab6f192842e9ec13f0169844a6a7ccacf44105030f9dc56b1593712b5c704e8459d5185c947f040687b7450d5a
|
7
|
+
data.tar.gz: bef0879073122eaa71970a9a96a22dbeecb441b2b4642617552994b903ecb0cc644ef60139b9e590999eb6e68efcacd74f1dfc563a676715a50666f35f3d8cb0
|
data/lib/aws-sdk-efs.rb
CHANGED
data/lib/aws-sdk-efs/client.rb
CHANGED
@@ -262,24 +262,24 @@ module Aws::EFS
|
|
262
262
|
#
|
263
263
|
#
|
264
264
|
#
|
265
|
-
# [1]:
|
266
|
-
# [2]:
|
265
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html
|
266
|
+
# [2]: https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html
|
267
267
|
#
|
268
268
|
# @option params [required, String] :creation_token
|
269
|
-
#
|
269
|
+
# A string of up to 64 ASCII characters. Amazon EFS uses this to ensure
|
270
270
|
# idempotent creation.
|
271
271
|
#
|
272
272
|
# @option params [String] :performance_mode
|
273
|
-
# The
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
273
|
+
# The performance mode of the file system. We recommend `generalPurpose`
|
274
|
+
# performance mode for most file systems. File systems using the `maxIO`
|
275
|
+
# performance mode can scale to higher levels of aggregate throughput
|
276
|
+
# and operations per second with a tradeoff of slightly higher latencies
|
277
|
+
# for most file operations. The performance mode can't be changed after
|
278
|
+
# the file system has been created.
|
279
279
|
#
|
280
280
|
# @option params [Boolean] :encrypted
|
281
281
|
# A Boolean value that, if true, creates an encrypted file system. When
|
282
|
-
# creating an encrypted file system, you have the option of specifying
|
282
|
+
# creating an encrypted file system, you have the option of specifying
|
283
283
|
# CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management
|
284
284
|
# Service (AWS KMS) customer master key (CMK). If you don't specify a
|
285
285
|
# CMK, then the default CMK for Amazon EFS, `/aws/elasticfilesystem`, is
|
@@ -288,23 +288,23 @@ module Aws::EFS
|
|
288
288
|
# @option params [String] :kms_key_id
|
289
289
|
# The ID of the AWS KMS CMK to be used to protect the encrypted file
|
290
290
|
# system. This parameter is only required if you want to use a
|
291
|
-
#
|
291
|
+
# nondefault CMK. If this parameter is not specified, the default CMK
|
292
292
|
# for Amazon EFS is used. This ID can be in one of the following
|
293
293
|
# formats:
|
294
294
|
#
|
295
|
-
# * Key ID - A unique identifier of the key, for example
|
295
|
+
# * Key ID - A unique identifier of the key, for example
|
296
296
|
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
297
297
|
#
|
298
|
-
# * ARN - An Amazon Resource Name (ARN) for the key, for example
|
298
|
+
# * ARN - An Amazon Resource Name (ARN) for the key, for example
|
299
299
|
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
300
300
|
#
|
301
|
-
# * Key alias - A previously created display name for a key
|
302
|
-
#
|
301
|
+
# * Key alias - A previously created display name for a key, for example
|
302
|
+
# `alias/projectKey1`.
|
303
303
|
#
|
304
|
-
# * Key alias ARN - An ARN for a key alias, for example
|
304
|
+
# * Key alias ARN - An ARN for a key alias, for example
|
305
305
|
# `arn:aws:kms:us-west-2:444455556666:alias/projectKey1`.
|
306
306
|
#
|
307
|
-
# If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted
|
307
|
+
# If `KmsKeyId` is specified, the CreateFileSystemRequest$Encrypted
|
308
308
|
# parameter must be set to true.
|
309
309
|
#
|
310
310
|
# @option params [String] :throughput_mode
|
@@ -324,7 +324,13 @@ module Aws::EFS
|
|
324
324
|
#
|
325
325
|
#
|
326
326
|
#
|
327
|
-
# [1]:
|
327
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits
|
328
|
+
#
|
329
|
+
# @option params [Array<Types::Tag>] :tags
|
330
|
+
# A value that specifies to create one or more tags associated with the
|
331
|
+
# file system. Each tag is a user-defined key-value pair. Name your file
|
332
|
+
# system on creation by including a `"Key":"Name","Value":"\{value\}"`
|
333
|
+
# key-value pair.
|
328
334
|
#
|
329
335
|
# @return [Types::FileSystemDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
330
336
|
#
|
@@ -341,6 +347,7 @@ module Aws::EFS
|
|
341
347
|
# * {Types::FileSystemDescription#kms_key_id #kms_key_id} => String
|
342
348
|
# * {Types::FileSystemDescription#throughput_mode #throughput_mode} => String
|
343
349
|
# * {Types::FileSystemDescription#provisioned_throughput_in_mibps #provisioned_throughput_in_mibps} => Float
|
350
|
+
# * {Types::FileSystemDescription#tags #tags} => Array<Types::Tag>
|
344
351
|
#
|
345
352
|
#
|
346
353
|
# @example Example: To create a new file system
|
@@ -350,6 +357,12 @@ module Aws::EFS
|
|
350
357
|
# resp = client.create_file_system({
|
351
358
|
# creation_token: "tokenstring",
|
352
359
|
# performance_mode: "generalPurpose",
|
360
|
+
# tags: [
|
361
|
+
# {
|
362
|
+
# key: "Name",
|
363
|
+
# value: "MyFileSystem",
|
364
|
+
# },
|
365
|
+
# ],
|
353
366
|
# })
|
354
367
|
#
|
355
368
|
# resp.to_h outputs the following:
|
@@ -364,6 +377,12 @@ module Aws::EFS
|
|
364
377
|
# size_in_bytes: {
|
365
378
|
# value: 0,
|
366
379
|
# },
|
380
|
+
# tags: [
|
381
|
+
# {
|
382
|
+
# key: "Name",
|
383
|
+
# value: "MyFileSystem",
|
384
|
+
# },
|
385
|
+
# ],
|
367
386
|
# }
|
368
387
|
#
|
369
388
|
# @example Request syntax with placeholder values
|
@@ -375,6 +394,12 @@ module Aws::EFS
|
|
375
394
|
# kms_key_id: "KmsKeyId",
|
376
395
|
# throughput_mode: "bursting", # accepts bursting, provisioned
|
377
396
|
# provisioned_throughput_in_mibps: 1.0,
|
397
|
+
# tags: [
|
398
|
+
# {
|
399
|
+
# key: "TagKey", # required
|
400
|
+
# value: "TagValue", # required
|
401
|
+
# },
|
402
|
+
# ],
|
378
403
|
# })
|
379
404
|
#
|
380
405
|
# @example Response structure
|
@@ -395,6 +420,9 @@ module Aws::EFS
|
|
395
420
|
# resp.kms_key_id #=> String
|
396
421
|
# resp.throughput_mode #=> String, one of "bursting", "provisioned"
|
397
422
|
# resp.provisioned_throughput_in_mibps #=> Float
|
423
|
+
# resp.tags #=> Array
|
424
|
+
# resp.tags[0].key #=> String
|
425
|
+
# resp.tags[0].value #=> String
|
398
426
|
#
|
399
427
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystem AWS API Documentation
|
400
428
|
#
|
@@ -496,8 +524,7 @@ module Aws::EFS
|
|
496
524
|
# In addition, by always using a mount target local to the instance's
|
497
525
|
# Availability Zone, you eliminate a partial failure scenario. If the
|
498
526
|
# Availability Zone in which your mount target is created goes down,
|
499
|
-
# then you
|
500
|
-
# target.
|
527
|
+
# then you can't access your file system through that mount target.
|
501
528
|
#
|
502
529
|
# This operation requires permissions for the following action on the
|
503
530
|
# file system:
|
@@ -517,15 +544,15 @@ module Aws::EFS
|
|
517
544
|
#
|
518
545
|
#
|
519
546
|
#
|
520
|
-
# [1]:
|
521
|
-
# [2]:
|
547
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html
|
548
|
+
# [2]: https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation
|
522
549
|
# [3]: http://aws.amazon.com/efs/
|
523
550
|
#
|
524
551
|
# @option params [required, String] :file_system_id
|
525
|
-
# ID of the file system for which to create the mount target.
|
552
|
+
# The ID of the file system for which to create the mount target.
|
526
553
|
#
|
527
554
|
# @option params [required, String] :subnet_id
|
528
|
-
# ID of the subnet to add the mount target in.
|
555
|
+
# The ID of the subnet to add the mount target in.
|
529
556
|
#
|
530
557
|
# @option params [String] :ip_address
|
531
558
|
# Valid IPv4 address within the address range of the specified subnet.
|
@@ -604,11 +631,12 @@ module Aws::EFS
|
|
604
631
|
# `elasticfilesystem:CreateTags` action.
|
605
632
|
#
|
606
633
|
# @option params [required, String] :file_system_id
|
607
|
-
# ID of the file system whose tags you want to modify (String). This
|
634
|
+
# The ID of the file system whose tags you want to modify (String). This
|
608
635
|
# operation modifies the tags only, not the file system.
|
609
636
|
#
|
610
637
|
# @option params [required, Array<Types::Tag>] :tags
|
611
|
-
#
|
638
|
+
# An array of `Tag` objects to add. Each `Tag` object is a key-value
|
639
|
+
# pair.
|
612
640
|
#
|
613
641
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
614
642
|
#
|
@@ -669,7 +697,7 @@ module Aws::EFS
|
|
669
697
|
# `elasticfilesystem:DeleteFileSystem` action.
|
670
698
|
#
|
671
699
|
# @option params [required, String] :file_system_id
|
672
|
-
# ID of the file system you want to delete.
|
700
|
+
# The ID of the file system you want to delete.
|
673
701
|
#
|
674
702
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
675
703
|
#
|
@@ -731,7 +759,7 @@ module Aws::EFS
|
|
731
759
|
# ^
|
732
760
|
#
|
733
761
|
# @option params [required, String] :mount_target_id
|
734
|
-
# ID of the mount target to delete (String).
|
762
|
+
# The ID of the mount target to delete (String).
|
735
763
|
#
|
736
764
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
737
765
|
#
|
@@ -760,7 +788,7 @@ module Aws::EFS
|
|
760
788
|
end
|
761
789
|
|
762
790
|
# Deletes the specified tags from a file system. If the `DeleteTags`
|
763
|
-
# request includes a tag key that
|
791
|
+
# request includes a tag key that doesn't exist, Amazon EFS ignores it
|
764
792
|
# and doesn't cause an error. For more information about tags and
|
765
793
|
# related restrictions, see [Tag Restrictions][1] in the *AWS Billing
|
766
794
|
# and Cost Management User Guide*.
|
@@ -770,13 +798,13 @@ module Aws::EFS
|
|
770
798
|
#
|
771
799
|
#
|
772
800
|
#
|
773
|
-
# [1]:
|
801
|
+
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
774
802
|
#
|
775
803
|
# @option params [required, String] :file_system_id
|
776
|
-
# ID of the file system whose tags you want to delete (String).
|
804
|
+
# The ID of the file system whose tags you want to delete (String).
|
777
805
|
#
|
778
806
|
# @option params [required, Array<String>] :tag_keys
|
779
|
-
#
|
807
|
+
# A list of tag keys to delete.
|
780
808
|
#
|
781
809
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
782
810
|
#
|
@@ -883,6 +911,12 @@ module Aws::EFS
|
|
883
911
|
# size_in_bytes: {
|
884
912
|
# value: 6144,
|
885
913
|
# },
|
914
|
+
# tags: [
|
915
|
+
# {
|
916
|
+
# key: "Name",
|
917
|
+
# value: "MyFileSystem",
|
918
|
+
# },
|
919
|
+
# ],
|
886
920
|
# },
|
887
921
|
# ],
|
888
922
|
# }
|
@@ -916,6 +950,9 @@ module Aws::EFS
|
|
916
950
|
# resp.file_systems[0].kms_key_id #=> String
|
917
951
|
# resp.file_systems[0].throughput_mode #=> String, one of "bursting", "provisioned"
|
918
952
|
# resp.file_systems[0].provisioned_throughput_in_mibps #=> Float
|
953
|
+
# resp.file_systems[0].tags #=> Array
|
954
|
+
# resp.file_systems[0].tags[0].key #=> String
|
955
|
+
# resp.file_systems[0].tags[0].value #=> String
|
919
956
|
# resp.next_marker #=> String
|
920
957
|
#
|
921
958
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystems AWS API Documentation
|
@@ -929,10 +966,10 @@ module Aws::EFS
|
|
929
966
|
|
930
967
|
# Returns the current `LifecycleConfiguration` object for the specified
|
931
968
|
# Amazon EFS file system. EFS lifecycle management uses the
|
932
|
-
# `LifecycleConfiguration` to identify which files to move to the
|
933
|
-
# Infrequent Access (IA) storage class. For a file system without a
|
934
|
-
# `LifecycleConfiguration
|
935
|
-
# response.
|
969
|
+
# `LifecycleConfiguration` object to identify which files to move to the
|
970
|
+
# EFS Infrequent Access (IA) storage class. For a file system without a
|
971
|
+
# `LifecycleConfiguration` object, the call returns an empty array in
|
972
|
+
# the response.
|
936
973
|
#
|
937
974
|
# This operation requires permissions for the
|
938
975
|
# `elasticfilesystem:DescribeLifecycleConfiguration` operation.
|
@@ -979,7 +1016,7 @@ module Aws::EFS
|
|
979
1016
|
# target's network interface.
|
980
1017
|
#
|
981
1018
|
# @option params [required, String] :mount_target_id
|
982
|
-
# ID of the mount target whose security groups you want to retrieve.
|
1019
|
+
# The ID of the mount target whose security groups you want to retrieve.
|
983
1020
|
#
|
984
1021
|
# @return [Types::DescribeMountTargetSecurityGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
985
1022
|
#
|
@@ -1113,23 +1150,23 @@ module Aws::EFS
|
|
1113
1150
|
|
1114
1151
|
# Returns the tags associated with a file system. The order of tags
|
1115
1152
|
# returned in the response of one `DescribeTags` call and the order of
|
1116
|
-
# tags returned across the responses of a
|
1153
|
+
# tags returned across the responses of a multiple-call iteration (when
|
1117
1154
|
# using pagination) is unspecified.
|
1118
1155
|
#
|
1119
1156
|
# This operation requires permissions for the
|
1120
1157
|
# `elasticfilesystem:DescribeTags` action.
|
1121
1158
|
#
|
1122
1159
|
# @option params [Integer] :max_items
|
1123
|
-
# (Optional)
|
1160
|
+
# (Optional) The maximum number of file system tags to return in the
|
1124
1161
|
# response. Currently, this number is automatically set to 10.
|
1125
1162
|
#
|
1126
1163
|
# @option params [String] :marker
|
1127
|
-
# (Optional)
|
1164
|
+
# (Optional) An opaque pagination token returned from a previous
|
1128
1165
|
# `DescribeTags` operation (String). If present, it specifies to
|
1129
1166
|
# continue the list from where the previous call left off.
|
1130
1167
|
#
|
1131
1168
|
# @option params [required, String] :file_system_id
|
1132
|
-
# ID of the file system whose tag set you want to retrieve.
|
1169
|
+
# The ID of the file system whose tag set you want to retrieve.
|
1133
1170
|
#
|
1134
1171
|
# @return [Types::DescribeTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1135
1172
|
#
|
@@ -1200,10 +1237,10 @@ module Aws::EFS
|
|
1200
1237
|
# network interface.
|
1201
1238
|
#
|
1202
1239
|
# @option params [required, String] :mount_target_id
|
1203
|
-
# ID of the mount target whose security groups you want to modify.
|
1240
|
+
# The ID of the mount target whose security groups you want to modify.
|
1204
1241
|
#
|
1205
1242
|
# @option params [Array<String>] :security_groups
|
1206
|
-
#
|
1243
|
+
# An array of up to five VPC security group IDs.
|
1207
1244
|
#
|
1208
1245
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1209
1246
|
#
|
@@ -1236,15 +1273,16 @@ module Aws::EFS
|
|
1236
1273
|
end
|
1237
1274
|
|
1238
1275
|
# Enables lifecycle management by creating a new
|
1239
|
-
# `LifecycleConfiguration` object. A `LifecycleConfiguration`
|
1240
|
-
# when files in an Amazon EFS file system are automatically
|
1241
|
-
# to the lower-cost EFS Infrequent Access (IA) storage
|
1242
|
-
# `LifecycleConfiguration` applies to all files in a file
|
1276
|
+
# `LifecycleConfiguration` object. A `LifecycleConfiguration` object
|
1277
|
+
# defines when files in an Amazon EFS file system are automatically
|
1278
|
+
# transitioned to the lower-cost EFS Infrequent Access (IA) storage
|
1279
|
+
# class. A `LifecycleConfiguration` applies to all files in a file
|
1280
|
+
# system.
|
1243
1281
|
#
|
1244
1282
|
# Each Amazon EFS file system supports one lifecycle configuration,
|
1245
1283
|
# which applies to all files in the file system. If a
|
1246
|
-
# `LifecycleConfiguration` already exists for the specified file
|
1247
|
-
# a `PutLifecycleConfiguration` call modifies the existing
|
1284
|
+
# `LifecycleConfiguration` object already exists for the specified file
|
1285
|
+
# system, a `PutLifecycleConfiguration` call modifies the existing
|
1248
1286
|
# configuration. A `PutLifecycleConfiguration` call with an empty
|
1249
1287
|
# `LifecyclePolicies` array in the request body deletes any existing
|
1250
1288
|
# `LifecycleConfiguration` and disables lifecycle management.
|
@@ -1261,8 +1299,7 @@ module Aws::EFS
|
|
1261
1299
|
#
|
1262
1300
|
# * A `LifecyclePolicies` array of `LifecyclePolicy` objects that define
|
1263
1301
|
# when files are moved to the IA storage class. The array can contain
|
1264
|
-
# only one `"TransitionToIA": "AFTER_30_DAYS"` `LifecyclePolicy`
|
1265
|
-
# object.
|
1302
|
+
# only one `"TransitionToIA": "AFTER_30_DAYS"` `LifecyclePolicy` item.
|
1266
1303
|
#
|
1267
1304
|
# This operation requires permissions for the
|
1268
1305
|
# `elasticfilesystem:PutLifecycleConfiguration` operation.
|
@@ -1342,6 +1379,7 @@ module Aws::EFS
|
|
1342
1379
|
# * {Types::FileSystemDescription#kms_key_id #kms_key_id} => String
|
1343
1380
|
# * {Types::FileSystemDescription#throughput_mode #throughput_mode} => String
|
1344
1381
|
# * {Types::FileSystemDescription#provisioned_throughput_in_mibps #provisioned_throughput_in_mibps} => Float
|
1382
|
+
# * {Types::FileSystemDescription#tags #tags} => Array<Types::Tag>
|
1345
1383
|
#
|
1346
1384
|
# @example Request syntax with placeholder values
|
1347
1385
|
#
|
@@ -1369,6 +1407,9 @@ module Aws::EFS
|
|
1369
1407
|
# resp.kms_key_id #=> String
|
1370
1408
|
# resp.throughput_mode #=> String, one of "bursting", "provisioned"
|
1371
1409
|
# resp.provisioned_throughput_in_mibps #=> Float
|
1410
|
+
# resp.tags #=> Array
|
1411
|
+
# resp.tags[0].key #=> String
|
1412
|
+
# resp.tags[0].value #=> String
|
1372
1413
|
#
|
1373
1414
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UpdateFileSystem AWS API Documentation
|
1374
1415
|
#
|
@@ -1392,7 +1433,7 @@ module Aws::EFS
|
|
1392
1433
|
params: params,
|
1393
1434
|
config: config)
|
1394
1435
|
context[:gem_name] = 'aws-sdk-efs'
|
1395
|
-
context[:gem_version] = '1.
|
1436
|
+
context[:gem_version] = '1.9.0'
|
1396
1437
|
Seahorse::Client::Request.new(handlers, context)
|
1397
1438
|
end
|
1398
1439
|
|
@@ -94,6 +94,7 @@ module Aws::EFS
|
|
94
94
|
CreateFileSystemRequest.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "KmsKeyId"))
|
95
95
|
CreateFileSystemRequest.add_member(:throughput_mode, Shapes::ShapeRef.new(shape: ThroughputMode, location_name: "ThroughputMode"))
|
96
96
|
CreateFileSystemRequest.add_member(:provisioned_throughput_in_mibps, Shapes::ShapeRef.new(shape: ProvisionedThroughputInMibps, location_name: "ProvisionedThroughputInMibps"))
|
97
|
+
CreateFileSystemRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
97
98
|
CreateFileSystemRequest.struct_class = Types::CreateFileSystemRequest
|
98
99
|
|
99
100
|
CreateMountTargetRequest.add_member(:file_system_id, Shapes::ShapeRef.new(shape: FileSystemId, required: true, location_name: "FileSystemId"))
|
@@ -170,6 +171,7 @@ module Aws::EFS
|
|
170
171
|
FileSystemDescription.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "KmsKeyId"))
|
171
172
|
FileSystemDescription.add_member(:throughput_mode, Shapes::ShapeRef.new(shape: ThroughputMode, location_name: "ThroughputMode"))
|
172
173
|
FileSystemDescription.add_member(:provisioned_throughput_in_mibps, Shapes::ShapeRef.new(shape: ProvisionedThroughputInMibps, location_name: "ProvisionedThroughputInMibps"))
|
174
|
+
FileSystemDescription.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, required: true, location_name: "Tags"))
|
173
175
|
FileSystemDescription.struct_class = Types::FileSystemDescription
|
174
176
|
|
175
177
|
FileSystemDescriptions.member = Shapes::ShapeRef.new(shape: FileSystemDescription)
|
data/lib/aws-sdk-efs/types.rb
CHANGED
@@ -18,27 +18,34 @@ module Aws::EFS
|
|
18
18
|
# kms_key_id: "KmsKeyId",
|
19
19
|
# throughput_mode: "bursting", # accepts bursting, provisioned
|
20
20
|
# provisioned_throughput_in_mibps: 1.0,
|
21
|
+
# tags: [
|
22
|
+
# {
|
23
|
+
# key: "TagKey", # required
|
24
|
+
# value: "TagValue", # required
|
25
|
+
# },
|
26
|
+
# ],
|
21
27
|
# }
|
22
28
|
#
|
23
29
|
# @!attribute [rw] creation_token
|
24
|
-
#
|
25
|
-
# idempotent creation.
|
30
|
+
# A string of up to 64 ASCII characters. Amazon EFS uses this to
|
31
|
+
# ensure idempotent creation.
|
26
32
|
# @return [String]
|
27
33
|
#
|
28
34
|
# @!attribute [rw] performance_mode
|
29
|
-
# The
|
35
|
+
# The performance mode of the file system. We recommend
|
30
36
|
# `generalPurpose` performance mode for most file systems. File
|
31
37
|
# systems using the `maxIO` performance mode can scale to higher
|
32
38
|
# levels of aggregate throughput and operations per second with a
|
33
|
-
# tradeoff of slightly higher latencies for most file operations.
|
34
|
-
# can't be changed after the file system has been
|
39
|
+
# tradeoff of slightly higher latencies for most file operations. The
|
40
|
+
# performance mode can't be changed after the file system has been
|
41
|
+
# created.
|
35
42
|
# @return [String]
|
36
43
|
#
|
37
44
|
# @!attribute [rw] encrypted
|
38
45
|
# A Boolean value that, if true, creates an encrypted file system.
|
39
46
|
# When creating an encrypted file system, you have the option of
|
40
|
-
# specifying
|
41
|
-
#
|
47
|
+
# specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key
|
48
|
+
# Management Service (AWS KMS) customer master key (CMK). If you
|
42
49
|
# don't specify a CMK, then the default CMK for Amazon EFS,
|
43
50
|
# `/aws/elasticfilesystem`, is used to protect the encrypted file
|
44
51
|
# system.
|
@@ -47,23 +54,23 @@ module Aws::EFS
|
|
47
54
|
# @!attribute [rw] kms_key_id
|
48
55
|
# The ID of the AWS KMS CMK to be used to protect the encrypted file
|
49
56
|
# system. This parameter is only required if you want to use a
|
50
|
-
#
|
57
|
+
# nondefault CMK. If this parameter is not specified, the default CMK
|
51
58
|
# for Amazon EFS is used. This ID can be in one of the following
|
52
59
|
# formats:
|
53
60
|
#
|
54
|
-
# * Key ID - A unique identifier of the key, for example
|
61
|
+
# * Key ID - A unique identifier of the key, for example
|
55
62
|
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
56
63
|
#
|
57
|
-
# * ARN - An Amazon Resource Name (ARN) for the key, for example
|
64
|
+
# * ARN - An Amazon Resource Name (ARN) for the key, for example
|
58
65
|
# `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
59
66
|
#
|
60
|
-
# * Key alias - A previously created display name for a key
|
61
|
-
# example
|
67
|
+
# * Key alias - A previously created display name for a key, for
|
68
|
+
# example `alias/projectKey1`.
|
62
69
|
#
|
63
|
-
# * Key alias ARN - An ARN for a key alias, for example
|
70
|
+
# * Key alias ARN - An ARN for a key alias, for example
|
64
71
|
# `arn:aws:kms:us-west-2:444455556666:alias/projectKey1`.
|
65
72
|
#
|
66
|
-
# If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted
|
73
|
+
# If `KmsKeyId` is specified, the CreateFileSystemRequest$Encrypted
|
67
74
|
# parameter must be set to true.
|
68
75
|
# @return [String]
|
69
76
|
#
|
@@ -85,9 +92,16 @@ module Aws::EFS
|
|
85
92
|
#
|
86
93
|
#
|
87
94
|
#
|
88
|
-
# [1]:
|
95
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits
|
89
96
|
# @return [Float]
|
90
97
|
#
|
98
|
+
# @!attribute [rw] tags
|
99
|
+
# A value that specifies to create one or more tags associated with
|
100
|
+
# the file system. Each tag is a user-defined key-value pair. Name
|
101
|
+
# your file system on creation by including a
|
102
|
+
# `"Key":"Name","Value":"\{value\}"` key-value pair.
|
103
|
+
# @return [Array<Types::Tag>]
|
104
|
+
#
|
91
105
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystemRequest AWS API Documentation
|
92
106
|
#
|
93
107
|
class CreateFileSystemRequest < Struct.new(
|
@@ -96,7 +110,8 @@ module Aws::EFS
|
|
96
110
|
:encrypted,
|
97
111
|
:kms_key_id,
|
98
112
|
:throughput_mode,
|
99
|
-
:provisioned_throughput_in_mibps
|
113
|
+
:provisioned_throughput_in_mibps,
|
114
|
+
:tags)
|
100
115
|
include Aws::Structure
|
101
116
|
end
|
102
117
|
|
@@ -111,11 +126,11 @@ module Aws::EFS
|
|
111
126
|
# }
|
112
127
|
#
|
113
128
|
# @!attribute [rw] file_system_id
|
114
|
-
# ID of the file system for which to create the mount target.
|
129
|
+
# The ID of the file system for which to create the mount target.
|
115
130
|
# @return [String]
|
116
131
|
#
|
117
132
|
# @!attribute [rw] subnet_id
|
118
|
-
# ID of the subnet to add the mount target in.
|
133
|
+
# The ID of the subnet to add the mount target in.
|
119
134
|
# @return [String]
|
120
135
|
#
|
121
136
|
# @!attribute [rw] ip_address
|
@@ -151,12 +166,12 @@ module Aws::EFS
|
|
151
166
|
# }
|
152
167
|
#
|
153
168
|
# @!attribute [rw] file_system_id
|
154
|
-
# ID of the file system whose tags you want to modify (String).
|
155
|
-
# operation modifies the tags only, not the file system.
|
169
|
+
# The ID of the file system whose tags you want to modify (String).
|
170
|
+
# This operation modifies the tags only, not the file system.
|
156
171
|
# @return [String]
|
157
172
|
#
|
158
173
|
# @!attribute [rw] tags
|
159
|
-
#
|
174
|
+
# An array of `Tag` objects to add. Each `Tag` object is a key-value
|
160
175
|
# pair.
|
161
176
|
# @return [Array<Types::Tag>]
|
162
177
|
#
|
@@ -176,7 +191,7 @@ module Aws::EFS
|
|
176
191
|
# }
|
177
192
|
#
|
178
193
|
# @!attribute [rw] file_system_id
|
179
|
-
# ID of the file system you want to delete.
|
194
|
+
# The ID of the file system you want to delete.
|
180
195
|
# @return [String]
|
181
196
|
#
|
182
197
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteFileSystemRequest AWS API Documentation
|
@@ -194,7 +209,7 @@ module Aws::EFS
|
|
194
209
|
# }
|
195
210
|
#
|
196
211
|
# @!attribute [rw] mount_target_id
|
197
|
-
# ID of the mount target to delete (String).
|
212
|
+
# The ID of the mount target to delete (String).
|
198
213
|
# @return [String]
|
199
214
|
#
|
200
215
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteMountTargetRequest AWS API Documentation
|
@@ -213,11 +228,11 @@ module Aws::EFS
|
|
213
228
|
# }
|
214
229
|
#
|
215
230
|
# @!attribute [rw] file_system_id
|
216
|
-
# ID of the file system whose tags you want to delete (String).
|
231
|
+
# The ID of the file system whose tags you want to delete (String).
|
217
232
|
# @return [String]
|
218
233
|
#
|
219
234
|
# @!attribute [rw] tag_keys
|
220
|
-
#
|
235
|
+
# A list of tag keys to delete.
|
221
236
|
# @return [Array<String>]
|
222
237
|
#
|
223
238
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DeleteTagsRequest AWS API Documentation
|
@@ -276,7 +291,7 @@ module Aws::EFS
|
|
276
291
|
# @return [String]
|
277
292
|
#
|
278
293
|
# @!attribute [rw] file_systems
|
279
|
-
#
|
294
|
+
# An array of file system descriptions.
|
280
295
|
# @return [Array<Types::FileSystemDescription>]
|
281
296
|
#
|
282
297
|
# @!attribute [rw] next_marker
|
@@ -321,7 +336,8 @@ module Aws::EFS
|
|
321
336
|
# }
|
322
337
|
#
|
323
338
|
# @!attribute [rw] mount_target_id
|
324
|
-
# ID of the mount target whose security groups you want to
|
339
|
+
# The ID of the mount target whose security groups you want to
|
340
|
+
# retrieve.
|
325
341
|
# @return [String]
|
326
342
|
#
|
327
343
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroupsRequest AWS API Documentation
|
@@ -332,7 +348,7 @@ module Aws::EFS
|
|
332
348
|
end
|
333
349
|
|
334
350
|
# @!attribute [rw] security_groups
|
335
|
-
#
|
351
|
+
# An array of security groups.
|
336
352
|
# @return [Array<String>]
|
337
353
|
#
|
338
354
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroupsResponse AWS API Documentation
|
@@ -421,18 +437,18 @@ module Aws::EFS
|
|
421
437
|
# }
|
422
438
|
#
|
423
439
|
# @!attribute [rw] max_items
|
424
|
-
# (Optional)
|
440
|
+
# (Optional) The maximum number of file system tags to return in the
|
425
441
|
# response. Currently, this number is automatically set to 10.
|
426
442
|
# @return [Integer]
|
427
443
|
#
|
428
444
|
# @!attribute [rw] marker
|
429
|
-
# (Optional)
|
445
|
+
# (Optional) An opaque pagination token returned from a previous
|
430
446
|
# `DescribeTags` operation (String). If present, it specifies to
|
431
447
|
# continue the list from where the previous call left off.
|
432
448
|
# @return [String]
|
433
449
|
#
|
434
450
|
# @!attribute [rw] file_system_id
|
435
|
-
# ID of the file system whose tag set you want to retrieve.
|
451
|
+
# The ID of the file system whose tag set you want to retrieve.
|
436
452
|
# @return [String]
|
437
453
|
#
|
438
454
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeTagsRequest AWS API Documentation
|
@@ -470,44 +486,44 @@ module Aws::EFS
|
|
470
486
|
include Aws::Structure
|
471
487
|
end
|
472
488
|
|
473
|
-
#
|
489
|
+
# A description of the file system.
|
474
490
|
#
|
475
491
|
# @!attribute [rw] owner_id
|
476
|
-
# AWS account that created the file system. If the file system was
|
492
|
+
# The AWS account that created the file system. If the file system was
|
477
493
|
# created by an IAM user, the parent account to which the user belongs
|
478
494
|
# is the owner.
|
479
495
|
# @return [String]
|
480
496
|
#
|
481
497
|
# @!attribute [rw] creation_token
|
482
|
-
#
|
498
|
+
# The opaque string specified in the request.
|
483
499
|
# @return [String]
|
484
500
|
#
|
485
501
|
# @!attribute [rw] file_system_id
|
486
|
-
# ID of the file system, assigned by Amazon EFS.
|
502
|
+
# The ID of the file system, assigned by Amazon EFS.
|
487
503
|
# @return [String]
|
488
504
|
#
|
489
505
|
# @!attribute [rw] creation_time
|
490
|
-
#
|
506
|
+
# The time that the file system was created, in seconds (since
|
491
507
|
# 1970-01-01T00:00:00Z).
|
492
508
|
# @return [Time]
|
493
509
|
#
|
494
510
|
# @!attribute [rw] life_cycle_state
|
495
|
-
#
|
511
|
+
# The lifecycle phase of the file system.
|
496
512
|
# @return [String]
|
497
513
|
#
|
498
514
|
# @!attribute [rw] name
|
499
515
|
# You can add tags to a file system, including a `Name` tag. For more
|
500
|
-
# information, see
|
501
|
-
# Amazon EFS returns the value in this field.
|
516
|
+
# information, see CreateFileSystem. If the file system has a `Name`
|
517
|
+
# tag, Amazon EFS returns the value in this field.
|
502
518
|
# @return [String]
|
503
519
|
#
|
504
520
|
# @!attribute [rw] number_of_mount_targets
|
505
|
-
#
|
506
|
-
# information, see CreateMountTarget.
|
521
|
+
# The current number of mount targets that the file system has. For
|
522
|
+
# more information, see CreateMountTarget.
|
507
523
|
# @return [Integer]
|
508
524
|
#
|
509
525
|
# @!attribute [rw] size_in_bytes
|
510
|
-
#
|
526
|
+
# The latest known metered size (in bytes) of data stored in the file
|
511
527
|
# system, in its `Value` field, and the time at which that size was
|
512
528
|
# determined in its `Timestamp` field. The `Timestamp` value is the
|
513
529
|
# integer number of seconds since 1970-01-01T00:00:00Z. The
|
@@ -520,7 +536,7 @@ module Aws::EFS
|
|
520
536
|
# @return [Types::FileSystemSize]
|
521
537
|
#
|
522
538
|
# @!attribute [rw] performance_mode
|
523
|
-
# The
|
539
|
+
# The performance mode of the file system.
|
524
540
|
# @return [String]
|
525
541
|
#
|
526
542
|
# @!attribute [rw] encrypted
|
@@ -551,9 +567,14 @@ module Aws::EFS
|
|
551
567
|
#
|
552
568
|
#
|
553
569
|
#
|
554
|
-
# [1]:
|
570
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits
|
555
571
|
# @return [Float]
|
556
572
|
#
|
573
|
+
# @!attribute [rw] tags
|
574
|
+
# The tags associated with the file system, presented as an array of
|
575
|
+
# `Tag` objects.
|
576
|
+
# @return [Array<Types::Tag>]
|
577
|
+
#
|
557
578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/FileSystemDescription AWS API Documentation
|
558
579
|
#
|
559
580
|
class FileSystemDescription < Struct.new(
|
@@ -569,28 +590,29 @@ module Aws::EFS
|
|
569
590
|
:encrypted,
|
570
591
|
:kms_key_id,
|
571
592
|
:throughput_mode,
|
572
|
-
:provisioned_throughput_in_mibps
|
593
|
+
:provisioned_throughput_in_mibps,
|
594
|
+
:tags)
|
573
595
|
include Aws::Structure
|
574
596
|
end
|
575
597
|
|
576
|
-
#
|
598
|
+
# The latest known metered size (in bytes) of data stored in the file
|
577
599
|
# system, in its `Value` field, and the time at which that size was
|
578
|
-
# determined in its `Timestamp` field.
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
#
|
583
|
-
#
|
584
|
-
#
|
600
|
+
# determined in its `Timestamp` field. The value doesn't represent the
|
601
|
+
# size of a consistent snapshot of the file system, but it is eventually
|
602
|
+
# consistent when there are no writes to the file system. That is, the
|
603
|
+
# value represents the actual size only if the file system is not
|
604
|
+
# modified for a period longer than a couple of hours. Otherwise, the
|
605
|
+
# value is not necessarily the exact size the file system was at any
|
606
|
+
# instant in time.
|
585
607
|
#
|
586
608
|
# @!attribute [rw] value
|
587
|
-
#
|
609
|
+
# The latest known metered size (in bytes) of data stored in the file
|
588
610
|
# system.
|
589
611
|
# @return [Integer]
|
590
612
|
#
|
591
613
|
# @!attribute [rw] timestamp
|
592
|
-
#
|
593
|
-
# determined. The value is the integer number of seconds since
|
614
|
+
# The time at which the size of data, returned in the `Value` field,
|
615
|
+
# was determined. The value is the integer number of seconds since
|
594
616
|
# 1970-01-01T00:00:00Z.
|
595
617
|
# @return [Time]
|
596
618
|
#
|
@@ -637,8 +659,8 @@ module Aws::EFS
|
|
637
659
|
# }
|
638
660
|
#
|
639
661
|
# @!attribute [rw] transition_to_ia
|
640
|
-
# A value that indicates how long it takes to transition to the
|
641
|
-
# storage class. Currently, the only
|
662
|
+
# A value that indicates how long it takes to transition files to the
|
663
|
+
# IA storage class. Currently, the only valid value is
|
642
664
|
# `AFTER_30_DAYS`.
|
643
665
|
#
|
644
666
|
# `AFTER_30_DAYS` indicates files that have not been read from or
|
@@ -663,11 +685,11 @@ module Aws::EFS
|
|
663
685
|
# }
|
664
686
|
#
|
665
687
|
# @!attribute [rw] mount_target_id
|
666
|
-
# ID of the mount target whose security groups you want to modify.
|
688
|
+
# The ID of the mount target whose security groups you want to modify.
|
667
689
|
# @return [String]
|
668
690
|
#
|
669
691
|
# @!attribute [rw] security_groups
|
670
|
-
#
|
692
|
+
# An array of up to five VPC security group IDs.
|
671
693
|
# @return [Array<String>]
|
672
694
|
#
|
673
695
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroupsRequest AWS API Documentation
|
@@ -689,11 +711,11 @@ module Aws::EFS
|
|
689
711
|
# @return [String]
|
690
712
|
#
|
691
713
|
# @!attribute [rw] file_system_id
|
692
|
-
# ID of the file system for which the mount target is intended.
|
714
|
+
# The ID of the file system for which the mount target is intended.
|
693
715
|
# @return [String]
|
694
716
|
#
|
695
717
|
# @!attribute [rw] subnet_id
|
696
|
-
# ID of the mount target's subnet.
|
718
|
+
# The ID of the mount target's subnet.
|
697
719
|
# @return [String]
|
698
720
|
#
|
699
721
|
# @!attribute [rw] life_cycle_state
|
@@ -706,8 +728,8 @@ module Aws::EFS
|
|
706
728
|
# @return [String]
|
707
729
|
#
|
708
730
|
# @!attribute [rw] network_interface_id
|
709
|
-
# ID of the network interface that Amazon EFS created when it
|
710
|
-
# the mount target.
|
731
|
+
# The ID of the network interface that Amazon EFS created when it
|
732
|
+
# created the mount target.
|
711
733
|
# @return [String]
|
712
734
|
#
|
713
735
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/MountTargetDescription AWS API Documentation
|
@@ -755,9 +777,9 @@ module Aws::EFS
|
|
755
777
|
include Aws::Structure
|
756
778
|
end
|
757
779
|
|
758
|
-
# A tag is a key-value pair. Allowed characters
|
759
|
-
# and numbers
|
760
|
-
# - = . _ : /`
|
780
|
+
# A tag is a key-value pair. Allowed characters are letters, white
|
781
|
+
# space, and numbers that can be represented in UTF-8, and the following
|
782
|
+
# characters:` + - = . _ : /`
|
761
783
|
#
|
762
784
|
# @note When making an API call, you may pass Tag
|
763
785
|
# data as a hash:
|
@@ -768,11 +790,11 @@ module Aws::EFS
|
|
768
790
|
# }
|
769
791
|
#
|
770
792
|
# @!attribute [rw] key
|
771
|
-
#
|
793
|
+
# The tag key (String). The key can't start with `aws:`.
|
772
794
|
# @return [String]
|
773
795
|
#
|
774
796
|
# @!attribute [rw] value
|
775
|
-
#
|
797
|
+
# The value of the tag key.
|
776
798
|
# @return [String]
|
777
799
|
#
|
778
800
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/Tag AWS API Documentation
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-efs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.9.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-02-
|
11
|
+
date: 2019-02-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|