@aws-sdk/client-efs 3.67.0 → 3.74.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +4 -4
- package/dist-cjs/models/models_0.js +17 -2
- package/dist-cjs/protocols/Aws_restJson1.js +18 -0
- package/dist-es/models/models_0.js +14 -0
- package/dist-es/protocols/Aws_restJson1.js +22 -3
- package/dist-types/EFS.d.ts +106 -72
- package/dist-types/EFSClient.d.ts +4 -4
- package/dist-types/commands/CreateAccessPointCommand.d.ts +2 -2
- package/dist-types/commands/CreateReplicationConfigurationCommand.d.ts +45 -36
- package/dist-types/commands/CreateTagsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteFileSystemCommand.d.ts +7 -0
- package/dist-types/commands/DeleteReplicationConfigurationCommand.d.ts +6 -5
- package/dist-types/commands/DeleteTagsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeLifecycleConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DescribeReplicationConfigurationsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeTagsCommand.d.ts +3 -2
- package/dist-types/commands/PutAccountPreferencesCommand.d.ts +3 -2
- package/dist-types/commands/PutLifecycleConfigurationCommand.d.ts +27 -14
- package/dist-types/models/models_0.d.ts +112 -71
- package/dist-types/ts3.4/models/models_0.d.ts +11 -0
- package/package.json +7 -7
|
@@ -7,44 +7,50 @@ export interface CreateReplicationConfigurationCommandInput extends CreateReplic
|
|
|
7
7
|
export interface CreateReplicationConfigurationCommandOutput extends ReplicationConfigurationDescription, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a replication configuration that replicates an existing EFS file
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
10
|
+
* <p>Creates a replication configuration that replicates an existing EFS file system to a new,
|
|
11
|
+
* read-only file system. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the
|
|
12
|
+
* <i>Amazon EFS User Guide</i>. The replication configuration
|
|
13
|
+
* specifies the following:</p>
|
|
14
14
|
* <ul>
|
|
15
15
|
* <li>
|
|
16
16
|
* <p>
|
|
17
|
-
* <b>Source file system</b> -
|
|
18
|
-
*
|
|
19
|
-
*
|
|
17
|
+
* <b>Source file system</b> - An existing EFS file system that you
|
|
18
|
+
* want replicated. The source file system cannot be a destination file system in an existing
|
|
19
|
+
* replication configuration.</p>
|
|
20
20
|
* </li>
|
|
21
21
|
* <li>
|
|
22
22
|
* <p>
|
|
23
|
-
* <b>Destination file system configuration</b>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
23
|
+
* <b>Destination file system configuration</b> - The configuration of
|
|
24
|
+
* the destination file system to which the source file system will be replicated. There can
|
|
25
|
+
* only be one destination file system in a replication configuration. The destination file
|
|
26
|
+
* system configuration consists of the following properties:</p>
|
|
27
27
|
* <ul>
|
|
28
28
|
* <li>
|
|
29
29
|
* <p>
|
|
30
|
-
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in
|
|
31
|
+
* which the destination file system is created. Amazon EFS replication is
|
|
32
|
+
* available in all Amazon Web Services Regions that Amazon EFS is available in,
|
|
33
|
+
* except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe
|
|
34
|
+
* (Milan), and Middle East (Bahrain).</p>
|
|
33
35
|
* </li>
|
|
34
36
|
* <li>
|
|
35
37
|
* <p>
|
|
36
|
-
* <b>Availability
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
38
|
+
* <b>Availability Zone</b> - If you want the destination file system
|
|
39
|
+
* to use EFS One Zone availability and durability, you must specify the Availability
|
|
40
|
+
* Zone to create the file system in. For more information about EFS storage classes, see
|
|
41
|
+
* <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">
|
|
42
|
+
* Amazon EFS storage classes</a> in the <i>Amazon EFS User
|
|
43
|
+
* Guide</i>.</p>
|
|
40
44
|
* </li>
|
|
41
45
|
* <li>
|
|
42
46
|
* <p>
|
|
43
|
-
* <b>Encryption</b> - All destination file systems are
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
47
|
+
* <b>Encryption</b> - All destination file systems are created with
|
|
48
|
+
* encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't
|
|
49
|
+
* specify a KMS key, your service-managed KMS key for
|
|
50
|
+
* Amazon EFS is used. </p>
|
|
51
|
+
* <note>
|
|
52
|
+
* <p>After the file system is created, you cannot change the KMS key.</p>
|
|
53
|
+
* </note>
|
|
48
54
|
* </li>
|
|
49
55
|
* </ul>
|
|
50
56
|
* </li>
|
|
@@ -54,16 +60,16 @@ export interface CreateReplicationConfigurationCommandOutput extends Replication
|
|
|
54
60
|
* <ul>
|
|
55
61
|
* <li>
|
|
56
62
|
* <p>
|
|
57
|
-
* <b>Performance mode</b> - The destination file system's
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
63
|
+
* <b>Performance mode</b> - The destination file system's performance
|
|
64
|
+
* mode matches that of the source file system, unless the destination file system uses EFS
|
|
65
|
+
* One Zone storage. In that case, the General Purpose performance mode is used. The
|
|
66
|
+
* performance mode cannot be changed.</p>
|
|
61
67
|
* </li>
|
|
62
68
|
* <li>
|
|
63
69
|
* <p>
|
|
64
|
-
* <b>Throughput mode</b> - The destination file system
|
|
65
|
-
*
|
|
66
|
-
*
|
|
70
|
+
* <b>Throughput mode</b> - The destination file system uses the
|
|
71
|
+
* Bursting Throughput mode by default. After the file system is created, you can modify the
|
|
72
|
+
* throughput mode.</p>
|
|
67
73
|
* </li>
|
|
68
74
|
* </ul>
|
|
69
75
|
*
|
|
@@ -71,18 +77,21 @@ export interface CreateReplicationConfigurationCommandOutput extends Replication
|
|
|
71
77
|
* <ul>
|
|
72
78
|
* <li>
|
|
73
79
|
* <p>
|
|
74
|
-
* <b>Lifecycle management</b> - EFS lifecycle
|
|
75
|
-
*
|
|
76
|
-
*
|
|
80
|
+
* <b>Lifecycle management</b> - EFS lifecycle management and EFS
|
|
81
|
+
* Intelligent-Tiering are not enabled on the destination file system. After the destination
|
|
82
|
+
* file system is created, you can enable EFS lifecycle management and EFS
|
|
83
|
+
* Intelligent-Tiering.</p>
|
|
77
84
|
* </li>
|
|
78
85
|
* <li>
|
|
79
86
|
* <p>
|
|
80
|
-
* <b>Automatic backups</b> - Automatic daily backups
|
|
81
|
-
*
|
|
87
|
+
* <b>Automatic backups</b> - Automatic daily backups not enabled on
|
|
88
|
+
* the destination file system. After the file system is created, you can change this
|
|
89
|
+
* setting.</p>
|
|
82
90
|
* </li>
|
|
83
91
|
* </ul>
|
|
84
92
|
*
|
|
85
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a
|
|
93
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the
|
|
94
|
+
* <i>Amazon EFS User Guide</i>.</p>
|
|
86
95
|
* @example
|
|
87
96
|
* Use a bare-bones client and the command you need to make an API call.
|
|
88
97
|
* ```javascript
|
|
@@ -10,8 +10,8 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
* @deprecated
|
|
11
11
|
*
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>DEPRECATED - CreateTags is deprecated and not maintained.
|
|
14
|
-
*
|
|
13
|
+
* <p>DEPRECATED - <code>CreateTags</code> is deprecated and not maintained. To create tags for EFS
|
|
14
|
+
* resources, use the API action.</p>
|
|
15
15
|
* </note>
|
|
16
16
|
* <p>Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If
|
|
17
17
|
* a tag key specified in the request already exists on the file system, this operation
|
|
@@ -10,6 +10,13 @@ export interface DeleteFileSystemCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
* <p>Deletes a file system, permanently severing access to its contents. Upon return, the
|
|
11
11
|
* file system no longer exists and you can't access any contents of the deleted file
|
|
12
12
|
* system.</p>
|
|
13
|
+
* <p>You need to manually delete mount targets attached to a file system before you can delete
|
|
14
|
+
* an EFS file system. This step is performed for you when you use the Amazon Web Services console
|
|
15
|
+
* to delete a file system.</p>
|
|
16
|
+
* <note>
|
|
17
|
+
* <p>You cannot delete a file system that is part of an EFS Replication configuration.
|
|
18
|
+
* You need to delete the replication configuration first.</p>
|
|
19
|
+
* </note>
|
|
13
20
|
* <p> You can't delete a file system that is in use. That is, if the file system has
|
|
14
21
|
* any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </p>
|
|
15
22
|
*
|
|
@@ -7,11 +7,12 @@ export interface DeleteReplicationConfigurationCommandInput extends DeleteReplic
|
|
|
7
7
|
export interface DeleteReplicationConfigurationCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes an existing replication configuration.
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* configuration
|
|
14
|
-
* system
|
|
10
|
+
* <p>Deletes an existing replication configuration. To delete a replication configuration, you
|
|
11
|
+
* must make the request from the Amazon Web Services Region in which the destination file system
|
|
12
|
+
* is located. Deleting a replication configuration ends the replication process. After a
|
|
13
|
+
* replication configuration is deleted, the destination file system is no longer read-only. You
|
|
14
|
+
* can write to the destination file system after its status becomes
|
|
15
|
+
* <code>Writeable</code>.</p>
|
|
15
16
|
* @example
|
|
16
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
18
|
* ```javascript
|
|
@@ -10,8 +10,8 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
* @deprecated
|
|
11
11
|
*
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>DEPRECATED - DeleteTags is deprecated and not maintained.
|
|
14
|
-
*
|
|
13
|
+
* <p>DEPRECATED - <code>DeleteTags</code> is deprecated and not maintained. To remove tags from EFS
|
|
14
|
+
* resources, use the API action.</p>
|
|
15
15
|
* </note>
|
|
16
16
|
* <p>Deletes the specified tags from a file system. If the <code>DeleteTags</code> request
|
|
17
17
|
* includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an
|
|
@@ -12,7 +12,8 @@ export interface DescribeLifecycleConfigurationCommandOutput extends LifecycleCo
|
|
|
12
12
|
* to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system
|
|
13
13
|
* without a <code>LifecycleConfiguration</code> object, the call returns an empty array in the
|
|
14
14
|
* response.</p>
|
|
15
|
-
* <p>When EFS Intelligent
|
|
15
|
+
* <p>When EFS Intelligent-Tiering is enabled, <code>TransitionToPrimaryStorageClass</code> has
|
|
16
|
+
* a value of <code>AFTER_1_ACCESS</code>.</p>
|
|
16
17
|
* <p>This operation requires permissions for the
|
|
17
18
|
* <code>elasticfilesystem:DescribeLifecycleConfiguration</code> operation.</p>
|
|
18
19
|
* @example
|
|
@@ -7,8 +7,9 @@ export interface DescribeReplicationConfigurationsCommandInput extends DescribeR
|
|
|
7
7
|
export interface DescribeReplicationConfigurationsCommandOutput extends DescribeReplicationConfigurationsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves the replication
|
|
11
|
-
*
|
|
10
|
+
* <p>Retrieves the replication configuration for a specific file system. If a file system is
|
|
11
|
+
* not specified, all of the replication configurations for the Amazon Web Services account in an
|
|
12
|
+
* Amazon Web Services Region are retrieved.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -10,8 +10,9 @@ export interface DescribeTagsCommandOutput extends DescribeTagsResponse, __Metad
|
|
|
10
10
|
* @deprecated
|
|
11
11
|
*
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>DEPRECATED - The
|
|
14
|
-
*
|
|
13
|
+
* <p>DEPRECATED - The <code>DescribeTags</code> action is deprecated and not maintained. To view
|
|
14
|
+
* tags associated with EFS resources, use the <code>ListTagsForResource</code> API
|
|
15
|
+
* action.</p>
|
|
15
16
|
* </note>
|
|
16
17
|
* <p>Returns the tags associated with a file system. The order of tags returned in the
|
|
17
18
|
* response of one <code>DescribeTags</code> call and the order of tags returned across the
|
|
@@ -14,8 +14,9 @@ export interface PutAccountPreferencesCommandOutput extends PutAccountPreference
|
|
|
14
14
|
* opt-in period as EFS transitions to long resource IDs. For more information,
|
|
15
15
|
* see <a href="https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html">Managing Amazon EFS resource IDs</a>.</p>
|
|
16
16
|
* <note>
|
|
17
|
-
* <p>Starting in October, 2021, you will receive an error if you try to set the account preference
|
|
18
|
-
*
|
|
17
|
+
* <p>Starting in October, 2021, you will receive an error if you try to set the account preference
|
|
18
|
+
* to use the short 8 character format resource ID. Contact Amazon Web Services support if you
|
|
19
|
+
* receive an error and must use short IDs for file system and mount target resources.</p>
|
|
19
20
|
* </note>
|
|
20
21
|
* @example
|
|
21
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,38 +7,51 @@ export interface PutLifecycleConfigurationCommandInput extends PutLifecycleConfi
|
|
|
7
7
|
export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigurationDescription, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Use this action to manage EFS lifecycle management and intelligent tiering. A
|
|
11
|
+
* <code>LifecycleConfiguration</code> consists of one or more <code>LifecyclePolicy</code> objects that
|
|
12
|
+
* define the following:</p>
|
|
13
|
+
* <ul>
|
|
14
|
+
* <li>
|
|
15
|
+
* <p>
|
|
16
|
+
* <b>EFS Lifecycle management</b> - When Amazon EFS
|
|
17
|
+
* automatically transitions files in a file system into the lower-cost Infrequent Access (IA) storage class.</p>
|
|
18
|
+
* <p>To enable EFS Lifecycle management, set the value of <code>TransitionToIA</code> to one of the available options.</p>
|
|
19
|
+
* </li>
|
|
20
|
+
* <li>
|
|
21
|
+
* <p>
|
|
22
|
+
* <b>EFS Intelligent tiering</b> - When Amazon EFS
|
|
23
|
+
* automatically transitions files from IA back into the file system's primary storage class (Standard or One Zone Standard.</p>
|
|
24
|
+
* <p>To enable EFS Intelligent Tiering, set the value of <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>.</p>
|
|
25
|
+
* </li>
|
|
26
|
+
* </ul>
|
|
15
27
|
*
|
|
28
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Lifecycle Management</a>.</p>
|
|
16
29
|
* <p>Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a
|
|
17
30
|
* <code>LifecycleConfiguration</code> object already exists for the specified file system, a
|
|
18
31
|
* <code>PutLifecycleConfiguration</code> call modifies the existing configuration. A
|
|
19
32
|
* <code>PutLifecycleConfiguration</code> call with an empty <code>LifecyclePolicies</code>
|
|
20
33
|
* array in the request body deletes any existing <code>LifecycleConfiguration</code> and
|
|
21
|
-
* turns off lifecycle management for the file system.</p>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
34
|
+
* turns off lifecycle management and intelligent tiering for the file system.</p>
|
|
24
35
|
* <p>In the request, specify the following: </p>
|
|
25
36
|
* <ul>
|
|
26
37
|
* <li>
|
|
27
|
-
* <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management
|
|
38
|
+
* <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management
|
|
39
|
+
* and intelligent tiering.</p>
|
|
28
40
|
* </li>
|
|
29
41
|
* <li>
|
|
30
42
|
* <p>A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that
|
|
31
|
-
* define when files are moved
|
|
43
|
+
* define when files are moved into IA storage, and when they are moved back to Standard storage.</p>
|
|
44
|
+
* <note>
|
|
45
|
+
* <p>Amazon EFS requires that each <code>LifecyclePolicy</code>
|
|
32
46
|
* object have only have a single transition, so the <code>LifecyclePolicies</code> array needs to be structured with separate
|
|
33
47
|
* <code>LifecyclePolicy</code> objects. See the example requests in the following section for more information.</p>
|
|
48
|
+
* </note>
|
|
34
49
|
* </li>
|
|
35
50
|
* </ul>
|
|
36
51
|
*
|
|
37
|
-
* <p>This operation requires permissions for the
|
|
38
|
-
* <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p>
|
|
52
|
+
* <p>This operation requires permissions for the <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p>
|
|
39
53
|
* <p>To apply a <code>LifecycleConfiguration</code> object to an encrypted file system, you
|
|
40
|
-
* need the same Key Management Service permissions as when you created the encrypted
|
|
41
|
-
* file system. </p>
|
|
54
|
+
* need the same Key Management Service permissions as when you created the encrypted file system.</p>
|
|
42
55
|
* @example
|
|
43
56
|
* Use a bare-bones client and the command you need to make an API call.
|
|
44
57
|
* ```javascript
|