aws-sdk-efs 1.35.0 → 1.40.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +276 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-efs.rb +2 -2
- data/lib/aws-sdk-efs/client.rb +238 -66
- data/lib/aws-sdk-efs/client_api.rb +59 -1
- data/lib/aws-sdk-efs/customizations.rb +1 -1
- data/lib/aws-sdk-efs/errors.rb +22 -1
- data/lib/aws-sdk-efs/resource.rb +1 -1
- data/lib/aws-sdk-efs/types.rb +277 -78
- metadata +11 -9
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.40.0
|
data/lib/aws-sdk-efs.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/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-efs/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::EFS
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.40.0'
|
52
52
|
|
53
53
|
end
|
data/lib/aws-sdk-efs/client.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/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -334,8 +334,8 @@ module Aws::EFS
|
|
334
334
|
# user and group override any identity information provided by the NFS
|
335
335
|
# client. The file system path is exposed as the access point's root
|
336
336
|
# directory. Applications using the access point can only access data in
|
337
|
-
# its own directory and below. To learn more, see [Mounting a
|
338
|
-
#
|
337
|
+
# its own directory and below. To learn more, see [Mounting a file
|
338
|
+
# system using EFS access points][1].
|
339
339
|
#
|
340
340
|
# This operation requires permissions for the
|
341
341
|
# `elasticfilesystem:CreateAccessPoint` action.
|
@@ -371,7 +371,13 @@ module Aws::EFS
|
|
371
371
|
# `Path` specified does not exist, EFS creates it and applies the
|
372
372
|
# `CreationInfo` settings when a client connects to an access point.
|
373
373
|
# When specifying a `RootDirectory`, you need to provide the `Path`, and
|
374
|
-
# the `CreationInfo
|
374
|
+
# the `CreationInfo`.
|
375
|
+
#
|
376
|
+
# Amazon EFS creates a root directory only if you have provided the
|
377
|
+
# CreationInfo: OwnUid, OwnGID, and permissions for the directory. If
|
378
|
+
# you do not provide this information, Amazon EFS does not create the
|
379
|
+
# root directory. If the root directory does not exist, attempts to
|
380
|
+
# mount using the access point will fail.
|
375
381
|
#
|
376
382
|
# @return [Types::AccessPointDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
377
383
|
#
|
@@ -431,7 +437,7 @@ module Aws::EFS
|
|
431
437
|
# resp.root_directory.creation_info.owner_gid #=> Integer
|
432
438
|
# resp.root_directory.creation_info.permissions #=> String
|
433
439
|
# resp.owner_id #=> String
|
434
|
-
# resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
|
440
|
+
# resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted", "error"
|
435
441
|
#
|
436
442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateAccessPoint AWS API Documentation
|
437
443
|
#
|
@@ -471,6 +477,9 @@ module Aws::EFS
|
|
471
477
|
# creating a file system, the client can learn of its existence from the
|
472
478
|
# `FileSystemAlreadyExists` error.
|
473
479
|
#
|
480
|
+
# For more information, see [Creating a file system][1] in the *Amazon
|
481
|
+
# EFS User Guide*.
|
482
|
+
#
|
474
483
|
# <note markdown="1"> The `CreateFileSystem` call returns while the file system's lifecycle
|
475
484
|
# state is still `creating`. You can check the file system creation
|
476
485
|
# status by calling the DescribeFileSystems operation, which among other
|
@@ -478,29 +487,33 @@ module Aws::EFS
|
|
478
487
|
#
|
479
488
|
# </note>
|
480
489
|
#
|
481
|
-
# This operation
|
490
|
+
# This operation accepts an optional `PerformanceMode` parameter that
|
482
491
|
# you choose for your file system. We recommend `generalPurpose`
|
483
492
|
# performance mode for most file systems. File systems using the `maxIO`
|
484
493
|
# performance mode can scale to higher levels of aggregate throughput
|
485
494
|
# and operations per second with a tradeoff of slightly higher latencies
|
486
495
|
# for most file operations. The performance mode can't be changed after
|
487
496
|
# the file system has been created. For more information, see [Amazon
|
488
|
-
# EFS
|
497
|
+
# EFS performance modes][2].
|
498
|
+
#
|
499
|
+
# You can set the throughput mode for the file system using the
|
500
|
+
# `ThroughputMode` parameter.
|
489
501
|
#
|
490
502
|
# After the file system is fully created, Amazon EFS sets its lifecycle
|
491
503
|
# state to `available`, at which point you can create one or more mount
|
492
504
|
# targets for the file system in your VPC. For more information, see
|
493
505
|
# CreateMountTarget. You mount your Amazon EFS file system on an EC2
|
494
506
|
# instances in your VPC by using the mount target. For more information,
|
495
|
-
# see [Amazon EFS: How it Works][
|
507
|
+
# see [Amazon EFS: How it Works][3].
|
496
508
|
#
|
497
509
|
# This operation requires permissions for the
|
498
510
|
# `elasticfilesystem:CreateFileSystem` action.
|
499
511
|
#
|
500
512
|
#
|
501
513
|
#
|
502
|
-
# [1]: https://docs.aws.amazon.com/efs/latest/ug/
|
503
|
-
# [2]: https://docs.aws.amazon.com/efs/latest/ug/
|
514
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1
|
515
|
+
# [2]: https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html
|
516
|
+
# [3]: https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html
|
504
517
|
#
|
505
518
|
# @option params [required, String] :creation_token
|
506
519
|
# A string of up to 64 ASCII characters. Amazon EFS uses this to ensure
|
@@ -517,6 +530,11 @@ module Aws::EFS
|
|
517
530
|
# for most file operations. The performance mode can't be changed after
|
518
531
|
# the file system has been created.
|
519
532
|
#
|
533
|
+
# <note markdown="1"> The `maxIO` mode is not supported on file systems using One Zone
|
534
|
+
# storage classes.
|
535
|
+
#
|
536
|
+
# </note>
|
537
|
+
#
|
520
538
|
# @option params [Boolean] :encrypted
|
521
539
|
# A Boolean value that, if true, creates an encrypted file system. When
|
522
540
|
# creating an encrypted file system, you have the option of specifying
|
@@ -526,11 +544,11 @@ module Aws::EFS
|
|
526
544
|
# used to protect the encrypted file system.
|
527
545
|
#
|
528
546
|
# @option params [String] :kms_key_id
|
529
|
-
# The ID of the AWS KMS CMK
|
530
|
-
# system. This parameter is only required if you want to
|
531
|
-
#
|
532
|
-
# for Amazon EFS is used. This ID can be in one of the
|
533
|
-
# formats:
|
547
|
+
# The ID of the AWS KMS CMK that you want to use to protect the
|
548
|
+
# encrypted file system. This parameter is only required if you want to
|
549
|
+
# use a non-default KMS key. If this parameter is not specified, the
|
550
|
+
# default CMK for Amazon EFS is used. This ID can be in one of the
|
551
|
+
# following formats:
|
534
552
|
#
|
535
553
|
# * Key ID - A unique identifier of the key, for example
|
536
554
|
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
@@ -547,19 +565,21 @@ module Aws::EFS
|
|
547
565
|
# If `KmsKeyId` is specified, the CreateFileSystemRequest$Encrypted
|
548
566
|
# parameter must be set to true.
|
549
567
|
#
|
550
|
-
# EFS accepts only symmetric
|
551
|
-
# EFS file systems.
|
568
|
+
# EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS
|
569
|
+
# keys with EFS file systems.
|
552
570
|
#
|
553
571
|
# @option params [String] :throughput_mode
|
554
|
-
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
560
|
-
#
|
561
|
-
# [Specifying
|
562
|
-
# User Guide
|
572
|
+
# Specifies the throughput mode for the file system, either `bursting`
|
573
|
+
# or `provisioned`. If you set `ThroughputMode` to `provisioned`, you
|
574
|
+
# must also set a value for `ProvisionedThroughputInMibps`. After you
|
575
|
+
# create the file system, you can decrease your file system's
|
576
|
+
# throughput in Provisioned Throughput mode or change between the
|
577
|
+
# throughput modes, as long as it’s been more than 24 hours since the
|
578
|
+
# last decrease or throughput mode change. For more information, see
|
579
|
+
# [Specifying throughput with provisioned mode][1] in the *Amazon EFS
|
580
|
+
# User Guide*.
|
581
|
+
#
|
582
|
+
# Default is `bursting`.
|
563
583
|
#
|
564
584
|
#
|
565
585
|
#
|
@@ -569,14 +589,50 @@ module Aws::EFS
|
|
569
589
|
# The throughput, measured in MiB/s, that you want to provision for a
|
570
590
|
# file system that you're creating. Valid values are 1-1024. Required
|
571
591
|
# if `ThroughputMode` is set to `provisioned`. The upper limit for
|
572
|
-
# throughput is 1024 MiB/s.
|
573
|
-
#
|
574
|
-
#
|
592
|
+
# throughput is 1024 MiB/s. To increase this limit, contact AWS Support.
|
593
|
+
# For more information, see [Amazon EFS quotas that you can increase][1]
|
594
|
+
# in the *Amazon EFS User Guide*.
|
575
595
|
#
|
576
596
|
#
|
577
597
|
#
|
578
598
|
# [1]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits
|
579
599
|
#
|
600
|
+
# @option params [String] :availability_zone_name
|
601
|
+
# Used to create a file system that uses One Zone storage classes. It
|
602
|
+
# specifies the AWS Availability Zone in which to create the file
|
603
|
+
# system. Use the format `us-east-1a` to specify the Availability Zone.
|
604
|
+
# For more information about One Zone storage classes, see [Using EFS
|
605
|
+
# storage classes][1] in the *Amazon EFS User Guide*.
|
606
|
+
#
|
607
|
+
# <note markdown="1"> One Zone storage classes are not available in all Availability Zones
|
608
|
+
# in AWS Regions where Amazon EFS is available.
|
609
|
+
#
|
610
|
+
# </note>
|
611
|
+
#
|
612
|
+
#
|
613
|
+
#
|
614
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html
|
615
|
+
#
|
616
|
+
# @option params [Boolean] :backup
|
617
|
+
# Specifies whether automatic backups are enabled on the file system
|
618
|
+
# that you are creating. Set the value to `true` to enable automatic
|
619
|
+
# backups. If you are creating a file system that uses One Zone storage
|
620
|
+
# classes, automatic backups are enabled by default. For more
|
621
|
+
# information, see [Automatic backups][1] in the *Amazon EFS User
|
622
|
+
# Guide*.
|
623
|
+
#
|
624
|
+
# Default is `false`. However, if you specify an `AvailabilityZoneName`,
|
625
|
+
# the default is `true`.
|
626
|
+
#
|
627
|
+
# <note markdown="1"> AWS Backup is not available in all AWS Regions where Amazon EFS is
|
628
|
+
# available.
|
629
|
+
#
|
630
|
+
# </note>
|
631
|
+
#
|
632
|
+
#
|
633
|
+
#
|
634
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups
|
635
|
+
#
|
580
636
|
# @option params [Array<Types::Tag>] :tags
|
581
637
|
# A value that specifies to create one or more tags associated with the
|
582
638
|
# file system. Each tag is a user-defined key-value pair. Name your file
|
@@ -599,15 +655,20 @@ module Aws::EFS
|
|
599
655
|
# * {Types::FileSystemDescription#kms_key_id #kms_key_id} => String
|
600
656
|
# * {Types::FileSystemDescription#throughput_mode #throughput_mode} => String
|
601
657
|
# * {Types::FileSystemDescription#provisioned_throughput_in_mibps #provisioned_throughput_in_mibps} => Float
|
658
|
+
# * {Types::FileSystemDescription#availability_zone_name #availability_zone_name} => String
|
659
|
+
# * {Types::FileSystemDescription#availability_zone_id #availability_zone_id} => String
|
602
660
|
# * {Types::FileSystemDescription#tags #tags} => Array<Types::Tag>
|
603
661
|
#
|
604
662
|
#
|
605
663
|
# @example Example: To create a new file system
|
606
664
|
#
|
607
|
-
# # This operation creates a new file system with the default generalpurpose
|
665
|
+
# # This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose
|
666
|
+
# # performance mode.
|
608
667
|
#
|
609
668
|
# resp = client.create_file_system({
|
669
|
+
# backup: true,
|
610
670
|
# creation_token: "tokenstring",
|
671
|
+
# encrypted: true,
|
611
672
|
# performance_mode: "generalPurpose",
|
612
673
|
# tags: [
|
613
674
|
# {
|
@@ -621,6 +682,7 @@ module Aws::EFS
|
|
621
682
|
# {
|
622
683
|
# creation_time: Time.parse("1481841524.0"),
|
623
684
|
# creation_token: "tokenstring",
|
685
|
+
# encrypted: true,
|
624
686
|
# file_system_id: "fs-01234567",
|
625
687
|
# life_cycle_state: "creating",
|
626
688
|
# number_of_mount_targets: 0,
|
@@ -646,6 +708,8 @@ module Aws::EFS
|
|
646
708
|
# kms_key_id: "KmsKeyId",
|
647
709
|
# throughput_mode: "bursting", # accepts bursting, provisioned
|
648
710
|
# provisioned_throughput_in_mibps: 1.0,
|
711
|
+
# availability_zone_name: "AvailabilityZoneName",
|
712
|
+
# backup: false,
|
649
713
|
# tags: [
|
650
714
|
# {
|
651
715
|
# key: "TagKey", # required
|
@@ -661,7 +725,7 @@ module Aws::EFS
|
|
661
725
|
# resp.file_system_id #=> String
|
662
726
|
# resp.file_system_arn #=> String
|
663
727
|
# resp.creation_time #=> Time
|
664
|
-
# resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
|
728
|
+
# resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted", "error"
|
665
729
|
# resp.name #=> String
|
666
730
|
# resp.number_of_mount_targets #=> Integer
|
667
731
|
# resp.size_in_bytes.value #=> Integer
|
@@ -673,6 +737,8 @@ module Aws::EFS
|
|
673
737
|
# resp.kms_key_id #=> String
|
674
738
|
# resp.throughput_mode #=> String, one of "bursting", "provisioned"
|
675
739
|
# resp.provisioned_throughput_in_mibps #=> Float
|
740
|
+
# resp.availability_zone_name #=> String
|
741
|
+
# resp.availability_zone_id #=> String
|
676
742
|
# resp.tags #=> Array
|
677
743
|
# resp.tags[0].key #=> String
|
678
744
|
# resp.tags[0].value #=> String
|
@@ -694,22 +760,35 @@ module Aws::EFS
|
|
694
760
|
# single mount target for a given file system. If you have multiple
|
695
761
|
# subnets in an Availability Zone, you create a mount target in one of
|
696
762
|
# the subnets. EC2 instances do not need to be in the same subnet as the
|
697
|
-
# mount target in order to access their file system.
|
698
|
-
# information, see [Amazon EFS: How it Works][1].
|
763
|
+
# mount target in order to access their file system.
|
699
764
|
#
|
700
|
-
#
|
701
|
-
#
|
702
|
-
#
|
765
|
+
# You can create only one mount target for an EFS file system using One
|
766
|
+
# Zone storage classes. You must create that mount target in the same
|
767
|
+
# Availability Zone in which the file system is located. Use the
|
768
|
+
# `AvailabilityZoneName` and `AvailabiltyZoneId` properties in the
|
769
|
+
# DescribeFileSystems response object to get this information. Use the
|
770
|
+
# `subnetId` associated with the file system's Availability Zone when
|
771
|
+
# creating the mount target.
|
703
772
|
#
|
704
|
-
#
|
705
|
-
#
|
773
|
+
# For more information, see [Amazon EFS: How it Works][1].
|
774
|
+
#
|
775
|
+
# To create a mount target for a file system, the file system's
|
776
|
+
# lifecycle state must be `available`. For more information, see
|
777
|
+
# DescribeFileSystems.
|
778
|
+
#
|
779
|
+
# In the request, provide the following:
|
706
780
|
#
|
707
|
-
# *
|
781
|
+
# * The file system ID for which you are creating the mount target.
|
708
782
|
#
|
709
|
-
# *
|
783
|
+
# * A subnet ID, which determines the following:
|
710
784
|
#
|
711
|
-
#
|
712
|
-
#
|
785
|
+
# * The VPC in which Amazon EFS creates the mount target
|
786
|
+
#
|
787
|
+
# * The Availability Zone in which Amazon EFS creates the mount target
|
788
|
+
#
|
789
|
+
# * The IP address range from which Amazon EFS selects the IP address
|
790
|
+
# of the mount target (if you don't specify an IP address in the
|
791
|
+
# request)
|
713
792
|
#
|
714
793
|
# After creating the mount target, Amazon EFS returns a response that
|
715
794
|
# includes, a `MountTargetId` and an `IpAddress`. You use this IP
|
@@ -805,7 +884,9 @@ module Aws::EFS
|
|
805
884
|
# The ID of the file system for which to create the mount target.
|
806
885
|
#
|
807
886
|
# @option params [required, String] :subnet_id
|
808
|
-
# The ID of the subnet to add the mount target in.
|
887
|
+
# The ID of the subnet to add the mount target in. For file systems that
|
888
|
+
# use One Zone storage classes, use the subnet that is associated with
|
889
|
+
# the file system's Availability Zone.
|
809
890
|
#
|
810
891
|
# @option params [String] :ip_address
|
811
892
|
# Valid IPv4 address within the address range of the specified subnet.
|
@@ -863,7 +944,7 @@ module Aws::EFS
|
|
863
944
|
# resp.mount_target_id #=> String
|
864
945
|
# resp.file_system_id #=> String
|
865
946
|
# resp.subnet_id #=> String
|
866
|
-
# resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
|
947
|
+
# resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted", "error"
|
867
948
|
# resp.ip_address #=> String
|
868
949
|
# resp.network_interface_id #=> String
|
869
950
|
# resp.availability_zone_id #=> String
|
@@ -879,6 +960,11 @@ module Aws::EFS
|
|
879
960
|
req.send_request(options)
|
880
961
|
end
|
881
962
|
|
963
|
+
# <note markdown="1"> DEPRECATED - CreateTags is deprecated and not maintained. Please use
|
964
|
+
# the API action to create tags for EFS resources.
|
965
|
+
#
|
966
|
+
# </note>
|
967
|
+
#
|
882
968
|
# Creates or overwrites tags associated with a file system. Each tag is
|
883
969
|
# a key-value pair. If a tag key specified in the request already exists
|
884
970
|
# on the file system, this operation overwrites its value with the value
|
@@ -1107,6 +1193,11 @@ module Aws::EFS
|
|
1107
1193
|
req.send_request(options)
|
1108
1194
|
end
|
1109
1195
|
|
1196
|
+
# <note markdown="1"> DEPRECATED - DeleteTags is deprecated and not maintained. Please use
|
1197
|
+
# the API action to remove tags from EFS resources.
|
1198
|
+
#
|
1199
|
+
# </note>
|
1200
|
+
#
|
1110
1201
|
# Deletes the specified tags from a file system. If the `DeleteTags`
|
1111
1202
|
# request includes a tag key that doesn't exist, Amazon EFS ignores it
|
1112
1203
|
# and doesn't cause an error. For more information about tags and
|
@@ -1219,7 +1310,7 @@ module Aws::EFS
|
|
1219
1310
|
# resp.access_points[0].root_directory.creation_info.owner_gid #=> Integer
|
1220
1311
|
# resp.access_points[0].root_directory.creation_info.permissions #=> String
|
1221
1312
|
# resp.access_points[0].owner_id #=> String
|
1222
|
-
# resp.access_points[0].life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
|
1313
|
+
# resp.access_points[0].life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted", "error"
|
1223
1314
|
# resp.next_token #=> String
|
1224
1315
|
#
|
1225
1316
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeAccessPoints AWS API Documentation
|
@@ -1231,6 +1322,40 @@ module Aws::EFS
|
|
1231
1322
|
req.send_request(options)
|
1232
1323
|
end
|
1233
1324
|
|
1325
|
+
# @option params [String] :next_token
|
1326
|
+
# Token used for pagination.
|
1327
|
+
#
|
1328
|
+
# @option params [Integer] :max_results
|
1329
|
+
# Max results used for pagination.
|
1330
|
+
#
|
1331
|
+
# @return [Types::DescribeAccountPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1332
|
+
#
|
1333
|
+
# * {Types::DescribeAccountPreferencesResponse#resource_id_preference #resource_id_preference} => Types::ResourceIdPreference
|
1334
|
+
# * {Types::DescribeAccountPreferencesResponse#next_token #next_token} => String
|
1335
|
+
#
|
1336
|
+
# @example Request syntax with placeholder values
|
1337
|
+
#
|
1338
|
+
# resp = client.describe_account_preferences({
|
1339
|
+
# next_token: "Token",
|
1340
|
+
# max_results: 1,
|
1341
|
+
# })
|
1342
|
+
#
|
1343
|
+
# @example Response structure
|
1344
|
+
#
|
1345
|
+
# resp.resource_id_preference.resource_id_type #=> String, one of "LONG_ID", "SHORT_ID"
|
1346
|
+
# resp.resource_id_preference.resources #=> Array
|
1347
|
+
# resp.resource_id_preference.resources[0] #=> String, one of "FILE_SYSTEM", "MOUNT_TARGET"
|
1348
|
+
# resp.next_token #=> String
|
1349
|
+
#
|
1350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeAccountPreferences AWS API Documentation
|
1351
|
+
#
|
1352
|
+
# @overload describe_account_preferences(params = {})
|
1353
|
+
# @param [Hash] params ({})
|
1354
|
+
def describe_account_preferences(params = {}, options = {})
|
1355
|
+
req = build_request(:describe_account_preferences, params)
|
1356
|
+
req.send_request(options)
|
1357
|
+
end
|
1358
|
+
|
1234
1359
|
# Returns the backup policy for the specified EFS file system.
|
1235
1360
|
#
|
1236
1361
|
# @option params [required, String] :file_system_id
|
@@ -1399,7 +1524,7 @@ module Aws::EFS
|
|
1399
1524
|
# resp.file_systems[0].file_system_id #=> String
|
1400
1525
|
# resp.file_systems[0].file_system_arn #=> String
|
1401
1526
|
# resp.file_systems[0].creation_time #=> Time
|
1402
|
-
# resp.file_systems[0].life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
|
1527
|
+
# resp.file_systems[0].life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted", "error"
|
1403
1528
|
# resp.file_systems[0].name #=> String
|
1404
1529
|
# resp.file_systems[0].number_of_mount_targets #=> Integer
|
1405
1530
|
# resp.file_systems[0].size_in_bytes.value #=> Integer
|
@@ -1411,6 +1536,8 @@ module Aws::EFS
|
|
1411
1536
|
# resp.file_systems[0].kms_key_id #=> String
|
1412
1537
|
# resp.file_systems[0].throughput_mode #=> String, one of "bursting", "provisioned"
|
1413
1538
|
# resp.file_systems[0].provisioned_throughput_in_mibps #=> Float
|
1539
|
+
# resp.file_systems[0].availability_zone_name #=> String
|
1540
|
+
# resp.file_systems[0].availability_zone_id #=> String
|
1414
1541
|
# resp.file_systems[0].tags #=> Array
|
1415
1542
|
# resp.file_systems[0].tags[0].key #=> String
|
1416
1543
|
# resp.file_systems[0].tags[0].value #=> String
|
@@ -1624,7 +1751,7 @@ module Aws::EFS
|
|
1624
1751
|
# resp.mount_targets[0].mount_target_id #=> String
|
1625
1752
|
# resp.mount_targets[0].file_system_id #=> String
|
1626
1753
|
# resp.mount_targets[0].subnet_id #=> String
|
1627
|
-
# resp.mount_targets[0].life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
|
1754
|
+
# resp.mount_targets[0].life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted", "error"
|
1628
1755
|
# resp.mount_targets[0].ip_address #=> String
|
1629
1756
|
# resp.mount_targets[0].network_interface_id #=> String
|
1630
1757
|
# resp.mount_targets[0].availability_zone_id #=> String
|
@@ -1641,6 +1768,11 @@ module Aws::EFS
|
|
1641
1768
|
req.send_request(options)
|
1642
1769
|
end
|
1643
1770
|
|
1771
|
+
# <note markdown="1"> DEPRECATED - The DeleteTags action is deprecated and not maintained.
|
1772
|
+
# Please use the API action to remove tags from EFS resources.
|
1773
|
+
#
|
1774
|
+
# </note>
|
1775
|
+
#
|
1644
1776
|
# Returns the tags associated with a file system. The order of tags
|
1645
1777
|
# returned in the response of one `DescribeTags` call and the order of
|
1646
1778
|
# tags returned across the responses of a multiple-call iteration (when
|
@@ -1731,8 +1863,9 @@ module Aws::EFS
|
|
1731
1863
|
# the response. The default value is 100.
|
1732
1864
|
#
|
1733
1865
|
# @option params [String] :next_token
|
1734
|
-
# You can use `NextToken` in a subsequent request to fetch
|
1735
|
-
# of access point descriptions if the response payload was
|
1866
|
+
# (Optional) You can use `NextToken` in a subsequent request to fetch
|
1867
|
+
# the next page of access point descriptions if the response payload was
|
1868
|
+
# paginated.
|
1736
1869
|
#
|
1737
1870
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1738
1871
|
#
|
@@ -1819,6 +1952,35 @@ module Aws::EFS
|
|
1819
1952
|
req.send_request(options)
|
1820
1953
|
end
|
1821
1954
|
|
1955
|
+
# @option params [required, String] :resource_id_type
|
1956
|
+
# A preference indicating a choice to use 63bit/32bit IDs for all
|
1957
|
+
# applicable resources.
|
1958
|
+
#
|
1959
|
+
# @return [Types::PutAccountPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1960
|
+
#
|
1961
|
+
# * {Types::PutAccountPreferencesResponse#resource_id_preference #resource_id_preference} => Types::ResourceIdPreference
|
1962
|
+
#
|
1963
|
+
# @example Request syntax with placeholder values
|
1964
|
+
#
|
1965
|
+
# resp = client.put_account_preferences({
|
1966
|
+
# resource_id_type: "LONG_ID", # required, accepts LONG_ID, SHORT_ID
|
1967
|
+
# })
|
1968
|
+
#
|
1969
|
+
# @example Response structure
|
1970
|
+
#
|
1971
|
+
# resp.resource_id_preference.resource_id_type #=> String, one of "LONG_ID", "SHORT_ID"
|
1972
|
+
# resp.resource_id_preference.resources #=> Array
|
1973
|
+
# resp.resource_id_preference.resources[0] #=> String, one of "FILE_SYSTEM", "MOUNT_TARGET"
|
1974
|
+
#
|
1975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/PutAccountPreferences AWS API Documentation
|
1976
|
+
#
|
1977
|
+
# @overload put_account_preferences(params = {})
|
1978
|
+
# @param [Hash] params ({})
|
1979
|
+
def put_account_preferences(params = {}, options = {})
|
1980
|
+
req = build_request(:put_account_preferences, params)
|
1981
|
+
req.send_request(options)
|
1982
|
+
end
|
1983
|
+
|
1822
1984
|
# Updates the file system's backup policy. Use this action to start or
|
1823
1985
|
# stop automatic backups of the file system.
|
1824
1986
|
#
|
@@ -1858,9 +2020,12 @@ module Aws::EFS
|
|
1858
2020
|
# A file system policy is an IAM resource-based policy and can contain
|
1859
2021
|
# multiple policy statements. A file system always has exactly one file
|
1860
2022
|
# system policy, which can be the default policy or an explicit policy
|
1861
|
-
# set or updated using this API operation.
|
1862
|
-
#
|
1863
|
-
# default
|
2023
|
+
# set or updated using this API operation. EFS file system policies have
|
2024
|
+
# a 20,000 character limit. When an explicit policy is set, it overrides
|
2025
|
+
# the default policy. For more information about the default file system
|
2026
|
+
# policy, see [Default EFS File System Policy][1].
|
2027
|
+
#
|
2028
|
+
# EFS file system policies have a 20,000 character limit.
|
1864
2029
|
#
|
1865
2030
|
# This operation requires permissions for the
|
1866
2031
|
# `elasticfilesystem:PutFileSystemPolicy` action.
|
@@ -1875,8 +2040,9 @@ module Aws::EFS
|
|
1875
2040
|
#
|
1876
2041
|
# @option params [required, String] :policy
|
1877
2042
|
# The `FileSystemPolicy` that you're creating. Accepts a JSON formatted
|
1878
|
-
# policy definition.
|
1879
|
-
#
|
2043
|
+
# policy definition. EFS file system policies have a 20,000 character
|
2044
|
+
# limit. To find out more about the elements that make up a file system
|
2045
|
+
# policy, see [EFS Resource-based Policies][1].
|
1880
2046
|
#
|
1881
2047
|
#
|
1882
2048
|
#
|
@@ -2025,6 +2191,8 @@ module Aws::EFS
|
|
2025
2191
|
# The ID specifying the EFS resource that you want to create a tag for.
|
2026
2192
|
#
|
2027
2193
|
# @option params [required, Array<Types::Tag>] :tags
|
2194
|
+
# An array of `Tag` objects to add. Each `Tag` object is a key-value
|
2195
|
+
# pair.
|
2028
2196
|
#
|
2029
2197
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2030
2198
|
#
|
@@ -2059,7 +2227,7 @@ module Aws::EFS
|
|
2059
2227
|
# Specifies the EFS resource that you want to remove tags from.
|
2060
2228
|
#
|
2061
2229
|
# @option params [required, Array<String>] :tag_keys
|
2062
|
-
# The keys of the key
|
2230
|
+
# The keys of the key-value tag pairs that you want to remove from the
|
2063
2231
|
# specified EFS resource.
|
2064
2232
|
#
|
2065
2233
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -2087,18 +2255,18 @@ module Aws::EFS
|
|
2087
2255
|
# The ID of the file system that you want to update.
|
2088
2256
|
#
|
2089
2257
|
# @option params [String] :throughput_mode
|
2090
|
-
# (Optional)
|
2091
|
-
#
|
2092
|
-
#
|
2093
|
-
# `
|
2258
|
+
# (Optional) Updates the file system's throughput mode. If you're not
|
2259
|
+
# updating your throughput mode, you don't need to provide this value
|
2260
|
+
# in your request. If you are changing the `ThroughputMode` to
|
2261
|
+
# `provisioned`, you must also set a value for
|
2094
2262
|
# `ProvisionedThroughputInMibps`.
|
2095
2263
|
#
|
2096
2264
|
# @option params [Float] :provisioned_throughput_in_mibps
|
2097
|
-
# (Optional)
|
2098
|
-
#
|
2099
|
-
#
|
2100
|
-
#
|
2101
|
-
#
|
2265
|
+
# (Optional) Sets the amount of provisioned throughput, in MiB/s, for
|
2266
|
+
# the file system. Valid values are 1-1024. If you are changing the
|
2267
|
+
# throughput mode to provisioned, you must also provide the amount of
|
2268
|
+
# provisioned throughput. Required if `ThroughputMode` is changed to
|
2269
|
+
# `provisioned` on update.
|
2102
2270
|
#
|
2103
2271
|
# @return [Types::FileSystemDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2104
2272
|
#
|
@@ -2116,6 +2284,8 @@ module Aws::EFS
|
|
2116
2284
|
# * {Types::FileSystemDescription#kms_key_id #kms_key_id} => String
|
2117
2285
|
# * {Types::FileSystemDescription#throughput_mode #throughput_mode} => String
|
2118
2286
|
# * {Types::FileSystemDescription#provisioned_throughput_in_mibps #provisioned_throughput_in_mibps} => Float
|
2287
|
+
# * {Types::FileSystemDescription#availability_zone_name #availability_zone_name} => String
|
2288
|
+
# * {Types::FileSystemDescription#availability_zone_id #availability_zone_id} => String
|
2119
2289
|
# * {Types::FileSystemDescription#tags #tags} => Array<Types::Tag>
|
2120
2290
|
#
|
2121
2291
|
# @example Request syntax with placeholder values
|
@@ -2133,7 +2303,7 @@ module Aws::EFS
|
|
2133
2303
|
# resp.file_system_id #=> String
|
2134
2304
|
# resp.file_system_arn #=> String
|
2135
2305
|
# resp.creation_time #=> Time
|
2136
|
-
# resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
|
2306
|
+
# resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted", "error"
|
2137
2307
|
# resp.name #=> String
|
2138
2308
|
# resp.number_of_mount_targets #=> Integer
|
2139
2309
|
# resp.size_in_bytes.value #=> Integer
|
@@ -2145,6 +2315,8 @@ module Aws::EFS
|
|
2145
2315
|
# resp.kms_key_id #=> String
|
2146
2316
|
# resp.throughput_mode #=> String, one of "bursting", "provisioned"
|
2147
2317
|
# resp.provisioned_throughput_in_mibps #=> Float
|
2318
|
+
# resp.availability_zone_name #=> String
|
2319
|
+
# resp.availability_zone_id #=> String
|
2148
2320
|
# resp.tags #=> Array
|
2149
2321
|
# resp.tags[0].key #=> String
|
2150
2322
|
# resp.tags[0].value #=> String
|
@@ -2171,7 +2343,7 @@ module Aws::EFS
|
|
2171
2343
|
params: params,
|
2172
2344
|
config: config)
|
2173
2345
|
context[:gem_name] = 'aws-sdk-efs'
|
2174
|
-
context[:gem_version] = '1.
|
2346
|
+
context[:gem_version] = '1.40.0'
|
2175
2347
|
Seahorse::Client::Request.new(handlers, context)
|
2176
2348
|
end
|
2177
2349
|
|