aws-sdk-efs 1.68.0 → 1.70.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-efs/client.rb +225 -119
- data/lib/aws-sdk-efs/client_api.rb +54 -0
- data/lib/aws-sdk-efs/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-efs/endpoints.rb +14 -0
- data/lib/aws-sdk-efs/errors.rb +42 -0
- data/lib/aws-sdk-efs/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-efs/types.rb +248 -88
- data/lib/aws-sdk-efs.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8d9833a46ade82415822242e86624e7cb8abd4ee841f2f5d7531d70179cfde07
|
4
|
+
data.tar.gz: 0a67296ab993855261e0c1c0d01cee4ccd0acf56245e40430ec52fedf0380d96
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0a260e97791f090c813b122841f6e8e5ba55da73c1f7814bffe9e27da7407cddd72590a9b774345ae149ff1ef8b43550afc04d804ed0b9f985245181c4724da9
|
7
|
+
data.tar.gz: 5ee0ccddfb6f944d0d6d3e9a32c6b0ce181d4908b9f5718c2156074ac351d5fa01f682cc32abc63ca11f236c041dd697d525078d6db3aedd0263654f9a257a29
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.70.0 (2023-11-27)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adding support for EFS Replication to existing file system.
|
8
|
+
|
9
|
+
1.69.0 (2023-11-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Adding support for EFS Archive lifecycle configuration.
|
13
|
+
|
4
14
|
1.68.0 (2023-11-22)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.70.0
|
data/lib/aws-sdk-efs/client.rb
CHANGED
@@ -448,11 +448,11 @@ module Aws::EFS
|
|
448
448
|
# requests made using the access point.
|
449
449
|
#
|
450
450
|
# @option params [Types::RootDirectory] :root_directory
|
451
|
-
# Specifies the directory on the
|
452
|
-
#
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
451
|
+
# Specifies the directory on the EFS file system that the access point
|
452
|
+
# exposes as the root directory of your file system to NFS clients using
|
453
|
+
# the access point. The clients using the access point can only access
|
454
|
+
# the root directory and below. If the `RootDirectory` > `Path`
|
455
|
+
# specified does not exist, Amazon EFS creates it and applies the
|
456
456
|
# `CreationInfo` settings when a client connects to an access point.
|
457
457
|
# When specifying a `RootDirectory`, you must provide the `Path`, and
|
458
458
|
# the `CreationInfo`.
|
@@ -573,12 +573,17 @@ module Aws::EFS
|
|
573
573
|
#
|
574
574
|
# This operation accepts an optional `PerformanceMode` parameter that
|
575
575
|
# you choose for your file system. We recommend `generalPurpose`
|
576
|
-
# performance mode for
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
576
|
+
# performance mode for all file systems. File systems using the `maxIO`
|
577
|
+
# mode is a previous generation performance type that is designed for
|
578
|
+
# highly parallelized workloads that can tolerate higher latencies than
|
579
|
+
# the General Purpose mode. Max I/O mode is not supported for One Zone
|
580
|
+
# file systems or file systems that use Elastic throughput.
|
581
|
+
#
|
582
|
+
# Due to the higher per-operation latencies with Max I/O, we recommend
|
583
|
+
# using General Purpose performance mode for all file systems.
|
584
|
+
#
|
585
|
+
# The performance mode can't be changed after the file system has been
|
586
|
+
# created. For more information, see [Amazon EFS performance modes][2].
|
582
587
|
#
|
583
588
|
# You can set the throughput mode for the file system using the
|
584
589
|
# `ThroughputMode` parameter.
|
@@ -616,17 +621,16 @@ module Aws::EFS
|
|
616
621
|
# not need to pass this option.**
|
617
622
|
#
|
618
623
|
# @option params [String] :performance_mode
|
619
|
-
# The
|
620
|
-
# performance mode for
|
624
|
+
# The Performance mode of the file system. We recommend `generalPurpose`
|
625
|
+
# performance mode for all file systems. File systems using the `maxIO`
|
621
626
|
# performance mode can scale to higher levels of aggregate throughput
|
622
627
|
# and operations per second with a tradeoff of slightly higher latencies
|
623
628
|
# for most file operations. The performance mode can't be changed after
|
624
|
-
# the file system has been created.
|
629
|
+
# the file system has been created. The `maxIO` mode is not supported on
|
630
|
+
# One Zone file systems.
|
625
631
|
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
# </note>
|
632
|
+
# Due to the higher per-operation latencies with Max I/O, we recommend
|
633
|
+
# using General Purpose performance mode for all file systems.
|
630
634
|
#
|
631
635
|
# Default is `generalPurpose`.
|
632
636
|
#
|
@@ -668,10 +672,10 @@ module Aws::EFS
|
|
668
672
|
# `bursting`, `provisioned`, or `elastic`. If you set `ThroughputMode`
|
669
673
|
# to `provisioned`, you must also set a value for
|
670
674
|
# `ProvisionedThroughputInMibps`. After you create the file system, you
|
671
|
-
# can decrease your file system's throughput
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
+
# can decrease your file system's Provisioned throughput or change
|
676
|
+
# between the throughput modes, with certain time restrictions. For more
|
677
|
+
# information, see [Specifying throughput with provisioned mode][1] in
|
678
|
+
# the *Amazon EFS User Guide*.
|
675
679
|
#
|
676
680
|
# Default is `bursting`.
|
677
681
|
#
|
@@ -693,15 +697,14 @@ module Aws::EFS
|
|
693
697
|
# [1]: https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits
|
694
698
|
#
|
695
699
|
# @option params [String] :availability_zone_name
|
696
|
-
# Used to create a file system
|
697
|
-
#
|
698
|
-
#
|
699
|
-
#
|
700
|
-
# classes
|
701
|
-
# Guide*.
|
700
|
+
# Used to create a One Zone file system. It specifies the Amazon Web
|
701
|
+
# Services Availability Zone in which to create the file system. Use the
|
702
|
+
# format `us-east-1a` to specify the Availability Zone. For more
|
703
|
+
# information about One Zone file systems, see [Using EFS storage
|
704
|
+
# classes][1] in the *Amazon EFS User Guide*.
|
702
705
|
#
|
703
|
-
# <note markdown="1"> One Zone
|
704
|
-
#
|
706
|
+
# <note markdown="1"> One Zone file systems are not available in all Availability Zones in
|
707
|
+
# Amazon Web Services Regions where Amazon EFS is available.
|
705
708
|
#
|
706
709
|
# </note>
|
707
710
|
#
|
@@ -712,10 +715,9 @@ module Aws::EFS
|
|
712
715
|
# @option params [Boolean] :backup
|
713
716
|
# Specifies whether automatic backups are enabled on the file system
|
714
717
|
# that you are creating. Set the value to `true` to enable automatic
|
715
|
-
# backups. If you are creating a file system
|
716
|
-
#
|
717
|
-
#
|
718
|
-
# Guide*.
|
718
|
+
# backups. If you are creating a One Zone file system, automatic backups
|
719
|
+
# are enabled by default. For more information, see [Automatic
|
720
|
+
# backups][1] in the *Amazon EFS User Guide*.
|
719
721
|
#
|
720
722
|
# Default is `false`. However, if you specify an `AvailabilityZoneName`,
|
721
723
|
# the default is `true`.
|
@@ -760,6 +762,7 @@ module Aws::EFS
|
|
760
762
|
# * {Types::FileSystemDescription#availability_zone_name #availability_zone_name} => String
|
761
763
|
# * {Types::FileSystemDescription#availability_zone_id #availability_zone_id} => String
|
762
764
|
# * {Types::FileSystemDescription#tags #tags} => Array<Types::Tag>
|
765
|
+
# * {Types::FileSystemDescription#file_system_protection #file_system_protection} => Types::FileSystemProtectionDescription
|
763
766
|
#
|
764
767
|
#
|
765
768
|
# @example Example: To create a new file system
|
@@ -834,6 +837,7 @@ module Aws::EFS
|
|
834
837
|
# resp.size_in_bytes.timestamp #=> Time
|
835
838
|
# resp.size_in_bytes.value_in_ia #=> Integer
|
836
839
|
# resp.size_in_bytes.value_in_standard #=> Integer
|
840
|
+
# resp.size_in_bytes.value_in_archive #=> Integer
|
837
841
|
# resp.performance_mode #=> String, one of "generalPurpose", "maxIO"
|
838
842
|
# resp.encrypted #=> Boolean
|
839
843
|
# resp.kms_key_id #=> String
|
@@ -844,6 +848,7 @@ module Aws::EFS
|
|
844
848
|
# resp.tags #=> Array
|
845
849
|
# resp.tags[0].key #=> String
|
846
850
|
# resp.tags[0].value #=> String
|
851
|
+
# resp.file_system_protection.replication_overwrite_protection #=> String, one of "ENABLED", "DISABLED", "REPLICATING"
|
847
852
|
#
|
848
853
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/CreateFileSystem AWS API Documentation
|
849
854
|
#
|
@@ -864,13 +869,12 @@ module Aws::EFS
|
|
864
869
|
# the subnets. EC2 instances do not need to be in the same subnet as the
|
865
870
|
# mount target in order to access their file system.
|
866
871
|
#
|
867
|
-
# You can create only one mount target for
|
868
|
-
#
|
869
|
-
#
|
870
|
-
# `
|
871
|
-
#
|
872
|
-
#
|
873
|
-
# creating the mount target.
|
872
|
+
# You can create only one mount target for a One Zone file system. You
|
873
|
+
# must create that mount target in the same Availability Zone in which
|
874
|
+
# the file system is located. Use the `AvailabilityZoneName` and
|
875
|
+
# `AvailabiltyZoneId` properties in the DescribeFileSystems response
|
876
|
+
# object to get this information. Use the `subnetId` associated with the
|
877
|
+
# file system's Availability Zone when creating the mount target.
|
874
878
|
#
|
875
879
|
# For more information, see [Amazon EFS: How it Works][1].
|
876
880
|
#
|
@@ -986,9 +990,9 @@ module Aws::EFS
|
|
986
990
|
# The ID of the file system for which to create the mount target.
|
987
991
|
#
|
988
992
|
# @option params [required, String] :subnet_id
|
989
|
-
# The ID of the subnet to add the mount target in. For
|
990
|
-
#
|
991
|
-
#
|
993
|
+
# The ID of the subnet to add the mount target in. For One Zone file
|
994
|
+
# systems, use the subnet that is associated with the file system's
|
995
|
+
# Availability Zone.
|
992
996
|
#
|
993
997
|
# @option params [String] :ip_address
|
994
998
|
# Valid IPv4 address within the address range of the specified subnet.
|
@@ -1067,31 +1071,37 @@ module Aws::EFS
|
|
1067
1071
|
# [Amazon EFS replication][1] in the *Amazon EFS User Guide*. The
|
1068
1072
|
# replication configuration specifies the following:
|
1069
1073
|
#
|
1070
|
-
# * **Source file system**
|
1074
|
+
# * **Source file system** – The EFS file system that you want
|
1071
1075
|
# replicated. The source file system cannot be a destination file
|
1072
1076
|
# system in an existing replication configuration.
|
1073
1077
|
#
|
1074
|
-
# * **
|
1078
|
+
# * **Amazon Web Services Region** – The Amazon Web Services Region in
|
1079
|
+
# which the destination file system is created. Amazon EFS replication
|
1080
|
+
# is available in all Amazon Web Services Regions in which EFS is
|
1081
|
+
# available. The Region must be enabled. For more information, see
|
1082
|
+
# [Managing Amazon Web Services Regions][2] in the *Amazon Web
|
1083
|
+
# Services General Reference Reference Guide*.
|
1084
|
+
#
|
1085
|
+
# * **Destination file system configuration** – The configuration of the
|
1075
1086
|
# destination file system to which the source file system will be
|
1076
1087
|
# replicated. There can only be one destination file system in a
|
1077
|
-
# replication configuration.
|
1078
|
-
#
|
1079
|
-
#
|
1080
|
-
#
|
1081
|
-
#
|
1082
|
-
# replication is
|
1083
|
-
#
|
1084
|
-
#
|
1085
|
-
# information, see [
|
1086
|
-
#
|
1087
|
-
#
|
1088
|
-
# * **Availability Zone**
|
1089
|
-
# use
|
1090
|
-
#
|
1091
|
-
#
|
1092
|
-
#
|
1093
|
-
#
|
1094
|
-
# * **Encryption** - All destination file systems are created with
|
1088
|
+
# replication configuration.
|
1089
|
+
#
|
1090
|
+
# Parameters for the replication configuration include:
|
1091
|
+
#
|
1092
|
+
# * **File system ID** – The ID of the destination file system for the
|
1093
|
+
# replication. If no ID is provided, then EFS creates a new file
|
1094
|
+
# system with the default settings. For existing file systems, the
|
1095
|
+
# file system's replication overwrite protection must be disabled.
|
1096
|
+
# For more information, see [ Replicating to an existing file
|
1097
|
+
# system][3].
|
1098
|
+
#
|
1099
|
+
# * **Availability Zone** – If you want the destination file system to
|
1100
|
+
# use One Zone storage, you must specify the Availability Zone to
|
1101
|
+
# create the file system in. For more information, see [ EFS file
|
1102
|
+
# system types][4] in the *Amazon EFS User Guide*.
|
1103
|
+
#
|
1104
|
+
# * **Encryption** – All destination file systems are created with
|
1095
1105
|
# encryption at rest enabled. You can specify the Key Management
|
1096
1106
|
# Service (KMS) key that is used to encrypt the destination file
|
1097
1107
|
# system. If you don't specify a KMS key, your service-managed KMS
|
@@ -1101,7 +1111,12 @@ module Aws::EFS
|
|
1101
1111
|
#
|
1102
1112
|
# </note>
|
1103
1113
|
#
|
1104
|
-
#
|
1114
|
+
# <note markdown="1"> After the file system is created, you cannot change the KMS key.
|
1115
|
+
#
|
1116
|
+
# </note>
|
1117
|
+
#
|
1118
|
+
# For new destination file systems, the following properties are set by
|
1119
|
+
# default:
|
1105
1120
|
#
|
1106
1121
|
# * **Performance mode** - The destination file system's performance
|
1107
1122
|
# mode matches that of the source file system, unless the destination
|
@@ -1112,15 +1127,13 @@ module Aws::EFS
|
|
1112
1127
|
# * **Throughput mode** - The destination file system's throughput mode
|
1113
1128
|
# matches that of the source file system. After the file system is
|
1114
1129
|
# created, you can modify the throughput mode.
|
1130
|
+
# ^
|
1115
1131
|
#
|
1116
|
-
#
|
1117
|
-
#
|
1118
|
-
#
|
1119
|
-
# Intelligent-Tiering are not enabled on the destination file system.
|
1120
|
-
# After the destination file system is created, you can enable EFS
|
1121
|
-
# lifecycle management and EFS Intelligent-Tiering.
|
1132
|
+
# * **Lifecycle management** – Lifecycle management is not enabled on
|
1133
|
+
# the destination file system. After the destination file system is
|
1134
|
+
# created, you can enable lifecycle management.
|
1122
1135
|
#
|
1123
|
-
# * **Automatic backups**
|
1136
|
+
# * **Automatic backups** – Automatic daily backups are enabled on the
|
1124
1137
|
# destination file system. After the file system is created, you can
|
1125
1138
|
# change this setting.
|
1126
1139
|
#
|
@@ -1131,7 +1144,8 @@ module Aws::EFS
|
|
1131
1144
|
#
|
1132
1145
|
# [1]: https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html
|
1133
1146
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable
|
1134
|
-
# [3]: https://docs.aws.amazon.com/efs/latest/ug/
|
1147
|
+
# [3]: https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination
|
1148
|
+
# [4]: https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html
|
1135
1149
|
#
|
1136
1150
|
# @option params [required, String] :source_file_system_id
|
1137
1151
|
# Specifies the Amazon EFS file system that you want to replicate. This
|
@@ -1160,6 +1174,7 @@ module Aws::EFS
|
|
1160
1174
|
# region: "RegionName",
|
1161
1175
|
# availability_zone_name: "AvailabilityZoneName",
|
1162
1176
|
# kms_key_id: "KmsKeyId",
|
1177
|
+
# file_system_id: "FileSystemId",
|
1163
1178
|
# },
|
1164
1179
|
# ],
|
1165
1180
|
# })
|
@@ -1429,11 +1444,18 @@ module Aws::EFS
|
|
1429
1444
|
req.send_request(options)
|
1430
1445
|
end
|
1431
1446
|
|
1432
|
-
# Deletes
|
1447
|
+
# Deletes a replication configuration. Deleting a replication
|
1433
1448
|
# configuration ends the replication process. After a replication
|
1434
|
-
# configuration is deleted, the destination file system
|
1435
|
-
#
|
1436
|
-
#
|
1449
|
+
# configuration is deleted, the destination file system becomes
|
1450
|
+
# `Writeable` and its replication overwrite protection is re-enabled.
|
1451
|
+
# For more information, see [Delete a replication configuration][1].
|
1452
|
+
#
|
1453
|
+
# This operation requires permissions for the
|
1454
|
+
# `elasticfilesystem:DeleteReplicationConfiguration` action.
|
1455
|
+
#
|
1456
|
+
#
|
1457
|
+
#
|
1458
|
+
# [1]: https://docs.aws.amazon.com/efs/latest/ug/delete-replications.html
|
1437
1459
|
#
|
1438
1460
|
# @option params [required, String] :source_file_system_id
|
1439
1461
|
# The ID of the source file system in the replication configuration.
|
@@ -1629,7 +1651,8 @@ module Aws::EFS
|
|
1629
1651
|
# Returns the backup policy for the specified EFS file system.
|
1630
1652
|
#
|
1631
1653
|
# @option params [required, String] :file_system_id
|
1632
|
-
# Specifies which EFS file system to retrieve the
|
1654
|
+
# Specifies which EFS file system for which to retrieve the
|
1655
|
+
# `BackupPolicy`.
|
1633
1656
|
#
|
1634
1657
|
# @return [Types::BackupPolicyDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1635
1658
|
#
|
@@ -1801,6 +1824,7 @@ module Aws::EFS
|
|
1801
1824
|
# resp.file_systems[0].size_in_bytes.timestamp #=> Time
|
1802
1825
|
# resp.file_systems[0].size_in_bytes.value_in_ia #=> Integer
|
1803
1826
|
# resp.file_systems[0].size_in_bytes.value_in_standard #=> Integer
|
1827
|
+
# resp.file_systems[0].size_in_bytes.value_in_archive #=> Integer
|
1804
1828
|
# resp.file_systems[0].performance_mode #=> String, one of "generalPurpose", "maxIO"
|
1805
1829
|
# resp.file_systems[0].encrypted #=> Boolean
|
1806
1830
|
# resp.file_systems[0].kms_key_id #=> String
|
@@ -1811,6 +1835,7 @@ module Aws::EFS
|
|
1811
1835
|
# resp.file_systems[0].tags #=> Array
|
1812
1836
|
# resp.file_systems[0].tags[0].key #=> String
|
1813
1837
|
# resp.file_systems[0].tags[0].value #=> String
|
1838
|
+
# resp.file_systems[0].file_system_protection.replication_overwrite_protection #=> String, one of "ENABLED", "DISABLED", "REPLICATING"
|
1814
1839
|
# resp.next_marker #=> String
|
1815
1840
|
#
|
1816
1841
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeFileSystems AWS API Documentation
|
@@ -1823,14 +1848,10 @@ module Aws::EFS
|
|
1823
1848
|
end
|
1824
1849
|
|
1825
1850
|
# Returns the current `LifecycleConfiguration` object for the specified
|
1826
|
-
# Amazon EFS file system.
|
1827
|
-
# `LifecycleConfiguration` object to identify
|
1828
|
-
#
|
1829
|
-
#
|
1830
|
-
# the response.
|
1831
|
-
#
|
1832
|
-
# When EFS Intelligent-Tiering is enabled,
|
1833
|
-
# `TransitionToPrimaryStorageClass` has a value of `AFTER_1_ACCESS`.
|
1851
|
+
# Amazon EFS file system. Lifecycle management uses the
|
1852
|
+
# `LifecycleConfiguration` object to identify when to move files between
|
1853
|
+
# storage classes. For a file system without a `LifecycleConfiguration`
|
1854
|
+
# object, the call returns an empty array in the response.
|
1834
1855
|
#
|
1835
1856
|
# This operation requires permissions for the
|
1836
1857
|
# `elasticfilesystem:DescribeLifecycleConfiguration` operation.
|
@@ -1871,8 +1892,9 @@ module Aws::EFS
|
|
1871
1892
|
# @example Response structure
|
1872
1893
|
#
|
1873
1894
|
# resp.lifecycle_policies #=> Array
|
1874
|
-
# resp.lifecycle_policies[0].transition_to_ia #=> String, one of "AFTER_7_DAYS", "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS", "AFTER_1_DAY"
|
1895
|
+
# resp.lifecycle_policies[0].transition_to_ia #=> String, one of "AFTER_7_DAYS", "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS", "AFTER_1_DAY", "AFTER_180_DAYS", "AFTER_270_DAYS", "AFTER_365_DAYS"
|
1875
1896
|
# resp.lifecycle_policies[0].transition_to_primary_storage_class #=> String, one of "AFTER_1_ACCESS"
|
1897
|
+
# resp.lifecycle_policies[0].transition_to_archive #=> String, one of "AFTER_1_DAY", "AFTER_7_DAYS", "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS", "AFTER_180_DAYS", "AFTER_270_DAYS", "AFTER_365_DAYS"
|
1876
1898
|
#
|
1877
1899
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration AWS API Documentation
|
1878
1900
|
#
|
@@ -1983,6 +2005,8 @@ module Aws::EFS
|
|
1983
2005
|
# * {Types::DescribeMountTargetsResponse#mount_targets #mount_targets} => Array<Types::MountTargetDescription>
|
1984
2006
|
# * {Types::DescribeMountTargetsResponse#next_marker #next_marker} => String
|
1985
2007
|
#
|
2008
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2009
|
+
#
|
1986
2010
|
#
|
1987
2011
|
# @example Example: To describe the mount targets for a file system
|
1988
2012
|
#
|
@@ -2064,6 +2088,8 @@ module Aws::EFS
|
|
2064
2088
|
# * {Types::DescribeReplicationConfigurationsResponse#replications #replications} => Array<Types::ReplicationConfigurationDescription>
|
2065
2089
|
# * {Types::DescribeReplicationConfigurationsResponse#next_token #next_token} => String
|
2066
2090
|
#
|
2091
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2092
|
+
#
|
2067
2093
|
# @example Request syntax with placeholder values
|
2068
2094
|
#
|
2069
2095
|
# resp = client.describe_replication_configurations({
|
@@ -2444,25 +2470,36 @@ module Aws::EFS
|
|
2444
2470
|
req.send_request(options)
|
2445
2471
|
end
|
2446
2472
|
|
2447
|
-
# Use this action to manage
|
2448
|
-
#
|
2449
|
-
#
|
2473
|
+
# Use this action to manage storage for your file system. A
|
2474
|
+
# `LifecycleConfiguration` consists of one or more `LifecyclePolicy`
|
2475
|
+
# objects that define the following:
|
2476
|
+
#
|
2477
|
+
# * <b> <code>TransitionToIA</code> </b> – When to move files in the
|
2478
|
+
# file system from primary storage (Standard storage class) into the
|
2479
|
+
# Infrequent Access (IA) storage.
|
2480
|
+
#
|
2481
|
+
# * <b> <code>TransitionToArchive</code> </b> – When to move files in
|
2482
|
+
# the file system from their current storage class (either IA or
|
2483
|
+
# Standard storage) into the Archive storage.
|
2450
2484
|
#
|
2451
|
-
#
|
2452
|
-
#
|
2453
|
-
#
|
2485
|
+
# File systems cannot transition into Archive storage before
|
2486
|
+
# transitioning into IA storage. Therefore, TransitionToArchive must
|
2487
|
+
# either not be set or must be later than TransitionToIA.
|
2454
2488
|
#
|
2455
|
-
#
|
2456
|
-
#
|
2489
|
+
# <note markdown="1"> The Archive storage class is available only for file systems that
|
2490
|
+
# use the Elastic Throughput mode and the General Purpose Performance
|
2491
|
+
# mode.
|
2457
2492
|
#
|
2458
|
-
#
|
2459
|
-
#
|
2460
|
-
# storage class (EFS Standard or EFS One Zone Standard).
|
2493
|
+
# </note>
|
2494
|
+
# ^
|
2461
2495
|
#
|
2462
|
-
#
|
2463
|
-
#
|
2496
|
+
# * <b> <code>TransitionToPrimaryStorageClass</code> </b> – Whether to
|
2497
|
+
# move files in the file system back to primary storage (Standard
|
2498
|
+
# storage class) after they are accessed in IA or Archive storage.
|
2499
|
+
#
|
2500
|
+
# ^
|
2464
2501
|
#
|
2465
|
-
# For more information, see [
|
2502
|
+
# For more information, see [ Managing file system storage][1].
|
2466
2503
|
#
|
2467
2504
|
# Each Amazon EFS file system supports one lifecycle configuration,
|
2468
2505
|
# which applies to all files in the file system. If a
|
@@ -2470,17 +2507,14 @@ module Aws::EFS
|
|
2470
2507
|
# system, a `PutLifecycleConfiguration` call modifies the existing
|
2471
2508
|
# configuration. A `PutLifecycleConfiguration` call with an empty
|
2472
2509
|
# `LifecyclePolicies` array in the request body deletes any existing
|
2473
|
-
# `LifecycleConfiguration
|
2474
|
-
# Intelligent-Tiering for the file system.
|
2475
|
-
#
|
2476
|
-
# In the request, specify the following:
|
2510
|
+
# `LifecycleConfiguration`. In the request, specify the following:
|
2477
2511
|
#
|
2478
2512
|
# * The ID for the file system for which you are enabling, disabling, or
|
2479
|
-
# modifying
|
2513
|
+
# modifying Lifecycle management.
|
2480
2514
|
#
|
2481
2515
|
# * A `LifecyclePolicies` array of `LifecyclePolicy` objects that define
|
2482
|
-
# when
|
2483
|
-
#
|
2516
|
+
# when to move files to IA storage, to Archive storage, and back to
|
2517
|
+
# primary storage.
|
2484
2518
|
#
|
2485
2519
|
# <note markdown="1"> Amazon EFS requires that each `LifecyclePolicy` object have only
|
2486
2520
|
# have a single transition, so the `LifecyclePolicies` array needs to
|
@@ -2507,21 +2541,37 @@ module Aws::EFS
|
|
2507
2541
|
# @option params [required, Array<Types::LifecyclePolicy>] :lifecycle_policies
|
2508
2542
|
# An array of `LifecyclePolicy` objects that define the file system's
|
2509
2543
|
# `LifecycleConfiguration` object. A `LifecycleConfiguration` object
|
2510
|
-
# informs EFS
|
2511
|
-
#
|
2544
|
+
# informs EFS Lifecycle management of the following:
|
2545
|
+
#
|
2546
|
+
# * <b> <code>TransitionToIA</code> </b> – When to move files in the
|
2547
|
+
# file system from primary storage (Standard storage class) into the
|
2548
|
+
# Infrequent Access (IA) storage.
|
2549
|
+
#
|
2550
|
+
# * <b> <code>TransitionToArchive</code> </b> – When to move files in
|
2551
|
+
# the file system from their current storage class (either IA or
|
2552
|
+
# Standard storage) into the Archive storage.
|
2553
|
+
#
|
2554
|
+
# File systems cannot transition into Archive storage before
|
2555
|
+
# transitioning into IA storage. Therefore, TransitionToArchive must
|
2556
|
+
# either not be set or must be later than TransitionToIA.
|
2512
2557
|
#
|
2513
|
-
#
|
2514
|
-
#
|
2558
|
+
# <note markdown="1"> The Archive storage class is available only for file systems that
|
2559
|
+
# use the Elastic Throughput mode and the General Purpose Performance
|
2560
|
+
# mode.
|
2515
2561
|
#
|
2516
|
-
#
|
2562
|
+
# </note>
|
2563
|
+
#
|
2564
|
+
# * <b> <code>TransitionToPrimaryStorageClass</code> </b> – Whether to
|
2565
|
+
# move files in the file system back to primary storage (Standard
|
2566
|
+
# storage class) after they are accessed in IA or Archive storage.
|
2517
2567
|
#
|
2518
2568
|
# <note markdown="1"> When using the `put-lifecycle-configuration` CLI command or the
|
2519
2569
|
# `PutLifecycleConfiguration` API action, Amazon EFS requires that each
|
2520
2570
|
# `LifecyclePolicy` object have only a single transition. This means
|
2521
2571
|
# that in a request body, `LifecyclePolicies` must be structured as an
|
2522
|
-
# array of `LifecyclePolicy` objects, one object for each
|
2523
|
-
#
|
2524
|
-
#
|
2572
|
+
# array of `LifecyclePolicy` objects, one object for each storage
|
2573
|
+
# transition. See the example requests in the following section for more
|
2574
|
+
# information.
|
2525
2575
|
#
|
2526
2576
|
# </note>
|
2527
2577
|
#
|
@@ -2560,8 +2610,9 @@ module Aws::EFS
|
|
2560
2610
|
# file_system_id: "FileSystemId", # required
|
2561
2611
|
# lifecycle_policies: [ # required
|
2562
2612
|
# {
|
2563
|
-
# transition_to_ia: "AFTER_7_DAYS", # accepts AFTER_7_DAYS, AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, AFTER_90_DAYS, AFTER_1_DAY
|
2613
|
+
# transition_to_ia: "AFTER_7_DAYS", # accepts AFTER_7_DAYS, AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, AFTER_90_DAYS, AFTER_1_DAY, AFTER_180_DAYS, AFTER_270_DAYS, AFTER_365_DAYS
|
2564
2614
|
# transition_to_primary_storage_class: "AFTER_1_ACCESS", # accepts AFTER_1_ACCESS
|
2615
|
+
# transition_to_archive: "AFTER_1_DAY", # accepts AFTER_1_DAY, AFTER_7_DAYS, AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, AFTER_90_DAYS, AFTER_180_DAYS, AFTER_270_DAYS, AFTER_365_DAYS
|
2565
2616
|
# },
|
2566
2617
|
# ],
|
2567
2618
|
# })
|
@@ -2569,8 +2620,9 @@ module Aws::EFS
|
|
2569
2620
|
# @example Response structure
|
2570
2621
|
#
|
2571
2622
|
# resp.lifecycle_policies #=> Array
|
2572
|
-
# resp.lifecycle_policies[0].transition_to_ia #=> String, one of "AFTER_7_DAYS", "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS", "AFTER_1_DAY"
|
2623
|
+
# resp.lifecycle_policies[0].transition_to_ia #=> String, one of "AFTER_7_DAYS", "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS", "AFTER_1_DAY", "AFTER_180_DAYS", "AFTER_270_DAYS", "AFTER_365_DAYS"
|
2573
2624
|
# resp.lifecycle_policies[0].transition_to_primary_storage_class #=> String, one of "AFTER_1_ACCESS"
|
2625
|
+
# resp.lifecycle_policies[0].transition_to_archive #=> String, one of "AFTER_1_DAY", "AFTER_7_DAYS", "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS", "AFTER_180_DAYS", "AFTER_270_DAYS", "AFTER_365_DAYS"
|
2574
2626
|
#
|
2575
2627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/PutLifecycleConfiguration AWS API Documentation
|
2576
2628
|
#
|
@@ -2693,6 +2745,7 @@ module Aws::EFS
|
|
2693
2745
|
# * {Types::FileSystemDescription#availability_zone_name #availability_zone_name} => String
|
2694
2746
|
# * {Types::FileSystemDescription#availability_zone_id #availability_zone_id} => String
|
2695
2747
|
# * {Types::FileSystemDescription#tags #tags} => Array<Types::Tag>
|
2748
|
+
# * {Types::FileSystemDescription#file_system_protection #file_system_protection} => Types::FileSystemProtectionDescription
|
2696
2749
|
#
|
2697
2750
|
# @example Request syntax with placeholder values
|
2698
2751
|
#
|
@@ -2716,6 +2769,7 @@ module Aws::EFS
|
|
2716
2769
|
# resp.size_in_bytes.timestamp #=> Time
|
2717
2770
|
# resp.size_in_bytes.value_in_ia #=> Integer
|
2718
2771
|
# resp.size_in_bytes.value_in_standard #=> Integer
|
2772
|
+
# resp.size_in_bytes.value_in_archive #=> Integer
|
2719
2773
|
# resp.performance_mode #=> String, one of "generalPurpose", "maxIO"
|
2720
2774
|
# resp.encrypted #=> Boolean
|
2721
2775
|
# resp.kms_key_id #=> String
|
@@ -2726,6 +2780,7 @@ module Aws::EFS
|
|
2726
2780
|
# resp.tags #=> Array
|
2727
2781
|
# resp.tags[0].key #=> String
|
2728
2782
|
# resp.tags[0].value #=> String
|
2783
|
+
# resp.file_system_protection.replication_overwrite_protection #=> String, one of "ENABLED", "DISABLED", "REPLICATING"
|
2729
2784
|
#
|
2730
2785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UpdateFileSystem AWS API Documentation
|
2731
2786
|
#
|
@@ -2736,6 +2791,57 @@ module Aws::EFS
|
|
2736
2791
|
req.send_request(options)
|
2737
2792
|
end
|
2738
2793
|
|
2794
|
+
# Updates protection on the file system.
|
2795
|
+
#
|
2796
|
+
# This operation requires permissions for the
|
2797
|
+
# `elasticfilesystem:UpdateFileSystemProtection` action.
|
2798
|
+
#
|
2799
|
+
# @option params [required, String] :file_system_id
|
2800
|
+
# The ID of the file system to update.
|
2801
|
+
#
|
2802
|
+
# @option params [String] :replication_overwrite_protection
|
2803
|
+
# The status of the file system's replication overwrite protection.
|
2804
|
+
#
|
2805
|
+
# * `ENABLED` – The file system cannot be used as the destination file
|
2806
|
+
# system in a replication configuration. The file system is writeable.
|
2807
|
+
# Replication overwrite protection is `ENABLED` by default.
|
2808
|
+
#
|
2809
|
+
# * `DISABLED` – The file system can be used as the destination file
|
2810
|
+
# system in a replication configuration. The file system is read-only
|
2811
|
+
# and can only be modified by EFS replication.
|
2812
|
+
#
|
2813
|
+
# * `REPLICATING` – The file system is being used as the destination
|
2814
|
+
# file system in a replication configuration. The file system is
|
2815
|
+
# read-only and is only modified only by EFS replication.
|
2816
|
+
#
|
2817
|
+
# If the replication configuration is deleted, the file system's
|
2818
|
+
# replication overwrite protection is re-enabled, the file system
|
2819
|
+
# becomes writeable.
|
2820
|
+
#
|
2821
|
+
# @return [Types::FileSystemProtectionDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2822
|
+
#
|
2823
|
+
# * {Types::FileSystemProtectionDescription#replication_overwrite_protection #replication_overwrite_protection} => String
|
2824
|
+
#
|
2825
|
+
# @example Request syntax with placeholder values
|
2826
|
+
#
|
2827
|
+
# resp = client.update_file_system_protection({
|
2828
|
+
# file_system_id: "FileSystemId", # required
|
2829
|
+
# replication_overwrite_protection: "ENABLED", # accepts ENABLED, DISABLED, REPLICATING
|
2830
|
+
# })
|
2831
|
+
#
|
2832
|
+
# @example Response structure
|
2833
|
+
#
|
2834
|
+
# resp.replication_overwrite_protection #=> String, one of "ENABLED", "DISABLED", "REPLICATING"
|
2835
|
+
#
|
2836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UpdateFileSystemProtection AWS API Documentation
|
2837
|
+
#
|
2838
|
+
# @overload update_file_system_protection(params = {})
|
2839
|
+
# @param [Hash] params ({})
|
2840
|
+
def update_file_system_protection(params = {}, options = {})
|
2841
|
+
req = build_request(:update_file_system_protection, params)
|
2842
|
+
req.send_request(options)
|
2843
|
+
end
|
2844
|
+
|
2739
2845
|
# @!endgroup
|
2740
2846
|
|
2741
2847
|
# @param params ({})
|
@@ -2749,7 +2855,7 @@ module Aws::EFS
|
|
2749
2855
|
params: params,
|
2750
2856
|
config: config)
|
2751
2857
|
context[:gem_name] = 'aws-sdk-efs'
|
2752
|
-
context[:gem_version] = '1.
|
2858
|
+
context[:gem_version] = '1.70.0'
|
2753
2859
|
Seahorse::Client::Request.new(handlers, context)
|
2754
2860
|
end
|
2755
2861
|
|