feat(client-fsx): This release adds support to increase metadata perf…

…ormance on FSx for Lustre file systems beyond the default level provisioned when a file system is created. This can be done by specifying MetadataConfiguration during the creation of Persistent_2 file systems or by updating it on demand.
aws · Jun 6, 2024 · 8c1f604 · 8c1f604
1 parent 349fcc9
commit 8c1f604
Show file tree

Hide file tree

Showing 22 changed files with 520 additions and 68 deletions.
diff --git a/clients/client-fsx/src/commands/CopyBackupCommand.ts b/clients/client-fsx/src/commands/CopyBackupCommand.ts
@@ -184,6 +184,10 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //             "STRING_VALUE",
  * //           ],
  * //         },
+ * //         MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //           Iops: Number("int"),
+ * //           Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //         },
  * //       },
  * //       AdministrativeActions: [ // AdministrativeActions
  * //         { // AdministrativeAction
@@ -282,6 +286,10 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //                   "STRING_VALUE",
  * //                 ],
  * //               },
+ * //               MetadataConfiguration: {
+ * //                 Iops: Number("int"),
+ * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //               },
  * //             },
  * //             AdministrativeActions: [
  * //               {

diff --git a/clients/client-fsx/src/commands/CopySnapshotAndUpdateVolumeCommand.ts b/clients/client-fsx/src/commands/CopySnapshotAndUpdateVolumeCommand.ts
@@ -158,6 +158,10 @@ export interface CopySnapshotAndUpdateVolumeCommandOutput
  * //               "STRING_VALUE",
  * //             ],
  * //           },
+ * //           MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //             Iops: Number("int"),
+ * //             Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //           },
  * //         },
  * //         AdministrativeActions: [
  * //           {
@@ -261,6 +265,10 @@ export interface CopySnapshotAndUpdateVolumeCommandOutput
  * //                     "STRING_VALUE",
  * //                   ],
  * //                 },
+ * //                 MetadataConfiguration: {
+ * //                   Iops: Number("int"),
+ * //                   Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //                 },
  * //               },
  * //               AdministrativeActions: "<AdministrativeActions>",
  * //               OntapConfiguration: { // OntapFileSystemConfiguration

diff --git a/clients/client-fsx/src/commands/CreateBackupCommand.ts b/clients/client-fsx/src/commands/CreateBackupCommand.ts
@@ -217,6 +217,10 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //             "STRING_VALUE",
  * //           ],
  * //         },
+ * //         MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //           Iops: Number("int"),
+ * //           Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //         },
  * //       },
  * //       AdministrativeActions: [ // AdministrativeActions
  * //         { // AdministrativeAction
@@ -315,6 +319,10 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //                   "STRING_VALUE",
  * //                 ],
  * //               },
+ * //               MetadataConfiguration: {
+ * //                 Iops: Number("int"),
+ * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //               },
  * //             },
  * //             AdministrativeActions: [
  * //               {

diff --git a/clients/client-fsx/src/commands/CreateFileSystemCommand.ts b/clients/client-fsx/src/commands/CreateFileSystemCommand.ts
@@ -63,7 +63,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
  *             system. If a file system with the specified client request token exists and the
  *             parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a
  *             file system with the specified client request token doesn't exist,
- *                 <code>CreateFileSystem</code> does the following: </p>
+ *                 <code>CreateFileSystem</code> does the following:</p>
  *          <ul>
  *             <li>
  *                <p>Creates a new, empty Amazon FSx file system with an assigned ID, and
@@ -158,6 +158,10 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
  *         "STRING_VALUE",
  *       ],
  *     },
+ *     MetadataConfiguration: { // CreateFileSystemLustreMetadataConfiguration
+ *       Iops: Number("int"),
+ *       Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ *     },
  *   },
  *   OntapConfiguration: { // CreateFileSystemOntapConfiguration
  *     AutomaticBackupRetentionDays: Number("int"),
@@ -322,6 +326,10 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
  * //           "STRING_VALUE",
  * //         ],
  * //       },
+ * //       MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //         Iops: Number("int"),
+ * //         Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //       },
  * //     },
  * //     AdministrativeActions: [ // AdministrativeActions
  * //       { // AdministrativeAction
@@ -425,6 +433,10 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
  * //                 "STRING_VALUE",
  * //               ],
  * //             },
+ * //             MetadataConfiguration: {
+ * //               Iops: Number("int"),
+ * //               Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //             },
  * //           },
  * //           AdministrativeActions: [
  * //             {

diff --git a/clients/client-fsx/src/commands/CreateFileSystemFromBackupCommand.ts b/clients/client-fsx/src/commands/CreateFileSystemFromBackupCommand.ts
@@ -142,6 +142,10 @@ export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSyste
  *         "STRING_VALUE",
  *       ],
  *     },
+ *     MetadataConfiguration: { // CreateFileSystemLustreMetadataConfiguration
+ *       Iops: Number("int"),
+ *       Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ *     },
  *   },
  *   StorageType: "SSD" || "HDD",
  *   KmsKeyId: "STRING_VALUE",
@@ -290,6 +294,10 @@ export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSyste
  * //           "STRING_VALUE",
  * //         ],
  * //       },
+ * //       MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //         Iops: Number("int"),
+ * //         Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //       },
  * //     },
  * //     AdministrativeActions: [ // AdministrativeActions
  * //       { // AdministrativeAction
@@ -393,6 +401,10 @@ export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSyste
  * //                 "STRING_VALUE",
  * //               ],
  * //             },
+ * //             MetadataConfiguration: {
+ * //               Iops: Number("int"),
+ * //               Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //             },
  * //           },
  * //           AdministrativeActions: [
  * //             {

diff --git a/clients/client-fsx/src/commands/CreateSnapshotCommand.ts b/clients/client-fsx/src/commands/CreateSnapshotCommand.ts
@@ -198,6 +198,10 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResponse, __M
  * //                 "STRING_VALUE",
  * //               ],
  * //             },
+ * //             MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //               Iops: Number("int"),
+ * //               Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //             },
  * //           },
  * //           AdministrativeActions: [
  * //             {
@@ -296,6 +300,10 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResponse, __M
  * //                       "STRING_VALUE",
  * //                     ],
  * //                   },
+ * //                   MetadataConfiguration: {
+ * //                     Iops: Number("int"),
+ * //                     Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //                   },
  * //                 },
  * //                 AdministrativeActions: "<AdministrativeActions>",
  * //                 OntapConfiguration: { // OntapFileSystemConfiguration

diff --git a/clients/client-fsx/src/commands/CreateVolumeCommand.ts b/clients/client-fsx/src/commands/CreateVolumeCommand.ts
@@ -295,6 +295,10 @@ export interface CreateVolumeCommandOutput extends CreateVolumeResponse, __Metad
  * //                 "STRING_VALUE",
  * //               ],
  * //             },
+ * //             MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //               Iops: Number("int"),
+ * //               Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //             },
  * //           },
  * //           AdministrativeActions: [
  * //             {
@@ -393,6 +397,10 @@ export interface CreateVolumeCommandOutput extends CreateVolumeResponse, __Metad
  * //                       "STRING_VALUE",
  * //                     ],
  * //                   },
+ * //                   MetadataConfiguration: {
+ * //                     Iops: Number("int"),
+ * //                     Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //                   },
  * //                 },
  * //                 AdministrativeActions: "<AdministrativeActions>",
  * //                 OntapConfiguration: { // OntapFileSystemConfiguration

diff --git a/clients/client-fsx/src/commands/CreateVolumeFromBackupCommand.ts b/clients/client-fsx/src/commands/CreateVolumeFromBackupCommand.ts
@@ -268,6 +268,10 @@ export interface CreateVolumeFromBackupCommandOutput extends CreateVolumeFromBac
  * //                 "STRING_VALUE",
  * //               ],
  * //             },
+ * //             MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //               Iops: Number("int"),
+ * //               Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //             },
  * //           },
  * //           AdministrativeActions: [
  * //             {
@@ -366,6 +370,10 @@ export interface CreateVolumeFromBackupCommandOutput extends CreateVolumeFromBac
  * //                       "STRING_VALUE",
  * //                     ],
  * //                   },
+ * //                   MetadataConfiguration: {
+ * //                     Iops: Number("int"),
+ * //                     Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //                   },
  * //                 },
  * //                 AdministrativeActions: "<AdministrativeActions>",
  * //                 OntapConfiguration: { // OntapFileSystemConfiguration

diff --git a/clients/client-fsx/src/commands/DeleteFileSystemCommand.ts b/clients/client-fsx/src/commands/DeleteFileSystemCommand.ts
@@ -32,14 +32,14 @@ export interface DeleteFileSystemCommandOutput extends DeleteFileSystemResponse,
  *             is gone. Any existing automatic backups and snapshots are also deleted.</p>
  *          <p>To delete an Amazon FSx for NetApp ONTAP file system, first delete all the
  *             volumes and storage virtual machines (SVMs) on the file system. Then provide a
- *                 <code>FileSystemId</code> value to the <code>DeleFileSystem</code> operation.</p>
+ *                 <code>FileSystemId</code> value to the <code>DeleteFileSystem</code> operation.</p>
  *          <p>By default, when you delete an Amazon FSx for Windows File Server file system,
  *             a final backup is created upon deletion. This final backup isn't subject to the file
  *             system's retention policy, and must be manually deleted.</p>
  *          <p>To delete an Amazon FSx for Lustre file system, first
  *             <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/unmounting-fs.html">unmount</a>
  *             it from every connected Amazon EC2 instance, then provide a <code>FileSystemId</code>
- *             value to the <code>DeleFileSystem</code> operation. By default, Amazon FSx will not
+ *             value to the <code>DeleteFileSystem</code> operation. By default, Amazon FSx will not
  *             take a final backup when the <code>DeleteFileSystem</code> operation is invoked. On file systems
  *             not linked to an Amazon S3 bucket, set <code>SkipFinalBackup</code> to <code>false</code>
  *             to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked

diff --git a/clients/client-fsx/src/commands/DescribeBackupsCommand.ts b/clients/client-fsx/src/commands/DescribeBackupsCommand.ts
@@ -196,6 +196,10 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _
  * //               "STRING_VALUE",
  * //             ],
  * //           },
+ * //           MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //             Iops: Number("int"),
+ * //             Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //           },
  * //         },
  * //         AdministrativeActions: [ // AdministrativeActions
  * //           { // AdministrativeAction
@@ -294,6 +298,10 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _
  * //                     "STRING_VALUE",
  * //                   ],
  * //                 },
+ * //                 MetadataConfiguration: {
+ * //                   Iops: Number("int"),
+ * //                   Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //                 },
  * //               },
  * //               AdministrativeActions: [
  * //                 {

diff --git a/clients/client-fsx/src/commands/DescribeFileSystemsCommand.ts b/clients/client-fsx/src/commands/DescribeFileSystemsCommand.ts
@@ -173,6 +173,10 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes
  * //             "STRING_VALUE",
  * //           ],
  * //         },
+ * //         MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //           Iops: Number("int"),
+ * //           Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //         },
  * //       },
  * //       AdministrativeActions: [ // AdministrativeActions
  * //         { // AdministrativeAction
@@ -276,6 +280,10 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes
  * //                   "STRING_VALUE",
  * //                 ],
  * //               },
+ * //               MetadataConfiguration: {
+ * //                 Iops: Number("int"),
+ * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //               },
  * //             },
  * //             AdministrativeActions: [
  * //               {

diff --git a/clients/client-fsx/src/commands/DescribeSnapshotsCommand.ts b/clients/client-fsx/src/commands/DescribeSnapshotsCommand.ts
@@ -203,6 +203,10 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsRespons
  * //                   "STRING_VALUE",
  * //                 ],
  * //               },
+ * //               MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //                 Iops: Number("int"),
+ * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //               },
  * //             },
  * //             AdministrativeActions: [
  * //               {
@@ -301,6 +305,10 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsRespons
  * //                         "STRING_VALUE",
  * //                       ],
  * //                     },
+ * //                     MetadataConfiguration: {
+ * //                       Iops: Number("int"),
+ * //                       Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //                     },
  * //                   },
  * //                   AdministrativeActions: "<AdministrativeActions>",
  * //                   OntapConfiguration: { // OntapFileSystemConfiguration

diff --git a/clients/client-fsx/src/commands/DescribeVolumesCommand.ts b/clients/client-fsx/src/commands/DescribeVolumesCommand.ts
@@ -227,6 +227,10 @@ export interface DescribeVolumesCommandOutput extends DescribeVolumesResponse, _
  * //                   "STRING_VALUE",
  * //                 ],
  * //               },
+ * //               MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //                 Iops: Number("int"),
+ * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //               },
  * //             },
  * //             AdministrativeActions: [
  * //               {
@@ -325,6 +329,10 @@ export interface DescribeVolumesCommandOutput extends DescribeVolumesResponse, _
  * //                         "STRING_VALUE",
  * //                       ],
  * //                     },
+ * //                     MetadataConfiguration: {
+ * //                       Iops: Number("int"),
+ * //                       Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //                     },
  * //                   },
  * //                   AdministrativeActions: "<AdministrativeActions>",
  * //                   OntapConfiguration: { // OntapFileSystemConfiguration

diff --git a/clients/client-fsx/src/commands/ReleaseFileSystemNfsV3LocksCommand.ts b/clients/client-fsx/src/commands/ReleaseFileSystemNfsV3LocksCommand.ts
@@ -145,6 +145,10 @@ export interface ReleaseFileSystemNfsV3LocksCommandOutput
  * //           "STRING_VALUE",
  * //         ],
  * //       },
+ * //       MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //         Iops: Number("int"),
+ * //         Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //       },
  * //     },
  * //     AdministrativeActions: [ // AdministrativeActions
  * //       { // AdministrativeAction
@@ -248,6 +252,10 @@ export interface ReleaseFileSystemNfsV3LocksCommandOutput
  * //                 "STRING_VALUE",
  * //               ],
  * //             },
+ * //             MetadataConfiguration: {
+ * //               Iops: Number("int"),
+ * //               Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //             },
  * //           },
  * //           AdministrativeActions: [
  * //             {

diff --git a/clients/client-fsx/src/commands/RestoreVolumeFromSnapshotCommand.ts b/clients/client-fsx/src/commands/RestoreVolumeFromSnapshotCommand.ts
@@ -155,6 +155,10 @@ export interface RestoreVolumeFromSnapshotCommandOutput extends RestoreVolumeFro
  * //               "STRING_VALUE",
  * //             ],
  * //           },
+ * //           MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //             Iops: Number("int"),
+ * //             Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //           },
  * //         },
  * //         AdministrativeActions: [
  * //           {
@@ -258,6 +262,10 @@ export interface RestoreVolumeFromSnapshotCommandOutput extends RestoreVolumeFro
  * //                     "STRING_VALUE",
  * //                   ],
  * //                 },
+ * //                 MetadataConfiguration: {
+ * //                   Iops: Number("int"),
+ * //                   Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //                 },
  * //               },
  * //               AdministrativeActions: "<AdministrativeActions>",
  * //               OntapConfiguration: { // OntapFileSystemConfiguration

diff --git a/clients/client-fsx/src/commands/StartMisconfiguredStateRecoveryCommand.ts b/clients/client-fsx/src/commands/StartMisconfiguredStateRecoveryCommand.ts
@@ -148,6 +148,10 @@ export interface StartMisconfiguredStateRecoveryCommandOutput
  * //           "STRING_VALUE",
  * //         ],
  * //       },
+ * //       MetadataConfiguration: { // FileSystemLustreMetadataConfiguration
+ * //         Iops: Number("int"),
+ * //         Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //       },
  * //     },
  * //     AdministrativeActions: [ // AdministrativeActions
  * //       { // AdministrativeAction
@@ -251,6 +255,10 @@ export interface StartMisconfiguredStateRecoveryCommandOutput
  * //                 "STRING_VALUE",
  * //               ],
  * //             },
+ * //             MetadataConfiguration: {
+ * //               Iops: Number("int"),
+ * //               Mode: "AUTOMATIC" || "USER_PROVISIONED", // required
+ * //             },
  * //           },
  * //           AdministrativeActions: [
  * //             {