feat(client-fsx): For FSx for Lustre, add new data repository task ty…

…pe, RELEASE_DATA_FROM_FILESYSTEM, to release files that have been archived to S3. For FSx for Windows, enable support for configuring and updating SSD IOPS, and for updating storage type. For FSx for OpenZFS, add new deployment type, MULTI_AZ_1.
aws · Aug 9, 2023 · 9326b4d · 9326b4d
1 parent 5571771
commit 9326b4d
Show file tree

Hide file tree

Showing 23 changed files with 1,280 additions and 395 deletions.
diff --git a/clients/client-fsx/src/commands/CancelDataRepositoryTaskCommand.ts b/clients/client-fsx/src/commands/CancelDataRepositoryTaskCommand.ts
@@ -37,18 +37,21 @@ export interface CancelDataRepositoryTaskCommandOutput extends CancelDataReposit
 /**
  * @public
  * <p>Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the
- *             <code>PENDING</code> or <code>EXECUTING</code> state. When you cancel a task, Amazon FSx does the following.</p>
+ *             <code>PENDING</code> or <code>EXECUTING</code> state. When you cancel am export task, Amazon FSx
+ *             does the following.</p>
  *          <ul>
  *             <li>
  *                <p>Any files that FSx has already exported are not reverted.</p>
  *             </li>
  *             <li>
- *                <p>FSx continues to export any files that are "in-flight" when the cancel operation is received.</p>
+ *                <p>FSx continues to export any files that are in-flight when the cancel operation is received.</p>
  *             </li>
  *             <li>
  *                <p>FSx does not export any files that have not yet been exported.</p>
  *             </li>
  *          </ul>
+ *          <p>For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that
+ *             have already been released will remain in the released state.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-fsx/src/commands/CopyBackupCommand.ts b/clients/client-fsx/src/commands/CopyBackupCommand.ts
@@ -157,6 +157,10 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //           FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
  * //           AuditLogDestination: "STRING_VALUE",
  * //         },
+ * //         DiskIopsConfiguration: { // DiskIopsConfiguration
+ * //           Mode: "AUTOMATIC" || "USER_PROVISIONED",
+ * //           Iops: Number("long"),
+ * //         },
  * //       },
  * //       LustreConfiguration: { // LustreFileSystemConfiguration
  * //         WeeklyMaintenanceStartTime: "STRING_VALUE",
@@ -191,7 +195,7 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //       },
  * //       AdministrativeActions: [ // AdministrativeActions
  * //         { // AdministrativeAction
- * //           AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE",
+ * //           AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION",
  * //           ProgressPercent: Number("int"),
  * //           RequestTime: new Date("TIMESTAMP"),
  * //           Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING",
@@ -251,6 +255,10 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //                 FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
  * //                 AuditLogDestination: "STRING_VALUE",
  * //               },
+ * //               DiskIopsConfiguration: {
+ * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED",
+ * //                 Iops: Number("long"),
+ * //               },
  * //             },
  * //             LustreConfiguration: {
  * //               WeeklyMaintenanceStartTime: "STRING_VALUE",
@@ -285,7 +293,7 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //             },
  * //             AdministrativeActions: [
  * //               {
- * //                 AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE",
+ * //                 AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION",
  * //                 ProgressPercent: Number("int"),
  * //                 RequestTime: new Date("TIMESTAMP"),
  * //                 Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING",
@@ -418,7 +426,7 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //                   ],
  * //                 },
  * //               },
- * //               DiskIopsConfiguration: { // DiskIopsConfiguration
+ * //               DiskIopsConfiguration: {
  * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED",
  * //                 Iops: Number("long"),
  * //               },
@@ -436,14 +444,20 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //               CopyTagsToBackups: true || false,
  * //               CopyTagsToVolumes: true || false,
  * //               DailyAutomaticBackupStartTime: "STRING_VALUE",
- * //               DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2",
+ * //               DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1",
  * //               ThroughputCapacity: Number("int"),
  * //               WeeklyMaintenanceStartTime: "STRING_VALUE",
  * //               DiskIopsConfiguration: {
  * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED",
  * //                 Iops: Number("long"),
  * //               },
  * //               RootVolumeId: "STRING_VALUE",
+ * //               PreferredSubnetId: "STRING_VALUE",
+ * //               EndpointIpAddressRange: "STRING_VALUE",
+ * //               RouteTableIds: [
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //               EndpointIpAddress: "STRING_VALUE",
  * //             },
  * //           },
  * //           FailureDetails: {
@@ -589,14 +603,17 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB
  * //         CopyTagsToBackups: true || false,
  * //         CopyTagsToVolumes: true || false,
  * //         DailyAutomaticBackupStartTime: "STRING_VALUE",
- * //         DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2",
+ * //         DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1",
  * //         ThroughputCapacity: Number("int"),
  * //         WeeklyMaintenanceStartTime: "STRING_VALUE",
- * //         DiskIopsConfiguration: {
- * //           Mode: "AUTOMATIC" || "USER_PROVISIONED",
- * //           Iops: Number("long"),
- * //         },
+ * //         DiskIopsConfiguration: "<DiskIopsConfiguration>",
  * //         RootVolumeId: "STRING_VALUE",
+ * //         PreferredSubnetId: "STRING_VALUE",
+ * //         EndpointIpAddressRange: "STRING_VALUE",
+ * //         RouteTableIds: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         EndpointIpAddress: "STRING_VALUE",
  * //       },
  * //     },
  * //     DirectoryInformation: { // ActiveDirectoryBackupAttributes

diff --git a/clients/client-fsx/src/commands/CreateBackupCommand.ts b/clients/client-fsx/src/commands/CreateBackupCommand.ts
@@ -190,6 +190,10 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //           FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
  * //           AuditLogDestination: "STRING_VALUE",
  * //         },
+ * //         DiskIopsConfiguration: { // DiskIopsConfiguration
+ * //           Mode: "AUTOMATIC" || "USER_PROVISIONED",
+ * //           Iops: Number("long"),
+ * //         },
  * //       },
  * //       LustreConfiguration: { // LustreFileSystemConfiguration
  * //         WeeklyMaintenanceStartTime: "STRING_VALUE",
@@ -224,7 +228,7 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //       },
  * //       AdministrativeActions: [ // AdministrativeActions
  * //         { // AdministrativeAction
- * //           AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE",
+ * //           AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION",
  * //           ProgressPercent: Number("int"),
  * //           RequestTime: new Date("TIMESTAMP"),
  * //           Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING",
@@ -284,6 +288,10 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //                 FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required
  * //                 AuditLogDestination: "STRING_VALUE",
  * //               },
+ * //               DiskIopsConfiguration: {
+ * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED",
+ * //                 Iops: Number("long"),
+ * //               },
  * //             },
  * //             LustreConfiguration: {
  * //               WeeklyMaintenanceStartTime: "STRING_VALUE",
@@ -318,7 +326,7 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //             },
  * //             AdministrativeActions: [
  * //               {
- * //                 AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE",
+ * //                 AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION",
  * //                 ProgressPercent: Number("int"),
  * //                 RequestTime: new Date("TIMESTAMP"),
  * //                 Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING",
@@ -451,7 +459,7 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //                   ],
  * //                 },
  * //               },
- * //               DiskIopsConfiguration: { // DiskIopsConfiguration
+ * //               DiskIopsConfiguration: {
  * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED",
  * //                 Iops: Number("long"),
  * //               },
@@ -469,14 +477,20 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //               CopyTagsToBackups: true || false,
  * //               CopyTagsToVolumes: true || false,
  * //               DailyAutomaticBackupStartTime: "STRING_VALUE",
- * //               DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2",
+ * //               DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1",
  * //               ThroughputCapacity: Number("int"),
  * //               WeeklyMaintenanceStartTime: "STRING_VALUE",
  * //               DiskIopsConfiguration: {
  * //                 Mode: "AUTOMATIC" || "USER_PROVISIONED",
  * //                 Iops: Number("long"),
  * //               },
  * //               RootVolumeId: "STRING_VALUE",
+ * //               PreferredSubnetId: "STRING_VALUE",
+ * //               EndpointIpAddressRange: "STRING_VALUE",
+ * //               RouteTableIds: [
+ * //                 "STRING_VALUE",
+ * //               ],
+ * //               EndpointIpAddress: "STRING_VALUE",
  * //             },
  * //           },
  * //           FailureDetails: {
@@ -622,14 +636,17 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
  * //         CopyTagsToBackups: true || false,
  * //         CopyTagsToVolumes: true || false,
  * //         DailyAutomaticBackupStartTime: "STRING_VALUE",
- * //         DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2",
+ * //         DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_1",
  * //         ThroughputCapacity: Number("int"),
  * //         WeeklyMaintenanceStartTime: "STRING_VALUE",
- * //         DiskIopsConfiguration: {
- * //           Mode: "AUTOMATIC" || "USER_PROVISIONED",
- * //           Iops: Number("long"),
- * //         },
+ * //         DiskIopsConfiguration: "<DiskIopsConfiguration>",
  * //         RootVolumeId: "STRING_VALUE",
+ * //         PreferredSubnetId: "STRING_VALUE",
+ * //         EndpointIpAddressRange: "STRING_VALUE",
+ * //         RouteTableIds: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         EndpointIpAddress: "STRING_VALUE",
  * //       },
  * //     },
  * //     DirectoryInformation: { // ActiveDirectoryBackupAttributes

diff --git a/clients/client-fsx/src/commands/CreateDataRepositoryTaskCommand.ts b/clients/client-fsx/src/commands/CreateDataRepositoryTaskCommand.ts
@@ -36,13 +36,18 @@ export interface CreateDataRepositoryTaskCommandOutput extends CreateDataReposit
 
 /**
  * @public
- * <p>Creates an Amazon FSx for Lustre data repository task. You use data repository tasks
- *             to perform bulk operations between your Amazon FSx file system and its linked data
- *             repositories. An example of a data repository task is exporting any data and metadata
- *             changes, including POSIX metadata, to files, directories, and symbolic links (symlinks)
- *             from your FSx file system to a linked data repository. A <code>CreateDataRepositoryTask</code>
- *             operation will fail if a data repository is not linked to the FSx file system. To learn
- *             more about data repository tasks, see
+ * <p>Creates an Amazon FSx for Lustre data repository task.
+ *             A <code>CreateDataRepositoryTask</code> operation will fail if a data
+ *             repository is not linked to the FSx file system.</p>
+ *          <p>You use import and export data repository tasks to perform bulk operations between your
+ *             FSx for Lustre file system and its linked data repositories. An example of a data repository
+ *             task is exporting any data and metadata changes, including POSIX metadata, to files, directories,
+ *             and symbolic links (symlinks) from your FSx file system to a linked data repository.</p>
+ *          <p>You use release data repository tasks to release data from your file system for files that
+ *             are archived to S3. The metadata of released files remains on the file system so users or applications
+ *             can still access released files by reading the files again, which will restore data from
+ *             Amazon S3 to the FSx for Lustre file system.</p>
+ *          <p>To learn more about data repository tasks, see
  *             <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html">Data Repository Tasks</a>.
  *             To learn more about linking a data repository to your file system, see
  *             <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/create-dra-linked-data-repo.html">Linking your file system to an S3 bucket</a>.</p>
@@ -72,6 +77,12 @@ export interface CreateDataRepositoryTaskCommandOutput extends CreateDataReposit
  *     },
  *   ],
  *   CapacityToRelease: Number("long"),
+ *   ReleaseConfiguration: { // ReleaseConfiguration
+ *     DurationSinceLastAccess: { // DurationSinceLastAccess
+ *       Unit: "DAYS",
+ *       Value: Number("long"),
+ *     },
+ *   },
  * };
  * const command = new CreateDataRepositoryTaskCommand(input);
  * const response = await client.send(command);
@@ -112,6 +123,12 @@ export interface CreateDataRepositoryTaskCommandOutput extends CreateDataReposit
  * //     },
  * //     CapacityToRelease: Number("long"),
  * //     FileCacheId: "STRING_VALUE",
+ * //     ReleaseConfiguration: { // ReleaseConfiguration
+ * //       DurationSinceLastAccess: { // DurationSinceLastAccess
+ * //         Unit: "DAYS",
+ * //         Value: Number("long"),
+ * //       },
+ * //     },
  * //   },
  * // };
  *