Skip to content

Commit

Permalink
feat(client-fsx): This release adds support for 4GB/s / 160K PIOPS FS…
Browse files Browse the repository at this point in the history 
…x for ONTAP file systems and 10GB/s / 350K PIOPS FSx for OpenZFS file systems (Single_AZ_2). For FSx for ONTAP, this also adds support for DP volumes, snapshot policy, copy tags to backups, and Multi-AZ route table updates.
  • Loading branch information
awstools committed Nov 29, 2022
1 parent 25099d1 commit 797d649
Show file tree
Hide file tree
Showing 27 changed files with 1,826 additions and 973 deletions.
218 changes: 95 additions & 123 deletions clients/client-fsx/src/FSx.ts
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion clients/client-fsx/src/commands/AssociateFileSystemAliasesCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface AssociateFileSystemAliasesCommandOutput extends AssociateFileSy
* For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html">Working with DNS Aliases</a> and
* <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html">Walkthrough 5: Using DNS aliases to access your file system</a>, including
* additional steps you must take to be able to access your file system using a DNS alias.</p>
* <p>The system response shows the DNS aliases that
* <p>The system response shows the DNS aliases that
* Amazon FSx is attempting to associate with the file system.
* Use the API
* operation to monitor the status of the aliases Amazon FSx is
Expand Down
2 changes: 1 addition & 1 deletion clients/client-fsx/src/commands/CancelDataRepositoryTaskCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface CancelDataRepositoryTaskCommandOutput extends CancelDataReposit
/**
* <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>
* <ul>
* <ul>
* <li>
* <p>Any files that FSx has already exported are not reverted.</p>
* </li>
Expand Down
30 changes: 14 additions & 16 deletions clients/client-fsx/src/commands/CreateBackupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,56 +34,54 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad
* volume, or Amazon FSx for OpenZFS file system. We recommend creating regular
* backups so that you can restore a file system or volume from a backup if an issue arises
* with the original file system or volume.</p>
* <p>For Amazon FSx for Lustre file systems, you can create a backup only for file
* <p>For Amazon FSx for Lustre file systems, you can create a backup only for file
* systems that have the following configuration:</p>
* <ul>
* <ul>
* <li>
* <p>A Persistent deployment type</p>
* </li>
* <li>
* <p>Are <i>not</i> linked to a data repository</p>
* </li>
* </ul>
* <p>For more information about backups, see the following:</p>
* <ul>
* <p>For more information about backups, see the following:</p>
* <ul>
* <li>
* <p>For Amazon FSx for Lustre, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html">Working with FSx for
* <p>For Amazon FSx for Lustre, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html">Working with FSx for
* Lustre backups</a>.</p>
* </li>
* <li>
* <p>For Amazon FSx for Windows, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html">Working with FSx for
* <p>For Amazon FSx for Windows, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html">Working with FSx for
* Windows backups</a>.</p>
* </li>
* <li>
* <p>For Amazon FSx for NetApp ONTAP, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html">Working with FSx for NetApp
* <p>For Amazon FSx for NetApp ONTAP, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html">Working with FSx for NetApp
* ONTAP backups</a>.</p>
* </li>
* <li>
* <p>For Amazon FSx for OpenZFS, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html">Working with FSx for OpenZFS backups</a>.</p>
* <p>For Amazon FSx for OpenZFS, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/using-backups.html">Working with FSx for OpenZFS backups</a>.</p>
* </li>
* </ul>
* <p>If a backup with the specified client request token exists and the parameters match,
* <p>If a backup with the specified client request token exists and the parameters match,
* this operation returns the description of the existing backup. If a backup with the
* specified client request token exists and the parameters don't match, this operation
* returns <code>IncompatibleParameterError</code>. If a backup with the specified client
* request token doesn't exist, <code>CreateBackup</code> does the following: </p>
* <ul>
* <ul>
* <li>
* <p>Creates a new Amazon FSx backup with an assigned ID, and an initial
* <p>Creates a new Amazon FSx backup with an assigned ID, and an initial
* lifecycle state of <code>CREATING</code>.</p>
* </li>
* <li>
* <p>Returns the description of the backup.</p>
* <p>Returns the description of the backup.</p>
* </li>
* </ul>
*
* <p>By using the idempotent operation, you can retry a <code>CreateBackup</code>
* <p>By using the idempotent operation, you can retry a <code>CreateBackup</code>
* operation without the risk of creating an extra backup. This approach can be useful when
* an initial call fails in a way that makes it unclear whether a backup was created. If
* you use the same client request token and the initial call created a backup, the
* operation returns a successful result because all the parameters are the same.</p>
*
* <p>The <code>CreateBackup</code> operation returns while the backup's lifecycle state is
* <p>The <code>CreateBackup</code> operation returns while the backup's lifecycle state is
* still <code>CREATING</code>. You can check the backup creation status by calling the
* <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeBackups.html">DescribeBackups</a> operation, which returns the backup state along with other
* information.</p>
Expand Down
6 changes: 3 additions & 3 deletions clients/client-fsx/src/commands/CreateDataRepositoryAssociationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ export interface CreateDataRepositoryAssociationCommandOutput
* an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository
* associations on a file system. Data repository associations are supported only
* for file systems with the <code>Persistent_2</code> deployment type.</p>
* <p>Each data repository association must have a unique Amazon FSx file
* <p>Each data repository association must have a unique Amazon FSx file
* system directory and a unique S3 bucket or prefix associated with it. You
* can configure a data repository association for automatic import only,
* for automatic export only, or for both. 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>
* <note>
* <note>
* <p>
* <code>CreateDataRepositoryAssociation</code> isn't supported
* on Amazon File Cache resources. To create a DRA on Amazon File Cache,
* use the <code>CreateFileCache</code> operation.</p>
* </note>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
12 changes: 6 additions & 6 deletions clients/client-fsx/src/commands/CreateFileCacheCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,29 +30,29 @@ export interface CreateFileCacheCommandOutput extends CreateFileCacheResponse, _

/**
* <p>Creates a new Amazon File Cache resource.</p>
* <p>You can use this operation with a client request token in the request that
* <p>You can use this operation with a client request token in the request that
* Amazon File Cache uses to ensure idempotent creation.
* If a cache with the specified client request token exists and the parameters
* match, <code>CreateFileCache</code> returns the description of the existing
* cache. If a cache with the specified client request token exists and the
* parameters don't match, this call returns <code>IncompatibleParameterError</code>.
* If a file cache with the specified client request token doesn't exist,
* <code>CreateFileCache</code> does the following: </p>
* <ul>
* <ul>
* <li>
* <p>Creates a new, empty Amazon File Cache resourcewith an assigned ID, and
* <p>Creates a new, empty Amazon File Cache resourcewith an assigned ID, and
* an initial lifecycle state of <code>CREATING</code>.</p>
* </li>
* <li>
* <p>Returns the description of the cache in JSON format.</p>
* <p>Returns the description of the cache in JSON format.</p>
* </li>
* </ul>
* <note>
* <note>
* <p>The <code>CreateFileCache</code> call returns while the cache's lifecycle
* state is still <code>CREATING</code>. You can check the cache creation status
* by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html">DescribeFileCaches</a> operation, which returns the cache state
* along with other information.</p>
* </note>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
16 changes: 8 additions & 8 deletions clients/client-fsx/src/commands/CreateFileSystemCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
/**
* <p>Creates a new, empty Amazon FSx file system. You can create the following supported
* Amazon FSx file systems using the <code>CreateFileSystem</code> API operation:</p>
* <ul>
* <ul>
* <li>
* <p>Amazon FSx for Lustre</p>
* </li>
Expand All @@ -45,7 +45,7 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
* <p>Amazon FSx for Windows File Server</p>
* </li>
* </ul>
* <p>This operation requires a client request token in the request that Amazon FSx uses
* <p>This operation requires a client request token in the request that Amazon FSx uses
* to ensure idempotent creation. This means that calling the operation multiple times with
* the same client request token has no effect. By using the idempotent operation, you can
* retry a <code>CreateFileSystem</code> operation without the risk of creating an extra
Expand All @@ -54,27 +54,27 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse,
* occurred, or your connection was reset. If you use the same client request token and the
* initial call created a file system, the client receives success as long as the
* parameters are the same.</p>
* <p>If a file system with the specified client request token exists and the parameters
* <p>If a file system with the specified client request token exists and the parameters
* match, <code>CreateFileSystem</code> returns the description of the existing file
* 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>
* <ul>
* <ul>
* <li>
* <p>Creates a new, empty Amazon FSx file system with an assigned ID, and
* <p>Creates a new, empty Amazon FSx file system with an assigned ID, and
* an initial lifecycle state of <code>CREATING</code>.</p>
* </li>
* <li>
* <p>Returns the description of the file system in JSON format.</p>
* <p>Returns the description of the file system in JSON format.</p>
* </li>
* </ul>
* <note>
* <note>
* <p>The <code>CreateFileSystem</code> call returns while the file system's lifecycle
* state is still <code>CREATING</code>. You can check the file-system creation status
* by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">DescribeFileSystems</a> operation, which returns the file system state
* along with other information.</p>
* </note>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
20 changes: 8 additions & 12 deletions clients/client-fsx/src/commands/CreateFileSystemFromBackupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,41 +31,37 @@ export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSyste
/**
* <p>Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File
* Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.</p>
*
* <p>If a file system with the specified client request token exists and the parameters
* <p>If a file system with the specified client request token exists and the parameters
* match, this operation returns the description of the file system. If a file system
* with the specified client request token exists but the parameters don't match, this
* call returns <code>IncompatibleParameterError</code>. If a file system with the
* specified client request token doesn't exist, this operation does the following:</p>
*
* <ul>
* <ul>
* <li>
* <p>Creates a new Amazon FSx file system from backup with an assigned ID,
* <p>Creates a new Amazon FSx file system from backup with an assigned ID,
* and an initial lifecycle state of <code>CREATING</code>.</p>
* </li>
* <li>
* <p>Returns the description of the file system.</p>
* <p>Returns the description of the file system.</p>
* </li>
* </ul>
*
* <p>Parameters like the Active Directory, default share name, automatic backup, and backup
* <p>Parameters like the Active Directory, default share name, automatic backup, and backup
* settings default to the parameters of the file system that was backed up, unless
* overridden. You can explicitly supply other settings.</p>
*
* <p>By using the idempotent operation, you can retry a
* <p>By using the idempotent operation, you can retry a
* <code>CreateFileSystemFromBackup</code> call without the risk of creating an extra
* file system. This approach can be useful when an initial call fails in a way that makes
* it unclear whether a file system was created. Examples are if a transport level timeout
* occurred, or your connection was reset. If you use the same client request token and the
* initial call created a file system, the client receives a success message as long as the
* parameters are the same.</p>
* <note>
* <note>
* <p>The <code>CreateFileSystemFromBackup</code> call returns while the file system's
* lifecycle state is still <code>CREATING</code>. You can check the file-system
* creation status by calling the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileSystems.html">
* DescribeFileSystems</a> operation, which returns the file system state along
* with other information.</p>
* </note>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
12 changes: 6 additions & 6 deletions clients/client-fsx/src/commands/CreateSnapshotCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,28 +32,28 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResponse, __M
* <p>Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With
* snapshots, you can easily undo file changes and compare file versions by restoring the
* volume to a previous version.</p>
* <p>If a snapshot with the specified client request token exists, and the parameters
* <p>If a snapshot with the specified client request token exists, and the parameters
* match, this operation returns the description of the existing snapshot. If a snapshot
* with the specified client request token exists, and the parameters don't match, this
* operation returns <code>IncompatibleParameterError</code>. If a snapshot with the
* specified client request token doesn't exist, <code>CreateSnapshot</code> does the
* following:</p>
* <ul>
* <ul>
* <li>
* <p>Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle
* <p>Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle
* state of <code>CREATING</code>.</p>
* </li>
* <li>
* <p>Returns the description of the snapshot.</p>
* <p>Returns the description of the snapshot.</p>
* </li>
* </ul>
* <p>By using the idempotent operation, you can retry a <code>CreateSnapshot</code>
* <p>By using the idempotent operation, you can retry a <code>CreateSnapshot</code>
* operation without the risk of creating an extra snapshot. This approach can be useful
* when an initial call fails in a way that makes it unclear whether a snapshot was
* created. If you use the same client request token and the initial call created a
* snapshot, the operation returns a successful result because all the parameters are the
* same.</p>
* <p>The <code>CreateSnapshot</code> operation returns while the snapshot's lifecycle state
* <p>The <code>CreateSnapshot</code> operation returns while the snapshot's lifecycle state
* is still <code>CREATING</code>. You can check the snapshot creation status by calling
* the <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeSnapshots.html">DescribeSnapshots</a> operation, which returns the snapshot state along with
* other information.</p>
Expand Down
8 changes: 3 additions & 5 deletions clients/client-fsx/src/commands/DeleteBackupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,12 @@ export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __Metad
/**
* <p>Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and
* its data is gone.</p>
*
* <p>The <code>DeleteBackup</code> call returns instantly. The backup won't show up in
* <p>The <code>DeleteBackup</code> call returns instantly. The backup won't show up in
* later <code>DescribeBackups</code> calls.</p>
*
* <important>
* <important>
* <p>The data in a deleted backup is also deleted and can't be recovered by any
* means.</p>
* </important>
* </important>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit 797d649

Please sign in to comment.