@aws-sdk/client-efs 3.693.0 → 3.696.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/dist-cjs/index.js CHANGED
@@ -38,6 +38,7 @@ __export(src_exports, {
38
38
  DeleteMountTargetCommand: () => DeleteMountTargetCommand,
39
39
  DeleteReplicationConfigurationCommand: () => DeleteReplicationConfigurationCommand,
40
40
  DeleteTagsCommand: () => DeleteTagsCommand,
41
+ DeletionMode: () => DeletionMode,
41
42
  DependencyTimeout: () => DependencyTimeout,
42
43
  DescribeAccessPointsCommand: () => DescribeAccessPointsCommand,
43
44
  DescribeAccountPreferencesCommand: () => DescribeAccountPreferencesCommand,
@@ -825,6 +826,10 @@ var _MountTargetNotFound = class _MountTargetNotFound extends EFSServiceExceptio
825
826
  };
826
827
  __name(_MountTargetNotFound, "MountTargetNotFound");
827
828
  var MountTargetNotFound = _MountTargetNotFound;
829
+ var DeletionMode = {
830
+ ALL_CONFIGURATIONS: "ALL_CONFIGURATIONS",
831
+ LOCAL_CONFIGURATION_ONLY: "LOCAL_CONFIGURATION_ONLY"
832
+ };
828
833
  var ResourceIdType = {
829
834
  LongId: "LONG_ID",
830
835
  ShortId: "SHORT_ID"
@@ -1088,8 +1093,11 @@ var se_DeleteReplicationConfigurationCommand = /* @__PURE__ */ __name(async (inp
1088
1093
  const headers = {};
1089
1094
  b.bp("/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration");
1090
1095
  b.p("SourceFileSystemId", () => input.SourceFileSystemId, "{SourceFileSystemId}", false);
1096
+ const query = (0, import_smithy_client.map)({
1097
+ [_dM]: [, input[_DM]]
1098
+ });
1091
1099
  let body;
1092
- b.m("DELETE").h(headers).b(body);
1100
+ b.m("DELETE").h(headers).q(query).b(body);
1093
1101
  return b.build();
1094
1102
  }, "se_DeleteReplicationConfigurationCommand");
1095
1103
  var se_DeleteTagsCommand = /* @__PURE__ */ __name(async (input, context) => {
@@ -1474,6 +1482,7 @@ var de_CreateReplicationConfigurationCommand = /* @__PURE__ */ __name(async (out
1474
1482
  OriginalSourceFileSystemArn: import_smithy_client.expectString,
1475
1483
  SourceFileSystemArn: import_smithy_client.expectString,
1476
1484
  SourceFileSystemId: import_smithy_client.expectString,
1485
+ SourceFileSystemOwnerId: import_smithy_client.expectString,
1477
1486
  SourceFileSystemRegion: import_smithy_client.expectString
1478
1487
  });
1479
1488
  Object.assign(contents, doc);
@@ -2413,8 +2422,11 @@ var de_Destination = /* @__PURE__ */ __name((output, context) => {
2413
2422
  return (0, import_smithy_client.take)(output, {
2414
2423
  FileSystemId: import_smithy_client.expectString,
2415
2424
  LastReplicatedTimestamp: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
2425
+ OwnerId: import_smithy_client.expectString,
2416
2426
  Region: import_smithy_client.expectString,
2417
- Status: import_smithy_client.expectString
2427
+ RoleArn: import_smithy_client.expectString,
2428
+ Status: import_smithy_client.expectString,
2429
+ StatusMessage: import_smithy_client.expectString
2418
2430
  });
2419
2431
  }, "de_Destination");
2420
2432
  var de_Destinations = /* @__PURE__ */ __name((output, context) => {
@@ -2467,6 +2479,7 @@ var de_ReplicationConfigurationDescription = /* @__PURE__ */ __name((output, con
2467
2479
  OriginalSourceFileSystemArn: import_smithy_client.expectString,
2468
2480
  SourceFileSystemArn: import_smithy_client.expectString,
2469
2481
  SourceFileSystemId: import_smithy_client.expectString,
2482
+ SourceFileSystemOwnerId: import_smithy_client.expectString,
2470
2483
  SourceFileSystemRegion: import_smithy_client.expectString
2471
2484
  });
2472
2485
  }, "de_ReplicationConfigurationDescription");
@@ -2484,6 +2497,7 @@ var deserializeMetadata = /* @__PURE__ */ __name((output) => ({
2484
2497
  }), "deserializeMetadata");
2485
2498
  var _API = "AccessPointId";
2486
2499
  var _CT = "CreationToken";
2500
+ var _DM = "DeletionMode";
2487
2501
  var _FSI = "FileSystemId";
2488
2502
  var _M = "Marker";
2489
2503
  var _MI = "MaxItems";
@@ -2491,6 +2505,7 @@ var _MR = "MaxResults";
2491
2505
  var _MTI = "MountTargetId";
2492
2506
  var _NT = "NextToken";
2493
2507
  var _TK = "TagKeys";
2508
+ var _dM = "deletionMode";
2494
2509
  var _tK = "tagKeys";
2495
2510
 
2496
2511
  // src/commands/CreateAccessPointCommand.ts
@@ -3065,6 +3080,7 @@ var paginateListTagsForResource = (0, import_core.createPaginator)(EFSClient, Li
3065
3080
  FileSystemInUse,
3066
3081
  DependencyTimeout,
3067
3082
  MountTargetNotFound,
3083
+ DeletionMode,
3068
3084
  ResourceIdType,
3069
3085
  Resource,
3070
3086
  PolicyNotFound,
@@ -415,6 +415,10 @@ export class MountTargetNotFound extends __BaseException {
415
415
  this.Message = opts.Message;
416
416
  }
417
417
  }
418
+ export const DeletionMode = {
419
+ ALL_CONFIGURATIONS: "ALL_CONFIGURATIONS",
420
+ LOCAL_CONFIGURATION_ONLY: "LOCAL_CONFIGURATION_ONLY",
421
+ };
418
422
  export const ResourceIdType = {
419
423
  LongId: "LONG_ID",
420
424
  ShortId: "SHORT_ID",
@@ -127,8 +127,11 @@ export const se_DeleteReplicationConfigurationCommand = async (input, context) =
127
127
  const headers = {};
128
128
  b.bp("/2015-02-01/file-systems/{SourceFileSystemId}/replication-configuration");
129
129
  b.p("SourceFileSystemId", () => input.SourceFileSystemId, "{SourceFileSystemId}", false);
130
+ const query = map({
131
+ [_dM]: [, input[_DM]],
132
+ });
130
133
  let body;
131
- b.m("DELETE").h(headers).b(body);
134
+ b.m("DELETE").h(headers).q(query).b(body);
132
135
  return b.build();
133
136
  };
134
137
  export const se_DeleteTagsCommand = async (input, context) => {
@@ -493,6 +496,7 @@ export const de_CreateReplicationConfigurationCommand = async (output, context)
493
496
  OriginalSourceFileSystemArn: __expectString,
494
497
  SourceFileSystemArn: __expectString,
495
498
  SourceFileSystemId: __expectString,
499
+ SourceFileSystemOwnerId: __expectString,
496
500
  SourceFileSystemRegion: __expectString,
497
501
  });
498
502
  Object.assign(contents, doc);
@@ -1432,8 +1436,11 @@ const de_Destination = (output, context) => {
1432
1436
  return take(output, {
1433
1437
  FileSystemId: __expectString,
1434
1438
  LastReplicatedTimestamp: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
1439
+ OwnerId: __expectString,
1435
1440
  Region: __expectString,
1441
+ RoleArn: __expectString,
1436
1442
  Status: __expectString,
1443
+ StatusMessage: __expectString,
1437
1444
  });
1438
1445
  };
1439
1446
  const de_Destinations = (output, context) => {
@@ -1490,6 +1497,7 @@ const de_ReplicationConfigurationDescription = (output, context) => {
1490
1497
  OriginalSourceFileSystemArn: __expectString,
1491
1498
  SourceFileSystemArn: __expectString,
1492
1499
  SourceFileSystemId: __expectString,
1500
+ SourceFileSystemOwnerId: __expectString,
1493
1501
  SourceFileSystemRegion: __expectString,
1494
1502
  });
1495
1503
  };
@@ -1510,6 +1518,7 @@ const deserializeMetadata = (output) => ({
1510
1518
  const collectBodyString = (streamBody, context) => collectBody(streamBody, context).then((body) => context.utf8Encoder(body));
1511
1519
  const _API = "AccessPointId";
1512
1520
  const _CT = "CreationToken";
1521
+ const _DM = "DeletionMode";
1513
1522
  const _FSI = "FileSystemId";
1514
1523
  const _M = "Marker";
1515
1524
  const _MI = "MaxItems";
@@ -1517,4 +1526,5 @@ const _MR = "MaxResults";
1517
1526
  const _MTI = "MountTargetId";
1518
1527
  const _NT = "NextToken";
1519
1528
  const _TK = "TagKeys";
1529
+ const _dM = "deletionMode";
1520
1530
  const _tK = "tagKeys";
@@ -63,17 +63,16 @@ declare const CreateFileSystemCommand_base: {
63
63
  * system state.</p>
64
64
  * </note>
65
65
  * <p>This operation accepts an optional <code>PerformanceMode</code> parameter that you choose
66
- * for your file system. We recommend <code>generalPurpose</code> performance mode for all file
67
- * systems. File systems using the <code>maxIO</code> mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies
68
- * than the General Purpose mode. Max I/O mode is not supported for One Zone file systems or
66
+ * for your file system. We recommend <code>generalPurpose</code>
67
+ * <code>PerformanceMode</code> for all file
68
+ * systems. The <code>maxIO</code> mode is a previous generation performance type that is designed for highly parallelized workloads that can tolerate higher latencies
69
+ * than the <code>generalPurpose</code> mode. <code>MaxIO</code> mode is not supported for One Zone file systems or
69
70
  * file systems that use Elastic throughput.</p>
70
- * <important>
71
- * <p>Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.</p>
72
- * </important>
73
- * <p>The performance mode can't be changed after
74
- * the file system has been created. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html">Amazon EFS performance
71
+ * <p>The <code>PerformanceMode</code> can't be changed after the file system has been
72
+ * created. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html">Amazon EFS performance
75
73
  * modes</a>.</p>
76
- * <p>You can set the throughput mode for the file system using the <code>ThroughputMode</code> parameter.</p>
74
+ * <p>You can set the throughput mode for the file system using the <code>ThroughputMode</code>
75
+ * parameter.</p>
77
76
  * <p>After the file system is fully created, Amazon EFS sets its lifecycle state to
78
77
  * <code>available</code>, at which point you can create one or more mount targets for the file
79
78
  * system in your VPC. For more information, see <a>CreateMountTarget</a>. You mount your Amazon EFS file system on an EC2 instances in
@@ -27,95 +27,33 @@ declare const CreateReplicationConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a replication configuration that replicates an existing EFS file system
31
- * to a new, 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
32
- * <i>Amazon EFS User Guide</i>. The replication configuration
33
- * specifies the following:</p>
30
+ * <p>Creates a replication configuration to either a new or existing EFS file system.
31
+ * For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the <i>Amazon EFS User
32
+ * Guide</i>. The replication configuration specifies the following:</p>
34
33
  * <ul>
35
34
  * <li>
36
35
  * <p>
37
- * <b>Source file system</b> – The EFS file system that
38
- * you want replicated. The source file system cannot be a destination file system in an
39
- * existing replication configuration.</p>
36
+ * <b>Source file system</b> – The EFS file
37
+ * system that you want to replicate. </p>
40
38
  * </li>
41
39
  * <li>
42
40
  * <p>
43
- * <b>Amazon Web Services Region</b> – The Amazon Web Services Region in which the destination file system is created. Amazon EFS
44
- * replication is available in all Amazon Web Services Regions in which EFS is available. The
45
- * Region must be enabled. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Managing Amazon Web Services Regions</a> in the <i>Amazon Web Services General Reference
46
- * Reference Guide</i>.</p>
47
- * </li>
48
- * <li>
49
- * <p>
50
- * <b>Destination file system configuration</b> The
51
- * configuration of the destination file system to which the source file system will be
52
- * replicated. There can only be one destination file system in a replication configuration. </p>
53
- * <p>Parameters for the replication configuration include:</p>
54
- * <ul>
55
- * <li>
56
- * <p>
57
- * <b>File system ID</b> – The ID of the destination
58
- * file system for the replication. If no ID is provided, then EFS creates a new file
59
- * system with the default settings. For existing file systems, the file system's
60
- * replication overwrite protection must be disabled. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination"> Replicating to
61
- * an existing file system</a>.</p>
62
- * </li>
63
- * <li>
64
- * <p>
65
- * <b>Availability Zone</b> – If you want the destination file
66
- * system to use One Zone storage, you must specify the Availability Zone to create the
67
- * file system in. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">
68
- * EFS file system types</a> in the <i>Amazon EFS User
69
- * Guide</i>.</p>
70
- * </li>
71
- * <li>
72
- * <p>
73
- * <b>Encryption</b> – All destination file systems are created
74
- * with 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
75
- * specify a KMS key, your service-managed KMS key for
76
- * Amazon EFS is used. </p>
77
- * <note>
78
- * <p>After the file system is created, you cannot change the KMS key.</p>
79
- * </note>
80
- * </li>
81
- * </ul>
82
- * </li>
83
- * </ul>
84
- * <note>
85
- * <p>After the file system is created, you cannot change the KMS key.</p>
86
- * </note>
87
- * <p>For new destination file systems, the following properties are set by default:</p>
88
- * <ul>
89
- * <li>
90
- * <p>
91
- * <b>Performance mode</b> - The destination file system's
92
- * performance mode matches that of the source file system, unless the destination file
93
- * system uses EFS One Zone storage. In that case, the General Purpose performance mode is
94
- * used. The performance mode cannot be changed.</p>
95
- * </li>
96
- * <li>
97
- * <p>
98
- * <b>Throughput mode</b> - The destination file system's
99
- * throughput mode matches that of the source file system. After the file system is created,
100
- * you can modify the throughput mode.</p>
101
- * </li>
102
- * </ul>
103
- * <ul>
104
- * <li>
105
- * <p>
106
- * <b>Lifecycle management</b> – Lifecycle management is not enabled
107
- * on the destination file system. After the destination file system is created, you can
108
- * enable lifecycle management.</p>
109
- * </li>
110
- * <li>
111
- * <p>
112
- * <b>Automatic backups</b> – Automatic daily backups are enabled on
113
- * the destination file system. After the file system is created, you can change this
114
- * setting.</p>
41
+ * <b>Destination file system</b> – The destination file
42
+ * system to which the source file system is replicated. There can only be one destination
43
+ * file system in a replication configuration. </p>
44
+ * <note>
45
+ * <p>A file system can be part of only one replication configuration. </p>
46
+ * </note>
47
+ * <p>The destination parameters for the replication configuration depend on
48
+ * whether you are replicating to a new file system or to an existing file system, and if you
49
+ * are replicating across Amazon Web Services accounts. See <a>DestinationToCreate</a> for more information.</p>
115
50
  * </li>
116
51
  * </ul>
117
- * <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the
118
- * <i>Amazon EFS User Guide</i>.</p>
52
+ * <p>This operation requires permissions for the <code>elasticfilesystem:CreateReplicationConfiguration</code>
53
+ * action. Additionally, other permissions are required depending on how you are replicating file systems.
54
+ * For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html#efs-replication-permissions">Required permissions for replication</a>
55
+ * in the <i>Amazon EFS User
56
+ * Guide</i>.</p>
119
57
  * @example
120
58
  * Use a bare-bones client and the command you need to make an API call.
121
59
  * ```javascript
@@ -130,6 +68,7 @@ declare const CreateReplicationConfigurationCommand_base: {
130
68
  * AvailabilityZoneName: "STRING_VALUE",
131
69
  * KmsKeyId: "STRING_VALUE",
132
70
  * FileSystemId: "STRING_VALUE",
71
+ * RoleArn: "STRING_VALUE",
133
72
  * },
134
73
  * ],
135
74
  * };
@@ -147,8 +86,12 @@ declare const CreateReplicationConfigurationCommand_base: {
147
86
  * // FileSystemId: "STRING_VALUE", // required
148
87
  * // Region: "STRING_VALUE", // required
149
88
  * // LastReplicatedTimestamp: new Date("TIMESTAMP"),
89
+ * // OwnerId: "STRING_VALUE",
90
+ * // StatusMessage: "STRING_VALUE",
91
+ * // RoleArn: "STRING_VALUE",
150
92
  * // },
151
93
  * // ],
94
+ * // SourceFileSystemOwnerId: "STRING_VALUE",
152
95
  * // };
153
96
  *
154
97
  * ```
@@ -34,7 +34,7 @@ declare const DeleteFileSystemCommand_base: {
34
34
  * an EFS file system. This step is performed for you when you use the Amazon Web Services console
35
35
  * to delete a file system.</p>
36
36
  * <note>
37
- * <p>You cannot delete a file system that is part of an EFS Replication configuration.
37
+ * <p>You cannot delete a file system that is part of an EFS replication configuration.
38
38
  * You need to delete the replication configuration first.</p>
39
39
  * </note>
40
40
  * <p> You can't delete a file system that is in use. That is, if the file system has
@@ -41,6 +41,7 @@ declare const DeleteReplicationConfigurationCommand_base: {
41
41
  * const client = new EFSClient(config);
42
42
  * const input = { // DeleteReplicationConfigurationRequest
43
43
  * SourceFileSystemId: "STRING_VALUE", // required
44
+ * DeletionMode: "ALL_CONFIGURATIONS" || "LOCAL_CONFIGURATION_ONLY",
44
45
  * };
45
46
  * const command = new DeleteReplicationConfigurationCommand(input);
46
47
  * const response = await client.send(command);
@@ -28,8 +28,8 @@ declare const DescribeLifecycleConfigurationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Returns the current <code>LifecycleConfiguration</code> object for the specified Amazon
31
- * EFS file system. Lifecycle management uses the <code>LifecycleConfiguration</code> object
32
- * to identify when to move files between storage classes. For a file system without a
31
+ * EFS file system. Lifecycle management uses the <code>LifecycleConfiguration</code> object to
32
+ * identify when to move files between storage classes. For a file system without a
33
33
  * <code>LifecycleConfiguration</code> object, the call returns an empty array in the
34
34
  * response.</p>
35
35
  * <p>This operation requires permissions for the
@@ -57,8 +57,12 @@ declare const DescribeReplicationConfigurationsCommand_base: {
57
57
  * // FileSystemId: "STRING_VALUE", // required
58
58
  * // Region: "STRING_VALUE", // required
59
59
  * // LastReplicatedTimestamp: new Date("TIMESTAMP"),
60
+ * // OwnerId: "STRING_VALUE",
61
+ * // StatusMessage: "STRING_VALUE",
62
+ * // RoleArn: "STRING_VALUE",
60
63
  * // },
61
64
  * // ],
65
+ * // SourceFileSystemOwnerId: "STRING_VALUE",
62
66
  * // },
63
67
  * // ],
64
68
  * // NextToken: "STRING_VALUE",
@@ -33,8 +33,8 @@ declare const PutFileSystemPolicyCommand_base: {
33
33
  * exactly one file system policy, which can be the default policy or an explicit policy set or
34
34
  * updated using this API operation. EFS file system policies have a 20,000 character
35
35
  * limit. When an explicit policy is set, it overrides the default policy. For more information
36
- * about the default file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy">Default EFS
37
- * File System Policy</a>. </p>
36
+ * about the default file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy">
37
+ * Default EFS file system policy</a>. </p>
38
38
  * <note>
39
39
  * <p>EFS file system policies have a 20,000 character limit.</p>
40
40
  * </note>
@@ -49,8 +49,8 @@ declare const PutLifecycleConfigurationCommand_base: {
49
49
  * <p>File systems cannot transition into Archive storage before transitioning into IA storage. Therefore,
50
50
  * TransitionToArchive must either not be set or must be later than TransitionToIA.</p>
51
51
  * <note>
52
- * <p> The Archive storage class is available only for file systems that use the Elastic Throughput mode
53
- * and the General Purpose Performance mode. </p>
52
+ * <p> The Archive storage class is available only for file systems that use the Elastic throughput mode
53
+ * and the General Purpose performance mode. </p>
54
54
  * </note>
55
55
  * </li>
56
56
  * </ul>
@@ -75,7 +75,7 @@ declare const PutLifecycleConfigurationCommand_base: {
75
75
  * <ul>
76
76
  * <li>
77
77
  * <p>The ID for the file system for which you are enabling, disabling, or modifying
78
- * Lifecycle management.</p>
78
+ * lifecycle management.</p>
79
79
  * </li>
80
80
  * <li>
81
81
  * <p>A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that
@@ -100,10 +100,11 @@ export interface CreationInfo {
100
100
  Permissions: string | undefined;
101
101
  }
102
102
  /**
103
- * <p>Specifies the directory on the Amazon EFS file system that the access point provides access to.
104
- * The access point exposes the specified file system path as
105
- * the root directory of your file system to applications using the access point.
106
- * NFS clients using the access point can only access data in the access point's <code>RootDirectory</code> and it's subdirectories.</p>
103
+ * <p>Specifies the directory on the Amazon EFS file system that the access point
104
+ * provides access to. The access point exposes the specified file system path as the root
105
+ * directory of your file system to applications using the access point. NFS clients using the
106
+ * access point can only access data in the access point's <code>RootDirectory</code> and its
107
+ * subdirectories.</p>
107
108
  * @public
108
109
  */
109
110
  export interface RootDirectory {
@@ -600,7 +601,7 @@ export interface CreateFileSystemRequest {
600
601
  */
601
602
  CreationToken?: string | undefined;
602
603
  /**
603
- * <p>The Performance mode of the file system. We recommend <code>generalPurpose</code>
604
+ * <p>The performance mode of the file system. We recommend <code>generalPurpose</code>
604
605
  * performance mode for all file systems. File systems using the <code>maxIO</code> performance
605
606
  * mode can scale to higher levels of aggregate throughput and operations per second with a
606
607
  * tradeoff of slightly higher latencies for most file operations. The performance mode
@@ -677,11 +678,10 @@ export interface CreateFileSystemRequest {
677
678
  */
678
679
  ProvisionedThroughputInMibps?: number | undefined;
679
680
  /**
680
- * <p>Used to create a One Zone file system. It specifies the Amazon Web Services
681
+ * <p>For One Zone file systems, specify the Amazon Web Services
681
682
  * Availability Zone in which to create the file system. Use the format <code>us-east-1a</code> to
682
683
  * specify the Availability Zone. For more information about One Zone file systems, see
683
- * <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">Using EFS storage
684
- * classes</a> in the <i>Amazon EFS User Guide</i>.</p>
684
+ * <a href="https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type">EFS file system types</a> in the <i>Amazon EFS User Guide</i>.</p>
685
685
  * <note>
686
686
  * <p>One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.</p>
687
687
  * </note>
@@ -895,7 +895,7 @@ export interface FileSystemDescription {
895
895
  */
896
896
  SizeInBytes: FileSystemSize | undefined;
897
897
  /**
898
- * <p>The Performance mode of the file system.</p>
898
+ * <p>The performance mode of the file system.</p>
899
899
  * @public
900
900
  */
901
901
  PerformanceMode: PerformanceMode | undefined;
@@ -1355,11 +1355,42 @@ export declare class SubnetNotFound extends __BaseException {
1355
1355
  /**
1356
1356
  * <p>Describes the new or existing destination file system for the replication
1357
1357
  * configuration.</p>
1358
+ * <ul>
1359
+ * <li>
1360
+ * <p>If you want to replicate to a new file system, do not specify the File System ID
1361
+ * for the destination file system. Amazon EFS creates a new, empty file system.
1362
+ * For One Zone storage, specify the Availability Zone to create the file system in. To
1363
+ * use an Key Management Service key other than the default KMS key, then
1364
+ * specify it. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/create-replication.html">Configuring replication to new Amazon EFS file system</a> in the <i>Amazon EFS User
1365
+ * Guide</i>.</p>
1366
+ * <note>
1367
+ * <p>After the file system is created, you cannot change the KMS key or the performance mode.</p>
1368
+ * </note>
1369
+ * </li>
1370
+ * <li>
1371
+ * <p>If you want to replicate to an existing file system that's in the same account
1372
+ * as the source file system, then you need to
1373
+ * provide the ID or Amazon Resource Name (ARN) of the file system to which to replicate. The file system's replication
1374
+ * overwrite protection must be disabled. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination">Replicating to
1375
+ * an existing file system</a> in the <i>Amazon EFS User
1376
+ * Guide</i>.</p>
1377
+ * </li>
1378
+ * <li>
1379
+ * <p>If you are replicating the file system to a file system that's in a different account than the
1380
+ * source file system (cross-account replication), you need to provide the ARN for the file system and the IAM role that allows Amazon EFS to perform
1381
+ * replication on the destination account. The file system's replication overwrite protection
1382
+ * must be disabled. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/cross-account-replication.html">Replicating across Amazon Web Services accounts</a> in the <i>Amazon EFS User
1383
+ * Guide</i>.</p>
1384
+ * </li>
1385
+ * </ul>
1358
1386
  * @public
1359
1387
  */
1360
1388
  export interface DestinationToCreate {
1361
1389
  /**
1362
- * <p>To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.</p>
1390
+ * <p>To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system. The Region must be enabled
1391
+ * for the Amazon Web Services account that owns the source file system. For more information, see
1392
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Managing Amazon Web Services Regions</a> in the <i>Amazon Web Services General
1393
+ * Reference Reference Guide</i>.</p>
1363
1394
  * @public
1364
1395
  */
1365
1396
  Region?: string | undefined;
@@ -1379,7 +1410,7 @@ export interface DestinationToCreate {
1379
1410
  * <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
1380
1411
  * </li>
1381
1412
  * <li>
1382
- * <p>ARN - The Amazon Resource Name (ARN) for the key, for example
1413
+ * <p>ARN - The ARN for the key, for example
1383
1414
  * <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
1384
1415
  * </li>
1385
1416
  * <li>
@@ -1395,12 +1426,20 @@ export interface DestinationToCreate {
1395
1426
  */
1396
1427
  KmsKeyId?: string | undefined;
1397
1428
  /**
1398
- * <p>The ID of the file system to use for the destination. The file system's replication
1399
- * overwrite replication must be disabled. If you do not provide an ID, then EFS creates a new
1400
- * file system for the replication destination.</p>
1429
+ * <p>The ID or ARN of the file system to use for the destination.
1430
+ * For cross-account replication, this must be an ARN. The file system's
1431
+ * replication overwrite replication must be disabled. If no ID or ARN is
1432
+ * specified, then a new file system is created. </p>
1401
1433
  * @public
1402
1434
  */
1403
1435
  FileSystemId?: string | undefined;
1436
+ /**
1437
+ * <p>Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS
1438
+ * to perform replication on its behalf. This is optional for same-account
1439
+ * replication and required for cross-account replication.</p>
1440
+ * @public
1441
+ */
1442
+ RoleArn?: string | undefined;
1404
1443
  }
1405
1444
  /**
1406
1445
  * @public
@@ -1440,24 +1479,10 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat
1440
1479
  */
1441
1480
  export interface Destination {
1442
1481
  /**
1443
- * <p>Describes the status of the destination EFS file system.</p>
1444
- * <ul>
1445
- * <li>
1446
- * <p>The <code>Paused</code> state occurs as a result of opting out of the source or
1447
- * destination Region after the replication configuration was created. To resume replication
1448
- * for the file system, you need to again opt in to the Amazon Web Services Region. For more
1449
- * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Managing Amazon Web Services Regions</a> in the <i>Amazon Web Services General Reference
1450
- * Guide</i>.</p>
1451
- * </li>
1452
- * <li>
1453
- * <p>The <code>Error</code> state occurs when either the source or the destination file
1454
- * system (or both) is in a failed state and is unrecoverable. For more information, see
1455
- * <a href="https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html">Monitoring
1456
- * replication status</a> in the <i>Amazon EFS User Guide</i>. You must delete the replication configuration, and then
1457
- * restore the most recent backup of the failed file system (either the source or the
1458
- * destination) to a new file system.</p>
1459
- * </li>
1460
- * </ul>
1482
+ * <p>Describes the status of the replication configuration. For more information
1483
+ * about replication status, see <a href="https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html">Viewing
1484
+ * replication details</a> in the <i>Amazon EFS User Guide</i>.
1485
+ * </p>
1461
1486
  * @public
1462
1487
  */
1463
1488
  Status: ReplicationStatus | undefined;
@@ -1479,6 +1504,27 @@ export interface Destination {
1479
1504
  * @public
1480
1505
  */
1481
1506
  LastReplicatedTimestamp?: Date | undefined;
1507
+ /**
1508
+ * <p>ID of the Amazon Web Services account in which the destination file system resides.</p>
1509
+ * @public
1510
+ */
1511
+ OwnerId?: string | undefined;
1512
+ /**
1513
+ * <p>Message that provides details about the <code>PAUSED</code> or <code>ERRROR</code> state
1514
+ * of the replication destination configuration. For more information
1515
+ * about replication status messages, see <a href="https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html">Viewing
1516
+ * replication details</a> in the <i>Amazon EFS User Guide</i>.
1517
+ * </p>
1518
+ * @public
1519
+ */
1520
+ StatusMessage?: string | undefined;
1521
+ /**
1522
+ * <p>Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS
1523
+ * to perform replication on its behalf. This is optional for same-account
1524
+ * replication and required for cross-account replication.</p>
1525
+ * @public
1526
+ */
1527
+ RoleArn?: string | undefined;
1482
1528
  }
1483
1529
  /**
1484
1530
  * <p>Describes the replication configuration for a specific file system.</p>
@@ -1518,6 +1564,11 @@ export interface ReplicationConfigurationDescription {
1518
1564
  * @public
1519
1565
  */
1520
1566
  Destinations: Destination[] | undefined;
1567
+ /**
1568
+ * <p>ID of the Amazon Web Services account in which the source file system resides.</p>
1569
+ * @public
1570
+ */
1571
+ SourceFileSystemOwnerId?: string | undefined;
1521
1572
  }
1522
1573
  /**
1523
1574
  * <p>Returned if the specified file system does not have a replication
@@ -1717,6 +1768,18 @@ export declare class MountTargetNotFound extends __BaseException {
1717
1768
  */
1718
1769
  constructor(opts: __ExceptionOptionType<MountTargetNotFound, __BaseException>);
1719
1770
  }
1771
+ /**
1772
+ * @public
1773
+ * @enum
1774
+ */
1775
+ export declare const DeletionMode: {
1776
+ readonly ALL_CONFIGURATIONS: "ALL_CONFIGURATIONS";
1777
+ readonly LOCAL_CONFIGURATION_ONLY: "LOCAL_CONFIGURATION_ONLY";
1778
+ };
1779
+ /**
1780
+ * @public
1781
+ */
1782
+ export type DeletionMode = (typeof DeletionMode)[keyof typeof DeletionMode];
1720
1783
  /**
1721
1784
  * @public
1722
1785
  */
@@ -1726,6 +1789,25 @@ export interface DeleteReplicationConfigurationRequest {
1726
1789
  * @public
1727
1790
  */
1728
1791
  SourceFileSystemId: string | undefined;
1792
+ /**
1793
+ * <p>When replicating across Amazon Web Services accounts or across Amazon Web Services Regions,
1794
+ * Amazon EFS deletes the replication configuration from both the source
1795
+ * and destination account or Region (<code>ALL_CONFIGURATIONS</code>) by default.
1796
+ * If there's a configuration or permissions issue that prevents Amazon EFS from deleting the
1797
+ * replication configuration from both sides, you can use the <code>LOCAL_CONFIGURATION_ONLY</code> mode
1798
+ * to delete the replication configuration from only the local side (the account
1799
+ * or Region from which the delete is performed). </p>
1800
+ * <note>
1801
+ * <p>Only use the <code>LOCAL_CONFIGURATION_ONLY</code> mode in the case that Amazon EFS is unable
1802
+ * to delete the replication configuration in both the source and destination account or Region.
1803
+ * Deleting the local configuration
1804
+ * leaves the configuration in the other account or Region unrecoverable.</p>
1805
+ * <p>Additionally, do not use this mode for same-account, same-region replication as doing so results in a
1806
+ * BadRequest exception error.</p>
1807
+ * </note>
1808
+ * @public
1809
+ */
1810
+ DeletionMode?: DeletionMode | undefined;
1729
1811
  }
1730
1812
  /**
1731
1813
  * <p></p>
@@ -2045,7 +2127,7 @@ export declare const TransitionToPrimaryStorageClassRules: {
2045
2127
  */
2046
2128
  export type TransitionToPrimaryStorageClassRules = (typeof TransitionToPrimaryStorageClassRules)[keyof typeof TransitionToPrimaryStorageClassRules];
2047
2129
  /**
2048
- * <p>Describes a policy used by Lifecycle management that specifies when to transition files
2130
+ * <p>Describes a policy used by lifecycle management that specifies when to transition files
2049
2131
  * into and out of storage classes. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">Managing file system
2050
2132
  * storage</a>.</p>
2051
2133
  * <note>
@@ -2076,7 +2158,7 @@ export interface LifecyclePolicy {
2076
2158
  TransitionToPrimaryStorageClass?: TransitionToPrimaryStorageClassRules | undefined;
2077
2159
  /**
2078
2160
  * <p>The number of days after files were last accessed in primary storage (the
2079
- * Standard storage class) files at which to move them to Archive
2161
+ * Standard storage class) at which to move them to Archive
2080
2162
  * storage. Metadata operations such as listing the contents of a directory don't count as
2081
2163
  * file access events.</p>
2082
2164
  * @public
@@ -2212,7 +2294,8 @@ export declare class IncorrectMountTargetState extends __BaseException {
2212
2294
  export interface DescribeReplicationConfigurationsRequest {
2213
2295
  /**
2214
2296
  * <p>You can retrieve the replication configuration for a specific file system by providing its
2215
- * file system ID.</p>
2297
+ * file system ID. For cross-account,cross-region replication, an account can only describe the replication
2298
+ * configuration for a file system in its own Region.</p>
2216
2299
  * @public
2217
2300
  */
2218
2301
  FileSystemId?: string | undefined;
@@ -2433,7 +2516,7 @@ export interface PutFileSystemPolicyRequest {
2433
2516
  /**
2434
2517
  * <p>The <code>FileSystemPolicy</code> that you're creating. Accepts a JSON formatted
2435
2518
  * policy definition. EFS file system policies have a 20,000 character limit. To find
2436
- * out more about the elements that make up a file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies">EFS Resource-based Policies</a>. </p>
2519
+ * out more about the elements that make up a file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/security_iam_service-with-iam.html#security_iam_service-with-iam-resource-based-policies">Resource-based policies within Amazon EFS</a>. </p>
2437
2520
  * @public
2438
2521
  */
2439
2522
  Policy: string | undefined;
@@ -2461,7 +2544,7 @@ export interface PutLifecycleConfigurationRequest {
2461
2544
  /**
2462
2545
  * <p>An array of <code>LifecyclePolicy</code> objects that define the file system's
2463
2546
  * <code>LifecycleConfiguration</code> object. A <code>LifecycleConfiguration</code> object
2464
- * informs EFS Lifecycle management of the following:</p>
2547
+ * informs lifecycle management of the following:</p>
2465
2548
  * <ul>
2466
2549
  * <li>
2467
2550
  * <p>
@@ -2481,8 +2564,8 @@ export interface PutLifecycleConfigurationRequest {
2481
2564
  * <p>File systems cannot transition into Archive storage before transitioning into IA storage. Therefore,
2482
2565
  * TransitionToArchive must either not be set or must be later than TransitionToIA.</p>
2483
2566
  * <note>
2484
- * <p> The Archive storage class is available only for file systems that use the Elastic Throughput mode
2485
- * and the General Purpose Performance mode. </p>
2567
+ * <p>The Archive storage class is available only for file systems that use the Elastic throughput mode
2568
+ * and the General Purpose performance mode. </p>
2486
2569
  * </note>
2487
2570
  * </li>
2488
2571
  * <li>
@@ -2653,7 +2736,7 @@ export interface UpdateFileSystemProtectionRequest {
2653
2736
  * </li>
2654
2737
  * </ul>
2655
2738
  * <p>If the replication configuration is deleted, the file system's replication overwrite
2656
- * protection is re-enabled, the file system becomes writeable.</p>
2739
+ * protection is re-enabled and the file system becomes writeable.</p>
2657
2740
  * @public
2658
2741
  */
2659
2742
  ReplicationOverwriteProtection?: ReplicationOverwriteProtection | undefined;
@@ -337,6 +337,7 @@ export interface DestinationToCreate {
337
337
  AvailabilityZoneName?: string | undefined;
338
338
  KmsKeyId?: string | undefined;
339
339
  FileSystemId?: string | undefined;
340
+ RoleArn?: string | undefined;
340
341
  }
341
342
  export interface CreateReplicationConfigurationRequest {
342
343
  SourceFileSystemId: string | undefined;
@@ -357,6 +358,9 @@ export interface Destination {
357
358
  FileSystemId: string | undefined;
358
359
  Region: string | undefined;
359
360
  LastReplicatedTimestamp?: Date | undefined;
361
+ OwnerId?: string | undefined;
362
+ StatusMessage?: string | undefined;
363
+ RoleArn?: string | undefined;
360
364
  }
361
365
  export interface ReplicationConfigurationDescription {
362
366
  SourceFileSystemId: string | undefined;
@@ -365,6 +369,7 @@ export interface ReplicationConfigurationDescription {
365
369
  OriginalSourceFileSystemArn: string | undefined;
366
370
  CreationTime: Date | undefined;
367
371
  Destinations: Destination[] | undefined;
372
+ SourceFileSystemOwnerId?: string | undefined;
368
373
  }
369
374
  export declare class ReplicationNotFound extends __BaseException {
370
375
  readonly name: "ReplicationNotFound";
@@ -423,8 +428,14 @@ export declare class MountTargetNotFound extends __BaseException {
423
428
  opts: __ExceptionOptionType<MountTargetNotFound, __BaseException>
424
429
  );
425
430
  }
431
+ export declare const DeletionMode: {
432
+ readonly ALL_CONFIGURATIONS: "ALL_CONFIGURATIONS";
433
+ readonly LOCAL_CONFIGURATION_ONLY: "LOCAL_CONFIGURATION_ONLY";
434
+ };
435
+ export type DeletionMode = (typeof DeletionMode)[keyof typeof DeletionMode];
426
436
  export interface DeleteReplicationConfigurationRequest {
427
437
  SourceFileSystemId: string | undefined;
438
+ DeletionMode?: DeletionMode | undefined;
428
439
  }
429
440
  export interface DeleteTagsRequest {
430
441
  FileSystemId: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-efs",
3
3
  "description": "AWS SDK for JavaScript Efs Client for Node.js, Browser and React Native",
4
- "version": "3.693.0",
4
+ "version": "3.696.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-efs",
@@ -20,43 +20,43 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.693.0",
24
- "@aws-sdk/client-sts": "3.693.0",
25
- "@aws-sdk/core": "3.693.0",
26
- "@aws-sdk/credential-provider-node": "3.693.0",
27
- "@aws-sdk/middleware-host-header": "3.693.0",
28
- "@aws-sdk/middleware-logger": "3.693.0",
29
- "@aws-sdk/middleware-recursion-detection": "3.693.0",
30
- "@aws-sdk/middleware-user-agent": "3.693.0",
31
- "@aws-sdk/region-config-resolver": "3.693.0",
32
- "@aws-sdk/types": "3.692.0",
33
- "@aws-sdk/util-endpoints": "3.693.0",
34
- "@aws-sdk/util-user-agent-browser": "3.693.0",
35
- "@aws-sdk/util-user-agent-node": "3.693.0",
36
- "@smithy/config-resolver": "^3.0.11",
37
- "@smithy/core": "^2.5.2",
38
- "@smithy/fetch-http-handler": "^4.1.0",
39
- "@smithy/hash-node": "^3.0.9",
40
- "@smithy/invalid-dependency": "^3.0.9",
41
- "@smithy/middleware-content-length": "^3.0.11",
42
- "@smithy/middleware-endpoint": "^3.2.2",
43
- "@smithy/middleware-retry": "^3.0.26",
44
- "@smithy/middleware-serde": "^3.0.9",
45
- "@smithy/middleware-stack": "^3.0.9",
46
- "@smithy/node-config-provider": "^3.1.10",
47
- "@smithy/node-http-handler": "^3.3.0",
48
- "@smithy/protocol-http": "^4.1.6",
49
- "@smithy/smithy-client": "^3.4.3",
50
- "@smithy/types": "^3.7.0",
51
- "@smithy/url-parser": "^3.0.9",
23
+ "@aws-sdk/client-sso-oidc": "3.696.0",
24
+ "@aws-sdk/client-sts": "3.696.0",
25
+ "@aws-sdk/core": "3.696.0",
26
+ "@aws-sdk/credential-provider-node": "3.696.0",
27
+ "@aws-sdk/middleware-host-header": "3.696.0",
28
+ "@aws-sdk/middleware-logger": "3.696.0",
29
+ "@aws-sdk/middleware-recursion-detection": "3.696.0",
30
+ "@aws-sdk/middleware-user-agent": "3.696.0",
31
+ "@aws-sdk/region-config-resolver": "3.696.0",
32
+ "@aws-sdk/types": "3.696.0",
33
+ "@aws-sdk/util-endpoints": "3.696.0",
34
+ "@aws-sdk/util-user-agent-browser": "3.696.0",
35
+ "@aws-sdk/util-user-agent-node": "3.696.0",
36
+ "@smithy/config-resolver": "^3.0.12",
37
+ "@smithy/core": "^2.5.3",
38
+ "@smithy/fetch-http-handler": "^4.1.1",
39
+ "@smithy/hash-node": "^3.0.10",
40
+ "@smithy/invalid-dependency": "^3.0.10",
41
+ "@smithy/middleware-content-length": "^3.0.12",
42
+ "@smithy/middleware-endpoint": "^3.2.3",
43
+ "@smithy/middleware-retry": "^3.0.27",
44
+ "@smithy/middleware-serde": "^3.0.10",
45
+ "@smithy/middleware-stack": "^3.0.10",
46
+ "@smithy/node-config-provider": "^3.1.11",
47
+ "@smithy/node-http-handler": "^3.3.1",
48
+ "@smithy/protocol-http": "^4.1.7",
49
+ "@smithy/smithy-client": "^3.4.4",
50
+ "@smithy/types": "^3.7.1",
51
+ "@smithy/url-parser": "^3.0.10",
52
52
  "@smithy/util-base64": "^3.0.0",
53
53
  "@smithy/util-body-length-browser": "^3.0.0",
54
54
  "@smithy/util-body-length-node": "^3.0.0",
55
- "@smithy/util-defaults-mode-browser": "^3.0.26",
56
- "@smithy/util-defaults-mode-node": "^3.0.26",
57
- "@smithy/util-endpoints": "^2.1.5",
58
- "@smithy/util-middleware": "^3.0.9",
59
- "@smithy/util-retry": "^3.0.9",
55
+ "@smithy/util-defaults-mode-browser": "^3.0.27",
56
+ "@smithy/util-defaults-mode-node": "^3.0.27",
57
+ "@smithy/util-endpoints": "^2.1.6",
58
+ "@smithy/util-middleware": "^3.0.10",
59
+ "@smithy/util-retry": "^3.0.10",
60
60
  "@smithy/util-utf8": "^3.0.0",
61
61
  "@types/uuid": "^9.0.1",
62
62
  "tslib": "^2.6.2",