Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
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 associating with the file system.
" }, "CancelDataRepositoryTask": { "name": "CancelDataRepositoryTask", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CancelDataRepositoryTaskRequest" }, "output": { "shape": "CancelDataRepositoryTaskResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "UnsupportedOperation" }, { "shape": "DataRepositoryTaskNotFound" }, { "shape": "DataRepositoryTaskEnded" }, { "shape": "InternalServerError" } ], "documentation": "Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel am export task, Amazon FSx does the following.
Any files that FSx has already exported are not reverted.
FSx continues to export any files that are in-flight when the cancel operation is received.
FSx does not export any files that have not yet been exported.
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.
", "idempotent": true }, "CopyBackup": { "name": "CopyBackup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CopyBackupRequest" }, "output": { "shape": "CopyBackupResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "BackupNotFound" }, { "shape": "ServiceLimitExceeded" }, { "shape": "UnsupportedOperation" }, { "shape": "IncompatibleParameterError" }, { "shape": "InternalServerError" }, { "shape": "InvalidSourceKmsKey" }, { "shape": "InvalidDestinationKmsKey" }, { "shape": "InvalidRegion" }, { "shape": "SourceBackupUnavailable" }, { "shape": "IncompatibleRegionForMultiAZ" } ], "documentation": "Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).
You can also use backup copies to clone your file dataset to another Region or within the same Region.
You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).
For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.
", "idempotent": true }, "CopySnapshotAndUpdateVolume": { "name": "CopySnapshotAndUpdateVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CopySnapshotAndUpdateVolumeRequest" }, "output": { "shape": "CopySnapshotAndUpdateVolumeResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "IncompatibleParameterError" }, { "shape": "InternalServerError" }, { "shape": "ServiceLimitExceeded" } ], "documentation": "Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide.
", "idempotent": true }, "CreateBackup": { "name": "CreateBackup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateBackupRequest" }, "output": { "shape": "CreateBackupResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "UnsupportedOperation" }, { "shape": "FileSystemNotFound" }, { "shape": "VolumeNotFound" }, { "shape": "BackupInProgress" }, { "shape": "IncompatibleParameterError" }, { "shape": "ServiceLimitExceeded" }, { "shape": "InternalServerError" } ], "documentation": "Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP 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.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:
A Persistent deployment type
Are not linked to a data repository
For more information about backups, see the following:
For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
For Amazon FSx for Windows, see Working with FSx for Windows backups.
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
For Amazon FSx for OpenZFS, see Working with FSx for OpenZFS backups.
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 IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup 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.
The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and 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 on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
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 Linking your file system to an S3 bucket.
CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.
Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system.
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.
You use release data repository tasks to release data from your file system for files that are exported 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.
To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
", "idempotent": true }, "CreateFileCache": { "name": "CreateFileCache", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateFileCacheRequest" }, "output": { "shape": "CreateFileCacheResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "IncompatibleParameterError" }, { "shape": "InvalidNetworkSettings" }, { "shape": "InvalidPerUnitStorageThroughput" }, { "shape": "ServiceLimitExceeded" }, { "shape": "InternalServerError" }, { "shape": "MissingFileCacheConfiguration" } ], "documentation": "Creates a new Amazon File Cache resource.
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, CreateFileCache 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 IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:
Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the cache in JSON format.
The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:
Amazon FSx for Lustre
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
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 CreateFileSystem operation 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 success as long as the parameters are the same.
If a file system with the specified client request token exists and the parameters match, CreateFileSystem 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 IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system in JSON format.
The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
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.
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 IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
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.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup 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.
The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
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.
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 IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:
Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the snapshot.
By using the idempotent operation, you can retry a CreateSnapshot 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.
The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
" }, "CreateVolume": { "name": "CreateVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVolumeRequest" }, "output": { "shape": "CreateVolumeResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "FileSystemNotFound" }, { "shape": "IncompatibleParameterError" }, { "shape": "InternalServerError" }, { "shape": "MissingVolumeConfiguration" }, { "shape": "ServiceLimitExceeded" }, { "shape": "StorageVirtualMachineNotFound" }, { "shape": "UnsupportedOperation" } ], "documentation": "Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
" }, "CreateVolumeFromBackup": { "name": "CreateVolumeFromBackup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateVolumeFromBackupRequest" }, "output": { "shape": "CreateVolumeFromBackupResponse" }, "errors": [ { "shape": "BackupNotFound" }, { "shape": "BadRequest" }, { "shape": "FileSystemNotFound" }, { "shape": "IncompatibleParameterError" }, { "shape": "InternalServerError" }, { "shape": "MissingVolumeConfiguration" }, { "shape": "ServiceLimitExceeded" }, { "shape": "StorageVirtualMachineNotFound" } ], "documentation": "Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
" }, "DeleteBackup": { "name": "DeleteBackup", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteBackupRequest" }, "output": { "shape": "DeleteBackupResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "BackupInProgress" }, { "shape": "BackupNotFound" }, { "shape": "BackupRestoring" }, { "shape": "IncompatibleParameterError" }, { "shape": "InternalServerError" }, { "shape": "BackupBeingCopied" } ], "documentation": "Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup won't show up in later DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone.
The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error.
The data in a deleted cache is also deleted and can't be recovered by any means.
Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
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 FileSystemId value to the DeleFileSystem operation.
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.
To delete an Amazon FSx for Lustre file system, first unmount it from every connected Amazon EC2 instance, then provide a FileSystemId value to the DeleFileSystem operation. By default, Amazon FSx will not take a final backup when the DeleteFileSystem operation is invoked. On file systems not linked to an Amazon S3 bucket, set SkipFinalBackup to false to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked file systems. To ensure all of your data is written back to S3 before deleting your file system, you can either monitor for the AgeOfOldestQueuedMessage metric to be zero (if using automatic export) or you can run an export data repository task. If you have automatic export enabled and want to use an export data repository task, you have to disable automatic export before executing the export data repository task.
The DeleteFileSystem operation returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems operation returns a FileSystemNotFound error.
If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by any means.
Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.
The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
" }, "DeleteVolume": { "name": "DeleteVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteVolumeRequest" }, "output": { "shape": "DeleteVolumeResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "IncompatibleParameterError" }, { "shape": "InternalServerError" }, { "shape": "VolumeNotFound" }, { "shape": "ServiceLimitExceeded" } ], "documentation": "Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
" }, "DescribeBackups": { "name": "DescribeBackups", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBackupsRequest" }, "output": { "shape": "DescribeBackupsResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "FileSystemNotFound" }, { "shape": "VolumeNotFound" }, { "shape": "BackupNotFound" }, { "shape": "InternalServerError" } ], "documentation": "Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the backups returned across the responses of a multi-call iteration is unspecified.
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type.
You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value.
The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
" }, "DescribeFileSystems": { "name": "DescribeFileSystems", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeFileSystemsRequest" }, "output": { "shape": "DescribeFileSystemsResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "FileSystemNotFound" }, { "shape": "InternalServerError" } ], "documentation": "Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.
" }, "DescribeSnapshots": { "name": "DescribeSnapshots", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSnapshotsRequest" }, "output": { "shape": "DescribeSnapshotsResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "InternalServerError" }, { "shape": "SnapshotNotFound" } ], "documentation": "Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of backups returned across the responses of a multi-call iteration is unspecified.
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
" }, "DescribeVolumes": { "name": "DescribeVolumes", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeVolumesRequest" }, "output": { "shape": "DescribeVolumesResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "InternalServerError" }, { "shape": "VolumeNotFound" } ], "documentation": "Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
" }, "DisassociateFileSystemAliases": { "name": "DisassociateFileSystemAliases", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DisassociateFileSystemAliasesRequest" }, "output": { "shape": "DisassociateFileSystemAliasesResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "FileSystemNotFound" }, { "shape": "InternalServerError" } ], "documentation": "Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with an HTTP status code 400 (Bad Request). For more information, see Working with DNS Aliases.
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "InternalServerError" }, { "shape": "ResourceNotFound" }, { "shape": "NotServiceResourceError" }, { "shape": "ResourceDoesNotSupportTagging" } ], "documentation": "Lists tags for Amazon FSx resources.
When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.
Releases the file system lock from an Amazon FSx for OpenZFS file system.
", "idempotent": true }, "RestoreVolumeFromSnapshot": { "name": "RestoreVolumeFromSnapshot", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RestoreVolumeFromSnapshotRequest" }, "output": { "shape": "RestoreVolumeFromSnapshotResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "InternalServerError" }, { "shape": "VolumeNotFound" } ], "documentation": "Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.
", "idempotent": true }, "StartMisconfiguredStateRecovery": { "name": "StartMisconfiguredStateRecovery", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartMisconfiguredStateRecoveryRequest" }, "output": { "shape": "StartMisconfiguredStateRecoveryResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "FileSystemNotFound" }, { "shape": "InternalServerError" } ], "documentation": "After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "InternalServerError" }, { "shape": "ResourceNotFound" }, { "shape": "NotServiceResourceError" }, { "shape": "ResourceDoesNotSupportTagging" } ], "documentation": "Tags an Amazon FSx resource.
", "idempotent": true }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "InternalServerError" }, { "shape": "ResourceNotFound" }, { "shape": "NotServiceResourceError" }, { "shape": "ResourceDoesNotSupportTagging" } ], "documentation": "This action removes a tag from an Amazon FSx resource.
", "idempotent": true }, "UpdateDataRepositoryAssociation": { "name": "UpdateDataRepositoryAssociation", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateDataRepositoryAssociationRequest" }, "output": { "shape": "UpdateDataRepositoryAssociationResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "IncompatibleParameterError" }, { "shape": "DataRepositoryAssociationNotFound" }, { "shape": "ServiceLimitExceeded" }, { "shape": "InternalServerError" } ], "documentation": "Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
", "idempotent": true }, "UpdateFileSystem": { "name": "UpdateFileSystem", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateFileSystemRequest" }, "output": { "shape": "UpdateFileSystemResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "UnsupportedOperation" }, { "shape": "IncompatibleParameterError" }, { "shape": "InvalidNetworkSettings" }, { "shape": "InternalServerError" }, { "shape": "FileSystemNotFound" }, { "shape": "MissingFileSystemConfiguration" }, { "shape": "ServiceLimitExceeded" } ], "documentation": "Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
StorageType
ThroughputCapacity
DiskIopsConfiguration
WeeklyMaintenanceStartTime
For FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
LogConfiguration
LustreRootSquashConfiguration
PerUnitStorageThroughput
StorageCapacity
WeeklyMaintenanceStartTime
For FSx for ONTAP file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
HAPairs
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
ThroughputCapacityPerHAPair
WeeklyMaintenanceStartTime
For FSx for OpenZFS file systems, you can update the following properties:
AddRouteTableIds
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
DiskIopsConfiguration
RemoveRouteTableIds
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide.
We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a MISCONFIGURED state and behave like Single-AZ file systems. For more information, see Important considerations before disabling shared VPC support for Multi-AZ file systems.
Updates the name of an Amazon FSx for OpenZFS snapshot.
", "idempotent": true }, "UpdateStorageVirtualMachine": { "name": "UpdateStorageVirtualMachine", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateStorageVirtualMachineRequest" }, "output": { "shape": "UpdateStorageVirtualMachineResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "IncompatibleParameterError" }, { "shape": "InternalServerError" }, { "shape": "StorageVirtualMachineNotFound" }, { "shape": "UnsupportedOperation" } ], "documentation": "Updates an FSx for ONTAP storage virtual machine (SVM).
" }, "UpdateVolume": { "name": "UpdateVolume", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateVolumeRequest" }, "output": { "shape": "UpdateVolumeResponse" }, "errors": [ { "shape": "BadRequest" }, { "shape": "IncompatibleParameterError" }, { "shape": "InternalServerError" }, { "shape": "MissingVolumeConfiguration" }, { "shape": "VolumeNotFound" } ], "documentation": "Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
" } }, "shapes": { "AWSAccountId": { "type": "string", "documentation": "An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
", "max": 12, "min": 12, "pattern": "^\\d{12}$" }, "ActiveDirectoryBackupAttributes": { "type": "structure", "members": { "DomainName": { "shape": "ActiveDirectoryFullyQualifiedName", "documentation": "The fully qualified domain name of the self-managed Active Directory directory.
" }, "ActiveDirectoryId": { "shape": "DirectoryId", "documentation": "The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.
" }, "ResourceARN": { "shape": "ResourceARN" } }, "documentation": "The Microsoft Active Directory attributes of the Amazon FSx for Windows File Server file system.
" }, "ActiveDirectoryFullyQualifiedName": { "type": "string", "max": 255, "min": 1, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$" }, "AdminPassword": { "type": "string", "max": 50, "min": 8, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{8,50}$", "sensitive": true }, "AdministrativeAction": { "type": "structure", "members": { "AdministrativeActionType": { "shape": "AdministrativeActionType" }, "ProgressPercent": { "shape": "ProgressPercent", "documentation": "The percentage-complete status of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
The time that the administrative action request was received.
" }, "Status": { "shape": "Status", "documentation": "The status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.
The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.
" }, "RemainingTransferBytes": { "shape": "RemainingTransferBytes", "documentation": "The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.
" } }, "documentation": "Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume.
" }, "AdministrativeActionFailureDetails": { "type": "structure", "members": { "Message": { "shape": "ErrorMessage", "documentation": "Error message providing details about the failed administrative action.
" } }, "documentation": "Provides information about a failed administrative action.
" }, "AdministrativeActionType": { "type": "string", "documentation": "Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.
You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.
STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has been completed successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.
IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.
You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.
STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.
You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.
VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).
VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).
SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).
RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.
VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).
The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 6.
The value of Aggregates contains aggregates that are not present.
One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.
" } }, "documentation": "Used to specify configuration options for a volume’s storage aggregate or aggregates.
" }, "AggregateListMultiplier": { "type": "integer", "max": 200, "min": 1 }, "Aggregates": { "type": "list", "member": { "shape": "Aggregate" }, "max": 6 }, "Alias": { "type": "structure", "members": { "Name": { "shape": "AlternateDNSName", "documentation": "The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
" }, "Lifecycle": { "shape": "AliasLifecycle", "documentation": "Describes the state of the DNS alias.
AVAILABLE - The DNS alias is associated with an Amazon FSx file system.
CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.
CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.
DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.
DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.
A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.
" }, "AliasLifecycle": { "type": "string", "enum": [ "AVAILABLE", "CREATING", "DELETING", "CREATE_FAILED", "DELETE_FAILED" ] }, "Aliases": { "type": "list", "member": { "shape": "Alias" }, "documentation": "An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.
", "max": 50 }, "AlternateDNSName": { "type": "string", "max": 253, "min": 4, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{4,253}$" }, "AlternateDNSNames": { "type": "list", "member": { "shape": "AlternateDNSName" }, "max": 50 }, "ArchivePath": { "type": "string", "max": 4357, "min": 3, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$" }, "AssociateFileSystemAliasesRequest": { "type": "structure", "required": [ "FileSystemId", "Aliases" ], "members": { "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "FileSystemId": { "shape": "FileSystemId", "documentation": "Specifies the file system with which you want to associate one or more DNS aliases.
" }, "Aliases": { "shape": "AlternateDNSNames", "documentation": "An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.
Can contain alphanumeric characters and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
" } }, "documentation": "The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
" }, "AssociateFileSystemAliasesResponse": { "type": "structure", "members": { "Aliases": { "shape": "Aliases", "documentation": "An array of the DNS aliases that Amazon FSx is associating with the file system.
" } }, "documentation": "The system generated response showing 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 associating with the file system. It can take up to 2.5 minutes for the alias status to change from CREATING to AVAILABLE.
The AutoExportPolicy can have the following event values:
NEW - New files and directories are automatically exported to the data repository as they are added to the file system.
CHANGED - Changes to files and directories on the file system are automatically exported to the data repository.
DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system.
You can define any combination of event types for your AutoExportPolicy.
Describes a data repository association's automatic export policy. The AutoExportPolicy defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.
The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.
The AutoImportPolicy can have the following event values:
NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.
CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.
DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.
You can define any combination of event types for your AutoImportPolicy.
Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.
The AutoImportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.
Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.
Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:
Minutes: 5 - 65,535
Hours: 1 - 65,535
Days: 1 - 3,650
Months: 1 - 120
Years: 1 - 10
Sets the autocommit period of files in an FSx for ONTAP SnapLock volume, which determines how long the files must remain unmodified before they're automatically transitioned to the write once, read many (WORM) state.
For more information, see Autocommit.
" }, "AutocommitPeriodType": { "type": "string", "enum": [ "MINUTES", "HOURS", "DAYS", "MONTHS", "YEARS", "NONE" ] }, "AutocommitPeriodValue": { "type": "integer", "max": 65535, "min": 1 }, "AutomaticBackupRetentionDays": { "type": "integer", "documentation": "The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.
The ID of the backup.
" }, "Lifecycle": { "shape": "BackupLifecycle", "documentation": "The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.
COPYING - Amazon FSx is copying the backup.
DELETED - Amazon FSx deleted the backup and it's no longer available.
FAILED - Amazon FSx couldn't finish the backup.
Details explaining any failures that occurred when creating a backup.
" }, "Type": { "shape": "BackupType", "documentation": "The type of the file-system backup.
" }, "ProgressPercent": { "shape": "ProgressPercent" }, "CreationTime": { "shape": "CreationTime", "documentation": "The time when a particular backup was created.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
" }, "ResourceARN": { "shape": "ResourceARN", "documentation": "The Amazon Resource Name (ARN) for the backup resource.
" }, "Tags": { "shape": "Tags", "documentation": "The tags associated with a particular file system.
" }, "FileSystem": { "shape": "FileSystem", "documentation": "The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
" }, "DirectoryInformation": { "shape": "ActiveDirectoryBackupAttributes", "documentation": "The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
" }, "OwnerId": { "shape": "AWSAccountId" }, "SourceBackupId": { "shape": "BackupId" }, "SourceBackupRegion": { "shape": "Region", "documentation": "The source Region of the backup. Specifies the Region from where this backup is copied.
" }, "ResourceType": { "shape": "ResourceType", "documentation": "Specifies the resource type that's backed up.
" }, "Volume": { "shape": "Volume" } }, "documentation": "A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.
" }, "BackupFailureDetails": { "type": "structure", "members": { "Message": { "shape": "ErrorMessage", "documentation": "A message describing the backup-creation failure.
" } }, "documentation": "If backup creation fails, this structure contains the details of that failure.
" }, "BackupId": { "type": "string", "documentation": "The ID of the source backup. Specifies the backup that you are copying.
", "max": 128, "min": 12, "pattern": "^(backup-[0-9a-f]{8,})$" }, "BackupIds": { "type": "list", "member": { "shape": "BackupId" }, "documentation": "A list of backup IDs.
", "max": 50 }, "BackupLifecycle": { "type": "string", "documentation": "The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.
CREATING - Amazon FSx is creating the new user-initiated backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file system.
COPYING - Amazon FSx is copying the backup.
DELETED - Amazon FSx deleted the backup and it's no longer available.
FAILED - Amazon FSx couldn't finish the backup.
The type of the backup.
", "enum": [ "AUTOMATIC", "USER_INITIATED", "AWS_BACKUP" ] }, "Backups": { "type": "list", "member": { "shape": "Backup" }, "documentation": "A list of file system backups.
", "max": 50 }, "BatchImportMetaDataOnCreate": { "type": "boolean" }, "CancelDataRepositoryTaskRequest": { "type": "structure", "required": [ "TaskId" ], "members": { "TaskId": { "shape": "TaskId", "documentation": "Specifies the data repository task to cancel.
" } }, "documentation": "Cancels a data repository task.
" }, "CancelDataRepositoryTaskResponse": { "type": "structure", "members": { "Lifecycle": { "shape": "DataRepositoryTaskLifecycle", "documentation": "The lifecycle status of the data repository task, as follows:
PENDING - Amazon FSx has not started the task.
EXECUTING - Amazon FSx is processing the task.
FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
SUCCEEDED - FSx completed the task successfully.
CANCELED - Amazon FSx canceled the task and it did not complete.
CANCELING - FSx is in process of canceling the task.
The ID of the task being canceled.
" } } }, "CapacityToRelease": { "type": "long", "max": 2147483647, "min": 1 }, "ClientRequestToken": { "type": "string", "documentation": "(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "max": 63, "min": 1, "pattern": "[A-za-z0-9_.-]{0,63}$" }, "CompletionReport": { "type": "structure", "required": [ "Enabled" ], "members": { "Enabled": { "shape": "Flag", "documentation": "Set Enabled to True to generate a CompletionReport when the task completes. If set to true, then you need to provide a report Scope, Path, and Format. Set Enabled to False if you do not want a CompletionReport generated when the task completes.
Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path you provide must be located within the file system’s ExportPath. An example Path value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.
Required if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv.
Required if Enabled is set to true. Specifies the scope of the CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains information about files that the data repository task failed to process.
Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.
The ID of the source backup. Specifies the ID of the backup that's being copied.
" }, "SourceRegion": { "shape": "Region", "documentation": "The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).
A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.
If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.
Specifies the ID of the volume that you are copying the snapshot to.
" }, "SourceSnapshotARN": { "shape": "ResourceARN" }, "CopyStrategy": { "shape": "OpenZFSCopyStrategy", "documentation": "Specifies the strategy to use when copying data from a snapshot to the volume.
FULL_COPY - Copies all data from the snapshot to the volume.
INCREMENTAL_COPY - Copies only the snapshot data that's changed since the previous replication.
CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume operation.
Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication.
Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots on the destination, you can’t copy the snapshot.
DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume that aren’t on the source volume.
DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume that aren't on the source volume.
DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying.
The ID of the volume that you copied the snapshot to.
" }, "Lifecycle": { "shape": "VolumeLifecycle", "documentation": "The lifecycle state of the destination volume.
" }, "AdministrativeActions": { "shape": "AdministrativeActions", "documentation": "A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
" } } }, "CopyTagsToDataRepositoryAssociations": { "type": "boolean" }, "CreateAggregateConfiguration": { "type": "structure", "members": { "Aggregates": { "shape": "Aggregates", "documentation": "Used to specify the names of aggregates on which the volume will be created.
" }, "ConstituentsPerAggregate": { "shape": "AggregateListMultiplier", "documentation": "Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. This field is optional when creating a FlexGroup volume. If unspecified, the default value will be 8. This field cannot be provided when creating a FlexVol volume.
" } }, "documentation": "Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
" }, "CreateBackupRequest": { "type": "structure", "members": { "FileSystemId": { "shape": "FileSystemId", "documentation": "The ID of the file system to back up.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "(Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken": true }, "Tags": { "shape": "Tags", "documentation": "(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.
(Optional) The ID of the FSx for ONTAP volume to back up.
" } }, "documentation": "The request object for the CreateBackup operation.
A description of the backup.
" } }, "documentation": "The response object for the CreateBackup operation.
A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify \"/\" as the file system path for the first data repository associated with a file system.
The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.
Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
" }, "S3": { "shape": "S3DataRepositoryConfiguration", "documentation": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "Tags": { "shape": "Tags" } } }, "CreateDataRepositoryAssociationResponse": { "type": "structure", "members": { "Association": { "shape": "DataRepositoryAssociation", "documentation": "The response object returned after the data repository association is created.
" } } }, "CreateDataRepositoryTaskRequest": { "type": "structure", "required": [ "Type", "FileSystemId", "Report" ], "members": { "Type": { "shape": "DataRepositoryTaskType", "documentation": "Specifies the type of data repository task to create.
EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.
IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.
AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.
A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).
For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.
For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).
For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.
A file must also meet the last accessed time criteria specified in for the file to be released.
Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.
Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.
" } } }, "CreateDataRepositoryTaskResponse": { "type": "structure", "members": { "DataRepositoryTask": { "shape": "DataRepositoryTask", "documentation": "The description of the data repository task that you just created.
" } } }, "CreateFileCacheDataRepositoryAssociations": { "type": "list", "member": { "shape": "FileCacheDataRepositoryAssociation" }, "max": 8 }, "CreateFileCacheLustreConfiguration": { "type": "structure", "required": [ "PerUnitStorageThroughput", "DeploymentType", "MetadataConfiguration" ], "members": { "PerUnitStorageThroughput": { "shape": "PerUnitStorageThroughput", "documentation": "Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
Specifies the cache deployment type, which must be CACHE_1.
The configuration for a Lustre MDT (Metadata Target) storage volume.
" } }, "documentation": "The Amazon File Cache configuration for the cache that you are creating.
" }, "CreateFileCacheRequest": { "type": "structure", "required": [ "FileCacheType", "FileCacheTypeVersion", "StorageCapacity", "SubnetIds" ], "members": { "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache 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 cache, the client receives success as long as the parameters are the same.
The type of cache that you're creating, which must be LUSTRE.
Sets the Lustre version for the cache that you're creating, which must be 2.12.
The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
" }, "SubnetIds": { "shape": "SubnetIds" }, "SecurityGroupIds": { "shape": "SecurityGroupIds", "documentation": "A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
" }, "Tags": { "shape": "Tags" }, "CopyTagsToDataRepositoryAssociations": { "shape": "CopyTagsToDataRepositoryAssociations", "documentation": "A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
The configuration for the Amazon File Cache resource being created.
" }, "DataRepositoryAssociations": { "shape": "CreateFileCacheDataRepositoryAssociations", "documentation": "A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA configurations must meet the following requirements:
All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.
An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.
DRA automatic import and automatic export is not supported.
" } } }, "CreateFileCacheResponse": { "type": "structure", "members": { "FileCache": { "shape": "FileCacheCreating", "documentation": "A description of the cache that was created.
" } } }, "CreateFileSystemFromBackupRequest": { "type": "structure", "required": [ "BackupId", "SubnetIds" ], "members": { "BackupId": { "shape": "BackupId" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken": true }, "SubnetIds": { "shape": "SubnetIds", "documentation": "Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.
Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.
The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.
The configuration for this Microsoft Windows file system.
" }, "LustreConfiguration": { "shape": "CreateFileSystemLustreConfiguration" }, "StorageType": { "shape": "StorageType", "documentation": "Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.
The default value is SSD.
HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.
Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15.
You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.
The OpenZFS configuration for the file system that's being created.
" }, "StorageCapacity": { "shape": "StorageCapacity", "documentation": "Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.
If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.
The request object for the CreateFileSystemFromBackup operation.
A description of the file system.
" } }, "documentation": "The response object for the CreateFileSystemFromBackup operation.
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" }, "ImportPath": { "shape": "ArchivePath", "documentation": "(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
This parameter is not supported for file systems with a data repository association.
(Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.
The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you specify only a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.
This parameter is not supported for file systems with a data repository association.
(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
This parameter is not supported for file systems with a data repository association.
(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.
Choose PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.
Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). PERSISTENT_2 is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2 is available, see File system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.
If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.
Encryption of data in transit is automatically turned on when you access SCRATCH_2, PERSISTENT_1 and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide.
(Default = SCRATCH_1)
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this parameter to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
For more information, see Automatically import updates from your S3 bucket.
This parameter is not supported for file systems with a data repository association.
Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.
Valid values:
For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.
For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.
For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.
The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
(Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If CopyTagsToBackups is set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
(Default = false)
For more information, see Working with backups in the Amazon FSx for Lustre User Guide.
" }, "DriveCacheType": { "shape": "DriveCacheType", "documentation": "The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to READ to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.
This parameter is required when StorageType is set to HDD.
Sets the data compression configuration for the file system. DataCompressionType can have the following values:
NONE - (Default) Data compression is turned off when the file system is created.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.
" }, "LogConfiguration": { "shape": "LustreLogCreateConfiguration", "documentation": "The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.
" }, "RootSquashConfiguration": { "shape": "LustreRootSquashConfiguration", "documentation": "The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
" } }, "documentation": "The Lustre configuration for the file system being created.
The following parameters are not supported for file systems with a data repository association created with .
AutoImportPolicy
ExportPath
ImportedFileChunkSize
ImportPath
Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.
SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.
SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.
" }, "EndpointIpAddressRange": { "shape": "IpAddressRange", "documentation": "(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.
" }, "FsxAdminPassword": { "shape": "AdminPassword", "documentation": "The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.
The SSD IOPS configuration for the FSx for ONTAP file system.
" }, "PreferredSubnetId": { "shape": "SubnetId", "documentation": "Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.
Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity.
Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.
This field and ThroughputCapacity are the same for scale-up file systems powered by one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
" }, "CreateFileSystemOpenZFSConfiguration": { "type": "structure", "required": [ "DeploymentType", "ThroughputCapacity" ], "members": { "AutomaticBackupRetentionDays": { "shape": "AutomaticBackupRetentionDays" }, "CopyTagsToBackups": { "shape": "Flag", "documentation": "A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false. If it's set to true, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.
Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:
MULTI_AZ_1- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs). Multi_AZ_1 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.
SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MB/s. Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available.
SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.
For more information, see Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.
" }, "ThroughputCapacity": { "shape": "MegabytesPerSecond", "documentation": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:
For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.
You pay for additional throughput capacity that you provision.
" }, "WeeklyMaintenanceStartTime": { "shape": "WeeklyTime" }, "DiskIopsConfiguration": { "shape": "DiskIopsConfiguration" }, "RootVolumeConfiguration": { "shape": "OpenZFSCreateRootVolumeConfiguration", "documentation": "The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.
" }, "PreferredSubnetId": { "shape": "SubnetId", "documentation": "Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
" }, "RouteTableIds": { "shape": "RouteTableIds", "documentation": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
" } }, "documentation": "The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
" }, "CreateFileSystemRequest": { "type": "structure", "required": [ "FileSystemType", "StorageCapacity", "SubnetIds" ], "members": { "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken": true }, "FileSystemType": { "shape": "FileSystemType", "documentation": "The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.
Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).
FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:
For SCRATCH_2, PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.
FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:
For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.
Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.
The tags to apply to the file system that's being created. The key value of the Name tag appears in the console as the file system name.
The Microsoft Windows configuration for the file system that's being created.
" }, "LustreConfiguration": { "shape": "CreateFileSystemLustreConfiguration" }, "OntapConfiguration": { "shape": "CreateFileSystemOntapConfiguration" }, "FileSystemTypeVersion": { "shape": "FileSystemTypeVersion", "documentation": "(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10, 2.12, and 2.15:
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
2.12 and 2.15 are supported by all Lustre deployment types. 2.12 or 2.15 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2.
Default value = 2.10, except when DeploymentType is set to PERSISTENT_2, then the default is 2.12.
If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.
The OpenZFS configuration for the file system that's being created.
" } }, "documentation": "The request object used to create a new Amazon FSx file system.
" }, "CreateFileSystemResponse": { "type": "structure", "members": { "FileSystem": { "shape": "FileSystem", "documentation": "The configuration of the file system that was created.
" } }, "documentation": "The response object returned after the file system is created.
" }, "CreateFileSystemWindowsConfiguration": { "type": "structure", "required": [ "ThroughputCapacity" ], "members": { "ActiveDirectoryId": { "shape": "DirectoryId", "documentation": "The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
" }, "SelfManagedActiveDirectoryConfiguration": { "shape": "SelfManagedActiveDirectoryConfiguration" }, "DeploymentType": { "shape": "WindowsDeploymentType", "documentation": "Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type
SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.
For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.
" }, "PreferredSubnetId": { "shape": "SubnetId", "documentation": "Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.
Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
" }, "WeeklyMaintenanceStartTime": { "shape": "WeeklyTime", "documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" }, "DailyAutomaticBackupStartTime": { "shape": "DailyTime", "documentation": "The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
" }, "AutomaticBackupRetentionDays": { "shape": "AutomaticBackupRetentionDays", "documentation": "The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
" }, "Aliases": { "shape": "AlternateDNSNames", "documentation": "An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.
For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
An alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
" }, "AuditLogConfiguration": { "shape": "WindowsAuditLogCreateConfiguration", "documentation": "The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
" }, "DiskIopsConfiguration": { "shape": "DiskIopsConfiguration", "documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" } }, "documentation": "The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.
Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath must have a leading forward slash, such as /vol3.
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
MIXED This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
For more information, see Volume security style in the FSx for ONTAP User Guide.
" }, "SizeInMegabytes": { "shape": "VolumeCapacity", "documentation": "Use SizeInBytes instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
StorageEfficiencyEnabled is required when creating a RW volume (OntapVolumeType set to RW).
Specifies the ONTAP SVM in which to create the volume.
" }, "TieringPolicy": { "shape": "TieringPolicy" }, "OntapVolumeType": { "shape": "InputOntapVolumeType", "documentation": "Specifies the type of volume you are creating. Valid values are the following:
RW specifies a read/write volume. RW is the default.
DP specifies a data-protection volume. A DP volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
" }, "SnapshotPolicy": { "shape": "SnapshotPolicy", "documentation": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
" }, "CopyTagsToBackups": { "shape": "Flag", "documentation": "A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
" }, "SnaplockConfiguration": { "shape": "CreateSnaplockConfiguration", "documentation": "Specifies the SnapLock configuration for an FSx for ONTAP volume.
" }, "VolumeStyle": { "shape": "VolumeStyle", "documentation": "Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
" }, "AggregateConfiguration": { "shape": "CreateAggregateConfiguration", "documentation": "Use to specify configuration options for a volume’s storage aggregate or aggregates.
" }, "SizeInBytes": { "shape": "VolumeCapacityBytes", "documentation": "Specifies the configured size of the volume, in bytes.
" } }, "documentation": "Specifies the configuration of the ONTAP volume that you are creating.
" }, "CreateOpenZFSOriginSnapshotConfiguration": { "type": "structure", "required": [ "SnapshotARN", "CopyStrategy" ], "members": { "SnapshotARN": { "shape": "ResourceARN" }, "CopyStrategy": { "shape": "OpenZFSCopyStrategy", "documentation": "Specifies the strategy used when copying data from the snapshot to the new volume.
CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
FULL_COPY - Copies all data from the snapshot to the new volume.
Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.
The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
The snapshot configuration to use when creating an Amazon FSx for OpenZFS volume from a snapshot.
" }, "CreateOpenZFSVolumeConfiguration": { "type": "structure", "required": [ "ParentVolumeId" ], "members": { "ParentVolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume to use as the parent volume of the volume that you are creating.
" }, "StorageCapacityReservationGiB": { "shape": "IntegerNoMaxFromNegativeOne", "documentation": "Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.
Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.
For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.
" }, "RecordSizeKiB": { "shape": "IntegerRecordSizeKiB", "documentation": "Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide.
" }, "DataCompressionType": { "shape": "OpenZFSDataCompressionType", "documentation": "Specifies the method used to compress the data on the volume. The compression type is NONE by default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
" }, "CopyTagsToSnapshots": { "shape": "Flag", "documentation": "A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
" }, "ReadOnly": { "shape": "ReadOnly", "documentation": "A Boolean value indicating whether the volume is read-only.
" }, "NfsExports": { "shape": "OpenZFSNfsExports", "documentation": "The configuration object for mounting a Network File System (NFS) file system.
" }, "UserAndGroupQuotas": { "shape": "OpenZFSUserAndGroupQuotas", "documentation": "Configures how much storage users and groups can use on the volume.
" } }, "documentation": "Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
" }, "CreateSnaplockConfiguration": { "type": "structure", "required": [ "SnaplockType" ], "members": { "AuditLogVolume": { "shape": "Flag", "documentation": "Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.
For more information, see SnapLock audit log volumes.
" }, "AutocommitPeriod": { "shape": "AutocommitPeriod", "documentation": "The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
" }, "PrivilegedDelete": { "shape": "PrivilegedDelete", "documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete WORM files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.
For more information, see Privileged delete.
" }, "RetentionPeriod": { "shape": "SnaplockRetentionPeriod", "documentation": "Specifies the retention period of an FSx for ONTAP SnapLock volume.
" }, "SnaplockType": { "shape": "SnaplockType", "documentation": "Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:
COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.
ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.
For more information, see Volume-append mode.
" } }, "documentation": "Defines the SnapLock configuration when creating an FSx for ONTAP SnapLock volume.
" }, "CreateSnapshotRequest": { "type": "structure", "required": [ "Name", "VolumeId" ], "members": { "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "Name": { "shape": "SnapshotName", "documentation": "The name of the snapshot.
" }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume that you are taking a snapshot of.
" }, "Tags": { "shape": "Tags" } } }, "CreateSnapshotResponse": { "type": "structure", "members": { "Snapshot": { "shape": "Snapshot", "documentation": "A description of the snapshot.
" } } }, "CreateStorageVirtualMachineRequest": { "type": "structure", "required": [ "FileSystemId", "Name" ], "members": { "ActiveDirectoryConfiguration": { "shape": "CreateSvmActiveDirectoryConfiguration", "documentation": "Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "FileSystemId": { "shape": "FileSystemId" }, "Name": { "shape": "StorageVirtualMachineName", "documentation": "The name of the SVM.
" }, "SvmAdminPassword": { "shape": "AdminPassword", "documentation": "The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM.
The security style of the root volume of the SVM. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.
MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.
The NetBIOS name of the Active Directory computer object that will be created for your SVM.
" }, "SelfManagedActiveDirectoryConfiguration": { "shape": "SelfManagedActiveDirectoryConfiguration" } }, "documentation": "The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.
" }, "CreateVolumeFromBackupRequest": { "type": "structure", "required": [ "BackupId", "Name" ], "members": { "BackupId": { "shape": "BackupId" }, "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "Name": { "shape": "VolumeName", "documentation": "The name of the new volume you're creating.
" }, "OntapConfiguration": { "shape": "CreateOntapVolumeConfiguration", "documentation": "Specifies the configuration of the ONTAP volume that you are creating.
" }, "Tags": { "shape": "Tags" } } }, "CreateVolumeFromBackupResponse": { "type": "structure", "members": { "Volume": { "shape": "Volume", "documentation": "Returned after a successful CreateVolumeFromBackup API operation, describing the volume just created.
Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume types.
Specifies the name of the volume that you're creating.
" }, "OntapConfiguration": { "shape": "CreateOntapVolumeConfiguration", "documentation": "Specifies the configuration to use when creating the ONTAP volume.
" }, "Tags": { "shape": "Tags" }, "OpenZFSConfiguration": { "shape": "CreateOpenZFSVolumeConfiguration", "documentation": "Specifies the configuration to use when creating the OpenZFS volume.
" } } }, "CreateVolumeResponse": { "type": "structure", "members": { "Volume": { "shape": "Volume", "documentation": "Returned after a successful CreateVolume API operation, describing the volume just created.
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
" }, "DNSName": { "type": "string", "documentation": "The file system's DNS name. You can mount your file system using its DNS name.
", "max": 275, "min": 16, "pattern": "^((fs|fc)i?-[0-9a-f]{8,}\\..{4,253})$" }, "DailyTime": { "type": "string", "documentation": "A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
The system-generated, unique ID of the data repository association.
" }, "ResourceARN": { "shape": "ResourceARN" }, "FileSystemId": { "shape": "FileSystemId" }, "Lifecycle": { "shape": "DataRepositoryLifecycle", "documentation": "Describes the state of a data repository association. The lifecycle can have the following values:
CREATING - The data repository association between the file system or cache and the data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository association is available for use.
MISCONFIGURED - The data repository association is misconfigured. Until the configuration is corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre).
UPDATING - The data repository association is undergoing a customer initiated update that might affect its availability.
DELETING - The data repository association is undergoing a customer initiated deletion.
FAILED - The data repository association is in a terminal state that cannot be recovered.
A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify \"/\" as the file system path for the first data repository associated with a file system.
The path to the data repository that will be linked to the cache or file system.
For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:
If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.
BatchImportMetaDataOnCreate is not supported for data repositories linked to an Amazon File Cache resource.
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
" }, "S3": { "shape": "S3DataRepositoryConfiguration", "documentation": "The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.
" }, "Tags": { "shape": "Tags" }, "CreationTime": { "shape": "CreationTime" }, "FileCacheId": { "shape": "FileCacheId", "documentation": "The globally unique ID of the Amazon File Cache resource.
" }, "FileCachePath": { "shape": "Namespace", "documentation": "A path on the Amazon File Cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the path is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.
This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and no other data repository can be linked to the directory.
The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association. All the subdirectories must be on a single NFS file system. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.
The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.
" } }, "documentation": "The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3 bucket or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system. The data repository association configuration object is returned in the response of the following operations:
CreateDataRepositoryAssociation
UpdateDataRepositoryAssociation
DescribeDataRepositoryAssociations
Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.
UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
FAILED - The data repository is in a terminal state that cannot be recovered.
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
" }, "ImportedFileChunkSize": { "shape": "Megabytes", "documentation": "For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
" }, "AutoImportPolicy": { "shape": "AutoImportPolicyType", "documentation": "Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .
" }, "DataRepositoryFailureDetails": { "type": "structure", "members": { "Message": { "shape": "ErrorMessage" } }, "documentation": "Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.
The system-generated, unique 17-digit ID of the data repository task.
" }, "Lifecycle": { "shape": "DataRepositoryTaskLifecycle", "documentation": "The lifecycle status of the data repository task, as follows:
PENDING - The task has not started.
EXECUTING - The task is in process.
FAILED - The task was not able to be completed. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
SUCCEEDED - The task has completed successfully.
CANCELED - The task was canceled and it did not complete.
CANCELING - The task is in process of being canceled.
You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the PENDING or EXECUTING states. Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.
The type of data repository task.
EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.
IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.
AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.
The time the system began processing the task.
" }, "EndTime": { "shape": "EndTime", "documentation": "The time the system completed processing the task, populated after the task is complete.
" }, "ResourceARN": { "shape": "ResourceARN" }, "Tags": { "shape": "Tags" }, "FileSystemId": { "shape": "FileSystemId", "documentation": "The globally unique ID of the file system.
" }, "Paths": { "shape": "DataRepositoryTaskPaths", "documentation": "An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
(Default) If Paths is not specified, Amazon FSx uses the file system root directory.
Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.
Provides the status of the number of files that the task has processed successfully and failed to process.
" }, "Report": { "shape": "CompletionReport" }, "CapacityToRelease": { "shape": "CapacityToRelease", "documentation": "Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
" }, "FileCacheId": { "shape": "FileCacheId", "documentation": "The system-generated, unique ID of the cache.
" }, "ReleaseConfiguration": { "shape": "ReleaseConfiguration", "documentation": "The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.
" } }, "documentation": "A description of the data repository task.
You use import and export data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository.
You use release data repository tasks to release files that have been exported to a linked S3 bucket from your Amazon FSx for Lustre file system.
An Amazon File Cache resource uses a task to automatically release files from the cache.
To learn more about data repository tasks, see Data Repository Tasks.
" }, "DataRepositoryTaskFailureDetails": { "type": "structure", "members": { "Message": { "shape": "ErrorMessage" } }, "documentation": "Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.
Name of the task property to use in filtering the tasks returned in the response.
Use file-system-id to retrieve data repository tasks for specific file systems.
Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.
Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.
" } }, "documentation": "(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.
The total number of files that the task will process. While a task is executing, the sum of SucceededCount plus FailedCount may not equal TotalCount. When the task is complete, TotalCount equals the sum of SucceededCount plus FailedCount.
A running total of the number of files that the task has successfully processed.
" }, "FailedCount": { "shape": "FailedCount", "documentation": "A running total of the number of files that the task failed to process.
" }, "LastUpdatedTime": { "shape": "LastUpdatedTime", "documentation": "The time at which the task status was last updated.
" }, "ReleasedCapacity": { "shape": "ReleasedCapacity", "documentation": "The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
" } }, "documentation": "Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.
" }, "DataRepositoryTaskType": { "type": "string", "enum": [ "EXPORT_TO_REPOSITORY", "IMPORT_METADATA_FROM_REPOSITORY", "RELEASE_DATA_FROM_FILESYSTEM", "AUTO_RELEASE_DATA" ] }, "DataRepositoryTasks": { "type": "list", "member": { "shape": "DataRepositoryTask" }, "max": 50 }, "DeleteBackupRequest": { "type": "structure", "required": [ "BackupId" ], "members": { "BackupId": { "shape": "BackupId", "documentation": "The ID of the backup that you want to delete.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This parameter is automatically filled on your behalf when using the CLI or SDK.
", "idempotencyToken": true } }, "documentation": "The request object for the DeleteBackup operation.
The ID of the backup that was deleted.
" }, "Lifecycle": { "shape": "BackupLifecycle", "documentation": "The lifecycle status of the backup. If the DeleteBackup operation is successful, the status is DELETED.
The response object for the DeleteBackup operation.
The ID of the data repository association that you want to delete.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "DeleteDataInFileSystem": { "shape": "DeleteDataInFileSystem", "documentation": "Set to true to delete the data in the file system that corresponds to the data repository association.
The ID of the data repository association being deleted.
" }, "Lifecycle": { "shape": "DataRepositoryLifecycle", "documentation": "Describes the lifecycle state of the data repository association being deleted.
" }, "DeleteDataInFileSystem": { "shape": "DeleteDataInFileSystem", "documentation": "Indicates whether data in the file system that corresponds to the data repository association is being deleted. Default is false.
The ID of the cache that's being deleted.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true } } }, "DeleteFileCacheResponse": { "type": "structure", "members": { "FileCacheId": { "shape": "FileCacheId", "documentation": "The ID of the cache that's being deleted.
" }, "Lifecycle": { "shape": "FileCacheLifecycle", "documentation": "The cache lifecycle for the deletion request. If the DeleteFileCache operation is successful, this status is DELETING.
Set SkipFinalBackup to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the DeleteFileSystem operation is invoked. (Default = true)
The fsx:CreateBackup permission is required if you set SkipFinalBackup to false in order to delete the file system and take a final backup.
Use if SkipFinalBackup is set to false, and you want to apply an array of tags to the final backup. If you have set the file system property CopyTagsToBackups to true, and you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.
The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.
The ID of the final backup for this file system.
" }, "FinalBackupTags": { "shape": "Tags", "documentation": "The set of tags applied to the final backup.
" } }, "documentation": "The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.
By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip taking a final backup, set this value to true.
A list of tags to apply to the file system's final backup.
" }, "Options": { "shape": "DeleteFileSystemOpenZFSOptions", "documentation": "To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. If your file system has child volumes and you don't use this option, the delete request will fail.
The configuration object for the Amazon FSx for OpenZFS file system used in the DeleteFileSystem operation.
The response object for the Amazon FSx for OpenZFS file system that's being deleted in the DeleteFileSystem operation.
The ID of the file system that you want to delete.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This token is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken": true }, "WindowsConfiguration": { "shape": "DeleteFileSystemWindowsConfiguration" }, "LustreConfiguration": { "shape": "DeleteFileSystemLustreConfiguration" }, "OpenZFSConfiguration": { "shape": "DeleteFileSystemOpenZFSConfiguration", "documentation": "The configuration object for the OpenZFS file system used in the DeleteFileSystem operation.
The request object for DeleteFileSystem operation.
The ID of the file system that's being deleted.
" }, "Lifecycle": { "shape": "FileSystemLifecycle", "documentation": "The file system lifecycle for the deletion request. If the DeleteFileSystem operation is successful, this status is DELETING.
The response object for the OpenZFS file system that's being deleted in the DeleteFileSystem operation.
The response object for the DeleteFileSystem operation.
By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so.
A set of tags for your final backup.
" } }, "documentation": "The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.
The ID of the final backup for this file system.
" }, "FinalBackupTags": { "shape": "Tags", "documentation": "The set of tags applied to the final backup.
" } }, "documentation": "The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.
The ID of the snapshot that you want to delete.
" } } }, "DeleteSnapshotResponse": { "type": "structure", "members": { "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the deleted snapshot.
" }, "Lifecycle": { "shape": "SnapshotLifecycle", "documentation": "The lifecycle status of the snapshot. If the DeleteSnapshot operation is successful, this status is DELETING.
The ID of the SVM that you want to delete.
" } } }, "DeleteStorageVirtualMachineResponse": { "type": "structure", "members": { "StorageVirtualMachineId": { "shape": "StorageVirtualMachineId", "documentation": "The ID of the SVM Amazon FSx is deleting.
" }, "Lifecycle": { "shape": "StorageVirtualMachineLifecycle", "documentation": "Describes the lifecycle state of the SVM being deleted.
" } } }, "DeleteVolumeOntapConfiguration": { "type": "structure", "members": { "SkipFinalBackup": { "shape": "Flag", "documentation": "Set to true if you want to skip taking a final backup of the volume you are deleting.
" }, "FinalBackupTags": { "shape": "Tags" }, "BypassSnaplockEnterpriseRetention": { "shape": "Flag", "documentation": "Setting this to true allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. The IAM permission fsx:BypassSnaplockEnterpriseRetention is also required to delete SnapLock Enterprise volumes with unexpired WORM files. The default value is false.
For more information, see Deleting a SnapLock volume.
" } }, "documentation": "Use to specify skipping a final backup, adding tags to a final backup, or bypassing the retention period of an FSx for ONTAP SnapLock Enterprise volume when deleting an FSx for ONTAP volume.
" }, "DeleteVolumeOntapResponse": { "type": "structure", "members": { "FinalBackupId": { "shape": "BackupId" }, "FinalBackupTags": { "shape": "Tags" } }, "documentation": "The response object for the Amazon FSx for NetApp ONTAP volume being deleted in the DeleteVolume operation.
To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS.
A value that specifies whether to delete all child volumes and snapshots.
" }, "DeleteVolumeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume that you are deleting.
" }, "OntapConfiguration": { "shape": "DeleteVolumeOntapConfiguration", "documentation": "For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume and apply tags to the backup. To apply tags to the backup, you must have the fsx:TagResource permission.
For Amazon FSx for OpenZFS volumes, specify whether to delete all child volumes and snapshots.
" } } }, "DeleteVolumeResponse": { "type": "structure", "members": { "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume that's being deleted.
" }, "Lifecycle": { "shape": "VolumeLifecycle", "documentation": "The lifecycle state of the volume being deleted. If the DeleteVolume operation is successful, this value is DELETING.
Returned after a DeleteVolume request, showing the status of the delete request.
The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound error occurs.
The filters structure. The supported names are file-system-id, backup-type, file-system-type, and volume-id.
Maximum number of backups to return in the response. This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
An opaque pagination token returned from a previous DescribeBackups operation. If a token is present, the operation continues the list from where the returning call left off.
The request object for the DescribeBackups operation.
An array of backups.
" }, "NextToken": { "shape": "NextToken", "documentation": "A NextToken value is present if there are more backups than returned in the response. You can use the NextToken value in the subsequent request to fetch the backups.
Response object for the DescribeBackups operation.
IDs of the data repository associations whose descriptions you want to retrieve (String).
" }, "Filters": { "shape": "Filters" }, "MaxResults": { "shape": "LimitedMaxResults", "documentation": "The maximum number of resources to return in the response. This value must be an integer greater than zero.
" }, "NextToken": { "shape": "NextToken" } } }, "DescribeDataRepositoryAssociationsResponse": { "type": "structure", "members": { "Associations": { "shape": "DataRepositoryAssociations", "documentation": "An array of one or more data repository association descriptions.
" }, "NextToken": { "shape": "NextToken" } } }, "DescribeDataRepositoryTasksRequest": { "type": "structure", "members": { "TaskIds": { "shape": "TaskIds", "documentation": "(Optional) IDs of the tasks whose descriptions you want to retrieve (String).
" }, "Filters": { "shape": "DataRepositoryTaskFilters", "documentation": "(Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just tasks for specific file systems, or tasks in a specific lifecycle state.
The collection of data repository task descriptions returned.
" }, "NextToken": { "shape": "NextToken" } } }, "DescribeFileCachesRequest": { "type": "structure", "members": { "FileCacheIds": { "shape": "FileCacheIds", "documentation": "IDs of the caches whose descriptions you want to retrieve (String).
" }, "MaxResults": { "shape": "MaxResults" }, "NextToken": { "shape": "NextToken" } } }, "DescribeFileCachesResponse": { "type": "structure", "members": { "FileCaches": { "shape": "FileCaches", "documentation": "The response object for the DescribeFileCaches operation.
The ID of the file system to return the associated DNS aliases for (String).
" }, "MaxResults": { "shape": "MaxResults", "documentation": "Maximum number of DNS aliases to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
Opaque pagination token returned from a previous DescribeFileSystemAliases operation (String). If a token is included in the request, the action continues the list from where the previous returning call left off.
The request object for DescribeFileSystemAliases operation.
An array of one or more DNS aliases currently associated with the specified file system.
" }, "NextToken": { "shape": "NextToken", "documentation": "Present if there are more DNS aliases than returned in the response (String). You can use the NextToken value in a later request to fetch additional descriptions.
The response object for DescribeFileSystemAliases operation.
IDs of the file systems whose descriptions you want to retrieve (String).
" }, "MaxResults": { "shape": "MaxResults", "documentation": "Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.
The request object for DescribeFileSystems operation.
An array of file system descriptions.
" }, "NextToken": { "shape": "NextToken", "documentation": "Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.
The response object for DescribeFileSystems operation.
Indicates whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets.
" } } }, "DescribeSnapshotsRequest": { "type": "structure", "members": { "SnapshotIds": { "shape": "SnapshotIds", "documentation": "The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.
The filters structure. The supported names are file-system-id or volume-id.
Set to false (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to true if you want to see the snapshots in your account and the ones shared with you from another account.
An array of snapshots.
" }, "NextToken": { "shape": "NextToken" } } }, "DescribeStorageVirtualMachinesRequest": { "type": "structure", "members": { "StorageVirtualMachineIds": { "shape": "StorageVirtualMachineIds", "documentation": "Enter the ID of one or more SVMs that you want to view.
" }, "Filters": { "shape": "StorageVirtualMachineFilters", "documentation": "Enter a filter name:value pair to view a select set of SVMs.
" }, "MaxResults": { "shape": "MaxResults" }, "NextToken": { "shape": "NextToken" } } }, "DescribeStorageVirtualMachinesResponse": { "type": "structure", "members": { "StorageVirtualMachines": { "shape": "StorageVirtualMachines", "documentation": "Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.
The IDs of the volumes whose descriptions you want to retrieve.
" }, "Filters": { "shape": "VolumeFilters", "documentation": "Enter a filter Name and Values pair to view a select set of volumes.
Returned after a successful DescribeVolumes operation, describing each volume.
Specifies the file system from which to disassociate the DNS aliases.
" }, "Aliases": { "shape": "AlternateDNSNames", "documentation": "An array of one or more DNS alias names to disassociate, or remove, from the file system.
" } }, "documentation": "The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
" }, "DisassociateFileSystemAliasesResponse": { "type": "structure", "members": { "Aliases": { "shape": "Aliases", "documentation": "An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.
" } }, "documentation": "The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.
" }, "DiskIopsConfiguration": { "type": "structure", "members": { "Mode": { "shape": "DiskIopsConfigurationMode", "documentation": "Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.
The total number of SSD IOPS provisioned for the file system.
The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.
Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
" }, "DiskIopsConfigurationMode": { "type": "string", "enum": [ "AUTOMATIC", "USER_PROVISIONED" ] }, "DnsIps": { "type": "list", "member": { "shape": "IpAddress" }, "max": 3, "min": 1 }, "DriveCacheType": { "type": "string", "enum": [ "NONE", "READ" ] }, "DurationSinceLastAccess": { "type": "structure", "members": { "Unit": { "shape": "Unit", "documentation": "The unit of time used by the Value parameter to determine if a file can be released, based on when it was last accessed. DAYS is the only supported value. This is a required parameter.
An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported files with a MAX(atime, ctime, mtime) timestamp that is more than this amount of time in the past (relative to the task create time) will be released. The default of Value is 0. This is a required parameter.
If an exported file meets the last accessed time criteria, its file or directory path must also be specified in the Paths parameter of the operation in order for the file to be released.
Defines the minimum amount of time since last access for a file to be eligible for release. Only files that have been exported to S3 and that were last accessed or modified before this point-in-time are eligible to be released from the Amazon FSx for Lustre file system.
" }, "EndTime": { "type": "timestamp" }, "ErrorMessage": { "type": "string", "documentation": "A detailed error message.
", "max": 256, "min": 1 }, "EventType": { "type": "string", "enum": [ "NEW", "CHANGED", "DELETED" ] }, "EventTypes": { "type": "list", "member": { "shape": "EventType" }, "max": 3 }, "FailedCount": { "type": "long" }, "FileCache": { "type": "structure", "members": { "OwnerId": { "shape": "AWSAccountId" }, "CreationTime": { "shape": "CreationTime" }, "FileCacheId": { "shape": "FileCacheId", "documentation": "The system-generated, unique ID of the cache.
" }, "FileCacheType": { "shape": "FileCacheType", "documentation": "The type of cache, which must be LUSTRE.
The Lustre version of the cache, which must be 2.12.
The lifecycle status of the cache. The following are the possible values and what they mean:
AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
CREATING - The new cache is being created.
DELETING - An existing cache is being deleted.
UPDATING - The cache is undergoing a customer-initiated update.
FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
A structure providing details of any failures that occurred.
" }, "StorageCapacity": { "shape": "StorageCapacity", "documentation": "The storage capacity of the cache in gibibytes (GiB).
" }, "VpcId": { "shape": "VpcId" }, "SubnetIds": { "shape": "SubnetIds" }, "NetworkInterfaceIds": { "shape": "NetworkInterfaceIds" }, "DNSName": { "shape": "DNSName", "documentation": "The Domain Name System (DNS) name for the cache.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
The configuration for the Amazon File Cache resource.
" }, "DataRepositoryAssociationIds": { "shape": "DataRepositoryAssociationIds", "documentation": "A list of IDs of data repository associations that are associated with this cache.
" } }, "documentation": "A description of a specific Amazon File Cache resource, which is a response object from the DescribeFileCaches operation.
The system-generated, unique ID of the cache.
" }, "FileCacheType": { "shape": "FileCacheType", "documentation": "The type of cache, which must be LUSTRE.
The Lustre version of the cache, which must be 2.12.
The lifecycle status of the cache. The following are the possible values and what they mean:
AVAILABLE - The cache is in a healthy state, and is reachable and available for use.
CREATING - The new cache is being created.
DELETING - An existing cache is being deleted.
UPDATING - The cache is undergoing a customer-initiated update.
FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
A structure providing details of any failures that occurred.
" }, "StorageCapacity": { "shape": "StorageCapacity", "documentation": "The storage capacity of the cache in gibibytes (GiB).
" }, "VpcId": { "shape": "VpcId" }, "SubnetIds": { "shape": "SubnetIds" }, "NetworkInterfaceIds": { "shape": "NetworkInterfaceIds" }, "DNSName": { "shape": "DNSName", "documentation": "The Domain Name System (DNS) name for the cache.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
A boolean flag indicating whether tags for the cache should be copied to data repository associations.
" }, "LustreConfiguration": { "shape": "FileCacheLustreConfiguration", "documentation": "The configuration for the Amazon File Cache resource.
" }, "DataRepositoryAssociationIds": { "shape": "DataRepositoryAssociationIds", "documentation": "A list of IDs of data repository associations that are associated with this cache.
" } }, "documentation": "The response object for the Amazon File Cache resource being created in the CreateFileCache operation.
A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.
This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.
The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.
The cache path cannot be set to root (/) for an S3 DRA.
The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:
The path can be an NFS data repository that links to the cache. The path can be in one of two formats:
If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.
If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.
The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.
A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.
The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.
" } }, "documentation": "The configuration for a data repository association (DRA) to be created during the Amazon File Cache resource creation. The DRA links the cache to either an Amazon S3 bucket or prefix, or a Network File System (NFS) data repository that supports the NFSv3 protocol.
The DRA does not support automatic import or automatic export.
" }, "FileCacheFailureDetails": { "type": "structure", "members": { "Message": { "shape": "ErrorMessage", "documentation": "A message describing any failures that occurred.
" } }, "documentation": "A structure providing details of any failures that occurred.
" }, "FileCacheId": { "type": "string", "max": 21, "min": 11, "pattern": "^(fc-[0-9a-f]{8,})$" }, "FileCacheIds": { "type": "list", "member": { "shape": "FileCacheId" }, "max": 50 }, "FileCacheLifecycle": { "type": "string", "enum": [ "AVAILABLE", "CREATING", "DELETING", "UPDATING", "FAILED" ] }, "FileCacheLustreConfiguration": { "type": "structure", "members": { "PerUnitStorageThroughput": { "shape": "PerUnitStorageThroughput", "documentation": "Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only supported value is 1000.
The deployment type of the Amazon File Cache resource, which must be CACHE_1.
You use the MountName value when mounting the cache. If you pass a cache ID to the DescribeFileCaches operation, it returns the the MountName value as part of the cache's description.
The configuration for a Lustre MDT (Metadata Target) storage volume.
" }, "LogConfiguration": { "shape": "LustreLogConfiguration", "documentation": "The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs.
" } }, "documentation": "The configuration for the Amazon File Cache resource.
" }, "FileCacheLustreDeploymentType": { "type": "string", "enum": [ "CACHE_1" ] }, "FileCacheLustreMetadataConfiguration": { "type": "structure", "required": [ "StorageCapacity" ], "members": { "StorageCapacity": { "shape": "MetadataStorageCapacity", "documentation": "The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
The configuration for a Lustre MDT (Metadata Target) storage volume. The metadata on Amazon File Cache is managed by a Lustre Metadata Server (MDS) while the actual metadata is persisted on an MDT.
" }, "FileCacheNFSConfiguration": { "type": "structure", "required": [ "Version" ], "members": { "Version": { "shape": "NfsVersion", "documentation": "The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.
A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
" } }, "documentation": "The configuration for an NFS data repository association (DRA) created during the creation of the Amazon File Cache resource.
" }, "FileCacheType": { "type": "string", "enum": [ "LUSTRE" ] }, "FileCaches": { "type": "list", "member": { "shape": "FileCache" }, "max": 50 }, "FileSystem": { "type": "structure", "members": { "OwnerId": { "shape": "AWSAccountId", "documentation": "The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.
" }, "CreationTime": { "shape": "CreationTime", "documentation": "The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
" }, "FileSystemId": { "shape": "FileSystemId", "documentation": "The system-generated, unique 17-digit ID of the file system.
" }, "FileSystemType": { "shape": "FileSystemType", "documentation": "The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.
The lifecycle status of the file system. The following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED - The file system is in a failed but recoverable state.
MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.
UPDATING - The file system is undergoing a customer-initiated update.
The storage capacity of the file system in gibibytes (GiB).
Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.
The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.
The ID of the primary virtual private cloud (VPC) for the file system.
" }, "SubnetIds": { "shape": "SubnetIds", "documentation": "Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.
For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.
The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
" }, "DNSName": { "shape": "DNSName", "documentation": "The Domain Name System (DNS) name for the file system.
" }, "KmsKeyId": { "shape": "KmsKeyId", "documentation": "The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:
Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.
SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
The Amazon Resource Name (ARN) of the file system resource.
" }, "Tags": { "shape": "Tags", "documentation": "The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.
" }, "WindowsConfiguration": { "shape": "WindowsFileSystemConfiguration", "documentation": "The configuration for this Amazon FSx for Windows File Server file system.
" }, "LustreConfiguration": { "shape": "LustreFileSystemConfiguration" }, "AdministrativeActions": { "shape": "AdministrativeActions", "documentation": "A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.
The configuration for this Amazon FSx for NetApp ONTAP file system.
" }, "FileSystemTypeVersion": { "shape": "FileSystemTypeVersion", "documentation": "The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.
The configuration for this Amazon FSx for OpenZFS file system.
" } }, "documentation": "A description of a specific Amazon FSx file system.
" }, "FileSystemAdministratorsGroupName": { "type": "string", "max": 256, "min": 1, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$" }, "FileSystemEndpoint": { "type": "structure", "members": { "DNSName": { "shape": "DNSName" }, "IpAddresses": { "shape": "OntapEndpointIpAddresses", "documentation": "IP addresses of the file system endpoint.
" } }, "documentation": "An Amazon FSx for NetApp ONTAP file system has two endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. They are the Management and Intercluster endpoints.
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
" }, "Management": { "shape": "FileSystemEndpoint", "documentation": "An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
" } }, "documentation": "An Amazon FSx for NetApp ONTAP file system has the following endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
" }, "FileSystemFailureDetails": { "type": "structure", "members": { "Message": { "shape": "ErrorMessage", "documentation": "A message describing any failures that occurred.
" } }, "documentation": "A structure providing details of any failures that occurred.
" }, "FileSystemId": { "type": "string", "documentation": "The globally unique ID of the file system, assigned by Amazon FSx.
", "max": 21, "min": 11, "pattern": "^(fs-[0-9a-f]{8,})$" }, "FileSystemIds": { "type": "list", "member": { "shape": "FileSystemId" }, "documentation": "A list of file system IDs.
", "max": 50 }, "FileSystemLifecycle": { "type": "string", "documentation": "The lifecycle status of the file system.
", "enum": [ "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING", "MISCONFIGURED_UNAVAILABLE" ] }, "FileSystemMaintenanceOperation": { "type": "string", "documentation": "An enumeration specifying the currently ongoing maintenance operation.
", "enum": [ "PATCHING", "BACKING_UP" ] }, "FileSystemMaintenanceOperations": { "type": "list", "member": { "shape": "FileSystemMaintenanceOperation" }, "documentation": "A list of maintenance operations.
", "max": 20 }, "FileSystemType": { "type": "string", "documentation": "The type of file system.
", "enum": [ "WINDOWS", "LUSTRE", "ONTAP", "OPENZFS" ] }, "FileSystemTypeVersion": { "type": "string", "max": 20, "min": 1, "pattern": "^[0-9](.[0-9]*)*$" }, "FileSystems": { "type": "list", "member": { "shape": "FileSystem" }, "documentation": "A list of file system resource descriptions.
", "max": 50 }, "Filter": { "type": "structure", "members": { "Name": { "shape": "FilterName", "documentation": "The name for this filter.
" }, "Values": { "shape": "FilterValues", "documentation": "The values of the filter. These are all the values for any of the applied filters.
" } }, "documentation": "A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.
" }, "FilterName": { "type": "string", "documentation": "The name for a filter.
", "enum": [ "file-system-id", "backup-type", "file-system-type", "volume-id", "data-repository-type", "file-cache-id", "file-cache-type" ] }, "FilterValue": { "type": "string", "documentation": "The value for a filter.
", "max": 128, "min": 1, "pattern": "^[0-9a-zA-Z\\*\\.\\\\/\\?\\-\\_]*$" }, "FilterValues": { "type": "list", "member": { "shape": "FilterValue" }, "documentation": "A list of filter values.
", "max": 20 }, "Filters": { "type": "list", "member": { "shape": "Filter" }, "documentation": "A list of Filter elements.
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:
Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.
SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
Describes why a resource lifecycle state changed.
" }, "LimitedMaxResults": { "type": "integer", "max": 25, "min": 1 }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ResourceARN" ], "members": { "ResourceARN": { "shape": "ResourceARN", "documentation": "The ARN of the Amazon FSx resource that will have its tags listed.
" }, "MaxResults": { "shape": "MaxResults", "documentation": "Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off.
The request object for ListTagsForResource operation.
A list of tags on the resource.
" }, "NextToken": { "shape": "NextToken", "documentation": "This is present if there are more tags than returned in the response (String). You can use the NextToken value in the later request to fetch the tags.
The response object for ListTagsForResource operation.
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.
The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.
The default is SCRATCH_1.
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.
Valid values:
For PERSISTENT_1 SSD storage: 50, 100, 200.
For PERSISTENT_1 HDD storage: 12, 40.
For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.
You use the MountName value when mounting the file system.
For the SCRATCH_1 deployment type, this value is always \"fsx\". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.
A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
" }, "DriveCacheType": { "shape": "DriveCacheType", "documentation": "The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.
This parameter is required when StorageType is set to HDD.
The data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression.
" }, "LogConfiguration": { "shape": "LustreLogConfiguration", "documentation": "The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.
" }, "RootSquashConfiguration": { "shape": "LustreRootSquashConfiguration", "documentation": "The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
" } }, "documentation": "The configuration for the Amazon FSx for Lustre file system.
" }, "LustreFileSystemMountName": { "type": "string", "max": 8, "min": 1, "pattern": "^([A-Za-z0-9_-]{1,8})$" }, "LustreLogConfiguration": { "type": "structure", "required": [ "Level" ], "members": { "Level": { "shape": "LustreAccessAuditLogLevel", "documentation": "The data repository events that are logged by Amazon FSx.
WARN_ONLY - only warning events are logged.
ERROR_ONLY - only error events are logged.
WARN_ERROR - both warning events and error events are logged.
DISABLED - logging of data repository events is turned off.
Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.
The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
" } }, "documentation": "The configuration for Lustre logging used to write the enabled logging events for your Amazon FSx for Lustre file system or Amazon File Cache resource to Amazon CloudWatch Logs.
" }, "LustreLogCreateConfiguration": { "type": "structure", "required": [ "Level" ], "members": { "Level": { "shape": "LustreAccessAuditLogLevel", "documentation": "Sets which data repository events are logged by Amazon FSx.
WARN_ONLY - only warning events are logged.
ERROR_ONLY - only error events are logged.
WARN_ERROR - both warning events and error events are logged.
DISABLED - logging of data repository events is turned off.
The Amazon Resource Name (ARN) that specifies the destination of the logs.
The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:
The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.
If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon File Cache).
If Destination is provided and the resource does not exist, the request will fail with a BadRequest error.
If Level is set to DISABLED, you cannot specify a destination in Destination.
The Lustre logging configuration used when creating or updating an Amazon FSx for Lustre file system. An Amazon File Cache is created with Lustre logging enabled by default, with a setting of WARN_ERROR for the logging events. which can't be changed.
Lustre logging writes the enabled logging events for your file system or cache to Amazon CloudWatch Logs.
" }, "LustreNoSquashNid": { "type": "string", "max": 43, "min": 11, "pattern": "^([0-9\\[\\]\\-]*\\.){3}([0-9\\[\\]\\-]*)@tcp$" }, "LustreNoSquashNids": { "type": "list", "member": { "shape": "LustreNoSquashNid" }, "max": 64 }, "LustreRootSquash": { "type": "string", "max": 21, "min": 3, "pattern": "^([0-9]{1,10}):([0-9]{1,10})$" }, "LustreRootSquashConfiguration": { "type": "structure", "members": { "RootSquash": { "shape": "LustreRootSquash", "documentation": "You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:
A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.
A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.
When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.
" }, "NoSquashNids": { "shape": "LustreNoSquashNids", "documentation": "When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:
A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).
An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).
The configuration for Lustre root squash used to restrict root-level access from clients that try to access your FSx for Lustre file system as root. Use the RootSquash parameter to enable root squash. To learn more about Lustre root squash, see Lustre root squash.
You can also use the NoSquashNids parameter to provide an array of clients who are not affected by the root squash setting. These clients will access the file system as root, with unrestricted privileges.
The maximum number of resources to return in the response. This value must be an integer greater than zero.
", "max": 2147483647, "min": 1 }, "Megabytes": { "type": "integer", "max": 512000, "min": 1 }, "MegabytesPerSecond": { "type": "integer", "documentation": "The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).
", "max": 100000, "min": 8 }, "MetadataStorageCapacity": { "type": "integer", "max": 2147483647, "min": 0 }, "NFSDataRepositoryConfiguration": { "type": "structure", "required": [ "Version" ], "members": { "Version": { "shape": "NfsVersion", "documentation": "The version of the NFS (Network File System) protocol of the NFS data repository. Currently, the only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.
A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
" }, "AutoExportPolicy": { "shape": "AutoExportPolicy", "documentation": "This parameter is not supported for Amazon File Cache.
" } }, "documentation": "The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.
" }, "Namespace": { "type": "string", "max": 4096, "min": 1, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,4096}$" }, "NetBiosAlias": { "type": "string", "max": 15, "min": 1, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$" }, "NetworkInterfaceId": { "type": "string", "documentation": "An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances.
", "max": 21, "min": 12, "pattern": "^(eni-[0-9a-f]{8,})$" }, "NetworkInterfaceIds": { "type": "list", "member": { "shape": "NetworkInterfaceId" }, "documentation": "A list of network interface IDs.
", "max": 50 }, "NextToken": { "type": "string", "documentation": "(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.
Specifies the FSx for ONTAP file system deployment type in use in the file system.
MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.
SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.
SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.
" }, "EndpointIpAddressRange": { "shape": "IpAddressRange", "documentation": "(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
" }, "Endpoints": { "shape": "FileSystemEndpoints", "documentation": "The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
" }, "PreferredSubnetId": { "shape": "SubnetId" }, "RouteTableIds": { "shape": "RouteTableIds", "documentation": "(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
" }, "ThroughputCapacity": { "shape": "MegabytesPerSecond" }, "WeeklyMaintenanceStartTime": { "shape": "WeeklyTime" }, "FsxAdminPassword": { "shape": "AdminPassword", "documentation": "You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.
Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Configuration for the FSx for NetApp ONTAP file system.
" }, "OntapVolumeConfiguration": { "type": "structure", "members": { "FlexCacheEndpointType": { "shape": "FlexCacheEndpointType", "documentation": "Specifies the FlexCache endpoint type of the volume. Valid values are the following:
NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
CACHE specifies that the volume is a FlexCache volume.
Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
The security style for the volume, which can be UNIX, NTFS, or MIXED.
The configured size of the volume, in megabytes (MBs).
" }, "StorageEfficiencyEnabled": { "shape": "Flag", "documentation": "The volume's storage efficiency setting.
" }, "StorageVirtualMachineId": { "shape": "StorageVirtualMachineId", "documentation": "The ID of the volume's storage virtual machine.
" }, "StorageVirtualMachineRoot": { "shape": "Flag", "documentation": "A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
The volume's TieringPolicy setting.
The volume's universally unique identifier (UUID).
" }, "OntapVolumeType": { "shape": "OntapVolumeType", "documentation": "Specifies the type of volume. Valid values are the following:
RW specifies a read/write volume. RW is the default.
DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
" }, "CopyTagsToBackups": { "shape": "Flag", "documentation": "A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
" }, "SnaplockConfiguration": { "shape": "SnaplockConfiguration", "documentation": "The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
" }, "VolumeStyle": { "shape": "VolumeStyle", "documentation": "Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
" }, "AggregateConfiguration": { "shape": "AggregateConfiguration", "documentation": "This structure specifies configuration options for a volume’s storage aggregate or aggregates.
" }, "SizeInBytes": { "shape": "VolumeCapacityBytes", "documentation": "The configured size of the volume, in bytes.
" } }, "documentation": "The configuration of an Amazon FSx for NetApp ONTAP volume.
" }, "OntapVolumeType": { "type": "string", "enum": [ "RW", "DP", "LS" ] }, "OpenZFSClientConfiguration": { "type": "structure", "required": [ "Clients", "Options" ], "members": { "Clients": { "shape": "OpenZFSClients", "documentation": "A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.
The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:
crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
" }, "OpenZFSClientConfigurations": { "type": "list", "member": { "shape": "OpenZFSClientConfiguration" }, "max": 25 }, "OpenZFSClients": { "type": "string", "max": 128, "min": 1, "pattern": "^[ -~]{1,128}$" }, "OpenZFSCopyStrategy": { "type": "string", "enum": [ "CLONE", "FULL_COPY", "INCREMENTAL_COPY" ] }, "OpenZFSCreateRootVolumeConfiguration": { "type": "structure", "members": { "RecordSizeKiB": { "shape": "IntegerRecordSizeKiB", "documentation": "Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
" }, "DataCompressionType": { "shape": "OpenZFSDataCompressionType", "documentation": "Specifies the method used to compress the data on the volume. The compression type is NONE by default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
The configuration object for mounting a file system.
" }, "UserAndGroupQuotas": { "shape": "OpenZFSUserAndGroupQuotas", "documentation": "An object specifying how much storage users or groups can use on the volume.
" }, "CopyTagsToSnapshots": { "shape": "Flag", "documentation": "A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
The configuration of an Amazon FSx for OpenZFS root volume.
" }, "OpenZFSDataCompressionType": { "type": "string", "enum": [ "NONE", "ZSTD", "LZ4" ] }, "OpenZFSDeploymentType": { "type": "string", "enum": [ "SINGLE_AZ_1", "SINGLE_AZ_2", "MULTI_AZ_1" ] }, "OpenZFSFileSystemConfiguration": { "type": "structure", "members": { "AutomaticBackupRetentionDays": { "shape": "AutomaticBackupRetentionDays" }, "CopyTagsToBackups": { "shape": "Flag", "documentation": "A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
MULTI_AZ_1, SINGLE_AZ_1, and SINGLE_AZ_2.
The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).
" }, "WeeklyMaintenanceStartTime": { "shape": "WeeklyTime" }, "DiskIopsConfiguration": { "shape": "DiskIopsConfiguration" }, "RootVolumeId": { "shape": "VolumeId", "documentation": "The ID of the root volume of the OpenZFS file system.
" }, "PreferredSubnetId": { "shape": "SubnetId", "documentation": "Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
" }, "RouteTableIds": { "shape": "RouteTableIds", "documentation": "(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
" }, "EndpointIpAddress": { "shape": "IpAddress", "documentation": "The IP address of the endpoint that is used to access data or to manage the file system.
" } }, "documentation": "The configuration for the Amazon FSx for OpenZFS file system.
" }, "OpenZFSNfsExport": { "type": "structure", "required": [ "ClientConfigurations" ], "members": { "ClientConfigurations": { "shape": "OpenZFSClientConfigurations", "documentation": "A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
" } }, "documentation": "The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.
" }, "OpenZFSNfsExportOption": { "type": "string", "max": 128, "min": 1, "pattern": "^[ -~]{1,128}$" }, "OpenZFSNfsExportOptions": { "type": "list", "member": { "shape": "OpenZFSNfsExportOption" }, "max": 20, "min": 1 }, "OpenZFSNfsExports": { "type": "list", "member": { "shape": "OpenZFSNfsExport" }, "max": 1 }, "OpenZFSOriginSnapshotConfiguration": { "type": "structure", "members": { "SnapshotARN": { "shape": "ResourceARN" }, "CopyStrategy": { "shape": "OpenZFSCopyStrategy", "documentation": "The strategy used when copying data from the snapshot to the new volume.
CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
FULL_COPY - Copies all data from the snapshot to the new volume.
The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
The snapshot configuration used when creating an Amazon FSx for OpenZFS volume from a snapshot.
" }, "OpenZFSQuotaType": { "type": "string", "enum": [ "USER", "GROUP" ] }, "OpenZFSUserAndGroupQuotas": { "type": "list", "member": { "shape": "OpenZFSUserOrGroupQuota" }, "max": 500 }, "OpenZFSUserOrGroupQuota": { "type": "structure", "required": [ "Type", "Id", "StorageCapacityQuotaGiB" ], "members": { "Type": { "shape": "OpenZFSQuotaType", "documentation": "Specifies whether the quota applies to a user or group.
" }, "Id": { "shape": "IntegerNoMax", "documentation": "The ID of the user or group that the quota applies to.
" }, "StorageCapacityQuotaGiB": { "shape": "IntegerNoMax", "documentation": "The user or group's storage quota, in gibibytes (GiB).
" } }, "documentation": "Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide.
" }, "OpenZFSVolumeConfiguration": { "type": "structure", "members": { "ParentVolumeId": { "shape": "VolumeId", "documentation": "The ID of the parent volume.
" }, "VolumePath": { "shape": "VolumePath", "documentation": "The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
" }, "StorageCapacityQuotaGiB": { "shape": "IntegerNoMax", "documentation": "The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
" }, "RecordSizeKiB": { "shape": "IntegerRecordSizeKiB", "documentation": "The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.
" }, "DataCompressionType": { "shape": "OpenZFSDataCompressionType", "documentation": "Specifies the method used to compress the data on the volume. The compression type is NONE by default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
" }, "ReadOnly": { "shape": "ReadOnly", "documentation": "A Boolean value indicating whether the volume is read-only.
" }, "NfsExports": { "shape": "OpenZFSNfsExports", "documentation": "The configuration object for mounting a Network File System (NFS) file system.
" }, "UserAndGroupQuotas": { "shape": "OpenZFSUserAndGroupQuotas", "documentation": "An object specifying how much storage users or groups can use on the volume.
" }, "RestoreToSnapshot": { "shape": "SnapshotId", "documentation": "Specifies the ID of the snapshot to which the volume was restored.
" }, "DeleteIntermediateSnaphots": { "shape": "Flag", "documentation": "A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.
" }, "DeleteClonedVolumes": { "shape": "Flag", "documentation": "A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.
" }, "DeleteIntermediateData": { "shape": "Flag", "documentation": "A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.
" }, "SourceSnapshotARN": { "shape": "ResourceARN" }, "DestinationSnapshot": { "shape": "SnapshotId", "documentation": "The ID of the snapshot that's being copied or was most recently copied to the destination volume.
" }, "CopyStrategy": { "shape": "OpenZFSCopyStrategy", "documentation": "Specifies the strategy used when copying data from the snapshot to the new volume.
CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
FULL_COPY - Copies all data from the snapshot to the new volume.
Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.
The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
The configuration of an Amazon FSx for OpenZFS volume.
" }, "OrganizationalUnitDistinguishedName": { "type": "string", "max": 2000, "min": 1, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,2000}$" }, "PerUnitStorageThroughput": { "type": "integer", "max": 1000, "min": 12 }, "PrivilegedDelete": { "type": "string", "enum": [ "DISABLED", "ENABLED", "PERMANENTLY_DISABLED" ] }, "ProgressPercent": { "type": "integer", "documentation": "Displays the current percent of progress of an asynchronous task.
", "max": 100, "min": 0 }, "ReadOnly": { "type": "boolean" }, "Region": { "type": "string", "max": 20, "min": 1, "pattern": "^[a-z0-9-]{1,20}$" }, "ReleaseConfiguration": { "type": "structure", "members": { "DurationSinceLastAccess": { "shape": "DurationSinceLastAccess", "documentation": "Defines the point-in-time since an exported file was last accessed, in order for that file to be eligible for release. Only files that were last accessed before this point-in-time are eligible to be released from the file system.
" } }, "documentation": "The configuration that specifies a minimum amount of time since last access for an exported file to be eligible for release from an Amazon FSx for Lustre file system. Only files that were last accessed before this point-in-time can be released. For example, if you specify a last accessed time criteria of 9 days, only files that were last accessed 9.00001 or more days ago can be released.
Only file data that has been exported to S3 can be released. Files that have not yet been exported to S3, such as new or changed files that have not been exported, are not eligible for release. When files are released, their metadata stays on the file system, so they can still be accessed later. Users and applications can access a released file by reading the file again, which restores data from Amazon S3 to the FSx for Lustre file system.
If a file meets the last accessed time criteria, its file or directory path must also be specified with the Paths parameter of the operation in order for the file to be released.
The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "max": 512, "min": 8, "pattern": "^arn:(?=[^:]+:fsx:[^:]+:\\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\\d{1,3}(\\.\\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\\.)(?![^:]*\\.-)[a-z0-9].*(?The ID of the volume that you are restoring." }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the source snapshot. Specifies the snapshot that you are restoring from.
" }, "Options": { "shape": "RestoreOpenZFSVolumeOptions", "documentation": "The settings used when restoring the specified volume from snapshot.
DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.
DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.
The ID of the volume that you restored.
" }, "Lifecycle": { "shape": "VolumeLifecycle", "documentation": "The lifecycle state of the volume being restored.
" }, "AdministrativeActions": { "shape": "AdministrativeActions", "documentation": "A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
" } } }, "RetentionPeriod": { "type": "structure", "required": [ "Type" ], "members": { "Type": { "shape": "RetentionPeriodType", "documentation": "Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:
Seconds: 0 - 65,535
Minutes: 0 - 65,535
Hours: 0 - 24
Days: 0 - 365
Months: 0 - 12
Years: 0 - 100
Specifies the retention period of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Files can't be deleted or modified during the retention period.
For more information, see Working with the retention period in SnapLock.
" }, "RetentionPeriodType": { "type": "string", "enum": [ "SECONDS", "MINUTES", "HOURS", "DAYS", "MONTHS", "YEARS", "INFINITE", "UNSPECIFIED" ] }, "RetentionPeriodValue": { "type": "integer", "max": 65535, "min": 0 }, "RouteTableId": { "type": "string", "max": 21, "min": 12, "pattern": "^(rtb-[0-9a-f]{8,})$" }, "RouteTableIds": { "type": "list", "member": { "shape": "RouteTableId" }, "max": 50 }, "S3DataRepositoryConfiguration": { "type": "structure", "members": { "AutoImportPolicy": { "shape": "AutoImportPolicy", "documentation": "Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system.
" }, "AutoExportPolicy": { "shape": "AutoExportPolicy", "documentation": "Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket.
" } }, "documentation": "The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association. The configuration consists of an AutoImportPolicy that defines which file events on the data repository are automatically imported to the file system and an AutoExportPolicy that defines which file events on the file system are automatically exported to the data repository. File events are when files or directories are added, changed, or deleted on the file system or the data repository.
Data repository associations on Amazon File Cache don't use S3DataRepositoryConfiguration because they don't support automatic import or automatic export.
The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security groups for Linux instances in the Amazon EC2 User Guide.
", "max": 20, "min": 11, "pattern": "^(sg-[0-9a-f]{8,})$" }, "SecurityGroupIds": { "type": "list", "member": { "shape": "SecurityGroupId" }, "documentation": "A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
", "max": 50 }, "SecurityStyle": { "type": "string", "enum": [ "UNIX", "NTFS", "MIXED" ] }, "SelfManagedActiveDirectoryAttributes": { "type": "structure", "members": { "DomainName": { "shape": "ActiveDirectoryFullyQualifiedName", "documentation": "The fully qualified domain name of the self-managed AD directory.
" }, "OrganizationalUnitDistinguishedName": { "shape": "OrganizationalUnitDistinguishedName", "documentation": "The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
" }, "FileSystemAdministratorsGroup": { "shape": "FileSystemAdministratorsGroupName", "documentation": "The name of the domain group whose members have administrative privileges for the FSx file system.
" }, "UserName": { "shape": "DirectoryUserName", "documentation": "The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
" }, "DnsIps": { "shape": "DnsIps", "documentation": "A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
" } }, "documentation": "The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
" }, "SelfManagedActiveDirectoryConfiguration": { "type": "structure", "required": [ "DomainName", "UserName", "Password", "DnsIps" ], "members": { "DomainName": { "shape": "ActiveDirectoryFullyQualifiedName", "documentation": "The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
" }, "UserName": { "shape": "DirectoryUserName", "documentation": "The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
" }, "DnsIps": { "shape": "DnsIps", "documentation": "A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
" } }, "documentation": "The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs.
" }, "SelfManagedActiveDirectoryConfigurationUpdates": { "type": "structure", "members": { "UserName": { "shape": "DirectoryUserName", "documentation": "Specifies the updated user name for the service account on your self-managed AD domain. Amazon FSx uses this account to join to your self-managed AD domain.
This account must have the permissions required to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName.
Specifies the updated password for the service account on your self-managed AD domain. Amazon FSx uses this account to join to your self-managed AD domain.
" }, "DnsIps": { "shape": "DnsIps", "documentation": "A list of up to three DNS server or domain controller IP addresses in your self-managed AD domain.
" }, "DomainName": { "shape": "ActiveDirectoryFullyQualifiedName", "documentation": "Specifies an updated fully qualified domain name of your self-managed AD configuration.
" }, "OrganizationalUnitDistinguishedName": { "shape": "OrganizationalUnitDistinguishedName", "documentation": "Specifies an updated fully qualified distinguished name of the organization unit within your self-managed AD.
" }, "FileSystemAdministratorsGroup": { "shape": "FileSystemAdministratorsGroupName", "documentation": "Specifies the updated name of the self-managed AD domain group whose members are granted administrative privileges for the Amazon FSx resource.
" } }, "documentation": "Specifies changes you are making to the self-managed Microsoft Active Directory (AD) configuration to which an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined.
" }, "SnaplockConfiguration": { "type": "structure", "members": { "AuditLogVolume": { "shape": "Flag", "documentation": "Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.
For more information, see SnapLock audit log volumes.
" }, "AutocommitPeriod": { "shape": "AutocommitPeriod", "documentation": "The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
" }, "PrivilegedDelete": { "shape": "PrivilegedDelete", "documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.
For more information, see Privileged delete.
" }, "RetentionPeriod": { "shape": "SnaplockRetentionPeriod", "documentation": "Specifies the retention period of an FSx for ONTAP SnapLock volume.
" }, "SnaplockType": { "shape": "SnaplockType", "documentation": "Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:
COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.
ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.
For more information, see Volume-append mode.
" } }, "documentation": "Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.
" }, "SnaplockRetentionPeriod": { "type": "structure", "required": [ "DefaultRetention", "MinimumRetention", "MaximumRetention" ], "members": { "DefaultRetention": { "shape": "RetentionPeriod", "documentation": "The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.
" }, "MinimumRetention": { "shape": "RetentionPeriod", "documentation": "The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
" }, "MaximumRetention": { "shape": "RetentionPeriod", "documentation": "The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
" } }, "documentation": "The configuration to set the retention period of an FSx for ONTAP SnapLock volume. The retention period includes default, maximum, and minimum settings. For more information, see Working with the retention period in SnapLock.
" }, "SnaplockType": { "type": "string", "enum": [ "COMPLIANCE", "ENTERPRISE" ] }, "Snapshot": { "type": "structure", "members": { "ResourceARN": { "shape": "ResourceARN" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot.
" }, "Name": { "shape": "SnapshotName", "documentation": "The name of the snapshot.
" }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume that the snapshot is of.
" }, "CreationTime": { "shape": "CreationTime" }, "Lifecycle": { "shape": "SnapshotLifecycle", "documentation": "The lifecycle status of the snapshot.
PENDING - Amazon FSx hasn't started creating the snapshot.
CREATING - Amazon FSx is creating the snapshot.
DELETING - Amazon FSx is deleting the snapshot.
AVAILABLE - The snapshot is fully available.
A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
" } }, "documentation": "A snapshot of an Amazon FSx for OpenZFS volume.
" }, "SnapshotFilter": { "type": "structure", "members": { "Name": { "shape": "SnapshotFilterName", "documentation": "The name of the filter to use. You can filter by the file-system-id or by volume-id.
The file-system-id or volume-id that you are filtering for.
A filter used to restrict the results of DescribeSnapshots calls. You can use multiple filters to return results that meet all applied filter requirements.
Specifies the file system's storage capacity, in gibibytes (GiB).
", "max": 2147483647, "min": 0 }, "StorageType": { "type": "string", "documentation": "Specifies the file system's storage type.
", "enum": [ "SSD", "HDD" ] }, "StorageVirtualMachine": { "type": "structure", "members": { "ActiveDirectoryConfiguration": { "shape": "SvmActiveDirectoryConfiguration", "documentation": "Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
" }, "CreationTime": { "shape": "CreationTime" }, "Endpoints": { "shape": "SvmEndpoints", "documentation": "The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.
Describes the SVM's lifecycle status.
CREATED - The SVM is fully available for use.
CREATING - Amazon FSx is creating the new SVM.
DELETING - Amazon FSx is deleting an existing SVM.
FAILED - Amazon FSx was unable to create the SVM.
MISCONFIGURED - The SVM is in a failed but recoverable state.
PENDING - Amazon FSx has not started creating the SVM.
The name of the SVM, if provisioned.
" }, "ResourceARN": { "shape": "ResourceARN" }, "StorageVirtualMachineId": { "shape": "StorageVirtualMachineId", "documentation": "The SVM's system generated unique ID.
" }, "Subtype": { "shape": "StorageVirtualMachineSubtype", "documentation": "Describes the SVM's subtype.
" }, "UUID": { "shape": "UUID", "documentation": "The SVM's UUID (universally unique identifier).
" }, "Tags": { "shape": "Tags" }, "LifecycleTransitionReason": { "shape": "LifecycleTransitionReason", "documentation": "Describes why the SVM lifecycle state changed.
" }, "RootVolumeSecurityStyle": { "shape": "StorageVirtualMachineRootVolumeSecurityStyle", "documentation": "The security style of the root volume of the SVM.
" } }, "documentation": "Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.
" }, "StorageVirtualMachineFilter": { "type": "structure", "members": { "Name": { "shape": "StorageVirtualMachineFilterName", "documentation": "The name for this filter.
" }, "Values": { "shape": "StorageVirtualMachineFilterValues", "documentation": "The values of the filter. These are all the values for any of the applied filters.
" } }, "documentation": "A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). You can use multiple filters to return results that meet all applied filter requirements.
" }, "StorageVirtualMachineFilterName": { "type": "string", "enum": [ "file-system-id" ] }, "StorageVirtualMachineFilterValue": { "type": "string", "max": 128, "min": 1, "pattern": "^[0-9a-zA-Z\\*\\.\\\\/\\?\\-\\_]*$" }, "StorageVirtualMachineFilterValues": { "type": "list", "member": { "shape": "StorageVirtualMachineFilterValue" }, "max": 20 }, "StorageVirtualMachineFilters": { "type": "list", "member": { "shape": "StorageVirtualMachineFilter" }, "max": 1 }, "StorageVirtualMachineId": { "type": "string", "max": 21, "min": 21, "pattern": "^(svm-[0-9a-f]{17,})$" }, "StorageVirtualMachineIds": { "type": "list", "member": { "shape": "StorageVirtualMachineId" }, "max": 50 }, "StorageVirtualMachineLifecycle": { "type": "string", "enum": [ "CREATED", "CREATING", "DELETING", "FAILED", "MISCONFIGURED", "PENDING" ] }, "StorageVirtualMachineName": { "type": "string", "max": 47, "min": 1, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,47}$" }, "StorageVirtualMachineRootVolumeSecurityStyle": { "type": "string", "enum": [ "UNIX", "NTFS", "MIXED" ] }, "StorageVirtualMachineSubtype": { "type": "string", "enum": [ "DEFAULT", "DP_DESTINATION", "SYNC_DESTINATION", "SYNC_SOURCE" ] }, "StorageVirtualMachines": { "type": "list", "member": { "shape": "StorageVirtualMachine" }, "max": 50 }, "SubDirectoriesPaths": { "type": "list", "member": { "shape": "Namespace" }, "max": 500 }, "SubnetId": { "type": "string", "documentation": "The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.
", "max": 24, "min": 15, "pattern": "^(subnet-[0-9a-f]{8,})$" }, "SubnetIds": { "type": "list", "member": { "shape": "SubnetId" }, "documentation": "A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache operation.
The NetBIOS name of the AD computer object to which the SVM is joined.
" }, "SelfManagedActiveDirectoryConfiguration": { "shape": "SelfManagedActiveDirectoryAttributes" } }, "documentation": "Describes the Microsoft Active Directory (AD) directory configuration to which the FSx for ONTAP storage virtual machine (SVM) is joined. Note that account credentials are not returned in the response payload.
" }, "SvmEndpoint": { "type": "structure", "members": { "DNSName": { "shape": "DNSName" }, "IpAddresses": { "shape": "OntapEndpointIpAddresses", "documentation": "The SVM endpoint's IP addresses.
" } }, "documentation": "An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.
An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
" }, "Management": { "shape": "SvmEndpoint", "documentation": "An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
" }, "Nfs": { "shape": "SvmEndpoint", "documentation": "An endpoint for connecting using the Network File System (NFS) protocol.
" }, "Smb": { "shape": "SvmEndpoint", "documentation": "An endpoint for connecting using the Server Message Block (SMB) protocol.
" } }, "documentation": "An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the following endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.
" }, "Tag": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "TagKey", "documentation": "A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.
A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.
Specifies a key-value pair for a resource tag.
" }, "TagKey": { "type": "string", "documentation": "A string of 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the resource to which they are attached.
", "max": 128, "min": 1, "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys": { "type": "list", "member": { "shape": "TagKey" }, "documentation": "A list of TagKey values, with a maximum of 50 elements.
The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.
" }, "Tags": { "shape": "Tags", "documentation": "A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter.
" } }, "documentation": "The request object for the TagResource operation.
The response object for the TagResource operation.
A string of 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.
", "max": 256, "min": 0, "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags": { "type": "list", "member": { "shape": "Tag" }, "documentation": "A list of Tag values, with a maximum of 50 elements.
Specifies the number of days that user data in a volume must remain inactive before it is considered \"cold\" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.
Valid tiering policies are the following:
SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.
AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
The ARN of the Amazon FSx resource to untag.
" }, "TagKeys": { "shape": "TagKeys", "documentation": "A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent.
" } }, "documentation": "The request object for UntagResource action.
The response object for UntagResource action.
The ID of the data repository association that you are updating.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "ImportedFileChunkSize": { "shape": "Megabytes", "documentation": "For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
" }, "S3": { "shape": "S3DataRepositoryConfiguration", "documentation": "The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
" } } }, "UpdateDataRepositoryAssociationResponse": { "type": "structure", "members": { "Association": { "shape": "DataRepositoryAssociation", "documentation": "The response object returned after the data repository association is updated.
" } } }, "UpdateFileCacheLustreConfiguration": { "type": "structure", "members": { "WeeklyMaintenanceStartTime": { "shape": "WeeklyTime" } }, "documentation": "The configuration update for an Amazon File Cache resource.
" }, "UpdateFileCacheRequest": { "type": "structure", "required": [ "FileCacheId" ], "members": { "FileCacheId": { "shape": "FileCacheId", "documentation": "The ID of the cache that you are updating.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "LustreConfiguration": { "shape": "UpdateFileCacheLustreConfiguration", "documentation": "The configuration updates for an Amazon File Cache resource.
" } } }, "UpdateFileCacheResponse": { "type": "structure", "members": { "FileCache": { "shape": "FileCache", "documentation": "A description of the cache that was updated.
" } } }, "UpdateFileSystemLustreConfiguration": { "type": "structure", "members": { "WeeklyMaintenanceStartTime": { "shape": "WeeklyTime", "documentation": "(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" }, "DailyAutomaticBackupStartTime": { "shape": "DailyTime" }, "AutomaticBackupRetentionDays": { "shape": "AutomaticBackupRetentionDays", "documentation": "The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.
This parameter is not supported for file systems with a data repository association.
" }, "DataCompressionType": { "shape": "DataCompressionType", "documentation": "Sets the data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
If you don't use DataCompressionType, the file system retains its current data compression configuration.
For more information, see Lustre data compression.
" }, "LogConfiguration": { "shape": "LustreLogCreateConfiguration", "documentation": "The Lustre logging configuration used when updating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.
" }, "RootSquashConfiguration": { "shape": "LustreRootSquashConfiguration", "documentation": "The Lustre root squash configuration used when updating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.
" }, "PerUnitStorageThroughput": { "shape": "PerUnitStorageThroughput", "documentation": "The throughput of an Amazon FSx for Lustre Persistent SSD-based file system, measured in megabytes per second per tebibyte (MB/s/TiB). You can increase or decrease your file system's throughput. Valid values depend on the deployment type of the file system, as follows:
For PERSISTENT_1 SSD-based deployment types, valid values are 50, 100, and 200 MB/s/TiB.
For PERSISTENT_2 SSD-based deployment types, valid values are 125, 250, 500, and 1000 MB/s/TiB.
For more information, see Managing throughput capacity.
" } }, "documentation": "The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.
Update the password for the fsxadmin user by entering a new password. You use the fsxadmin user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see Managing resources using NetApp Applicaton.
The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more information, see Updating SSD storage capacity and IOPS.
Enter a new value to change the amount of throughput capacity for the file system in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity.
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.
" }, "RemoveRouteTableIds": { "shape": "RouteTableIds", "documentation": "(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
" }, "ThroughputCapacityPerHAPair": { "shape": "ThroughputCapacityPerHAPair", "documentation": "Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
" }, "UpdateFileSystemOpenZFSConfiguration": { "type": "structure", "members": { "AutomaticBackupRetentionDays": { "shape": "AutomaticBackupRetentionDays" }, "CopyTagsToBackups": { "shape": "Flag", "documentation": "A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for OpenZFS file system.
" }, "RemoveRouteTableIds": { "shape": "RouteTableIds", "documentation": "(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
" } }, "documentation": "The configuration updates for an Amazon FSx for OpenZFS file system.
" }, "UpdateFileSystemRequest": { "type": "structure", "required": [ "FileSystemId" ], "members": { "FileSystemId": { "shape": "FileSystemId", "documentation": "The ID of the file system that you are updating.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "documentation": "A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken": true }, "StorageCapacity": { "shape": "StorageCapacity", "documentation": "Use this parameter to increase the storage capacity of an FSx for Windows File Server, FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.
You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.
For Lustre file systems, the storage capacity target value can be the following:
For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.
For SCRATCH_1 file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput capacity in the FSx for Lustre User Guide.
For FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity in the FSx for OpenZFS User Guide.
For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSxfor Windows File Server User Guide.
For ONTAP file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.
" }, "WindowsConfiguration": { "shape": "UpdateFileSystemWindowsConfiguration", "documentation": "The configuration updates for an Amazon FSx for Windows File Server file system.
" }, "LustreConfiguration": { "shape": "UpdateFileSystemLustreConfiguration" }, "OntapConfiguration": { "shape": "UpdateFileSystemOntapConfiguration" }, "OpenZFSConfiguration": { "shape": "UpdateFileSystemOpenZFSConfiguration", "documentation": "The configuration updates for an FSx for OpenZFS file system.
" }, "StorageType": { "shape": "StorageType" } }, "documentation": "The request object for the UpdateFileSystem operation.
A description of the file system that was updated.
" } }, "documentation": "The response object for the UpdateFileSystem operation.
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday and 7 = Sunday.
" }, "DailyAutomaticBackupStartTime": { "shape": "DailyTime", "documentation": "The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00
The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30. For more information, see Working with Automatic Daily Backups.
Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, see Managing Throughput Capacity.
" }, "SelfManagedActiveDirectoryConfiguration": { "shape": "SelfManagedActiveDirectoryConfigurationUpdates", "documentation": "The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.
" }, "AuditLogConfiguration": { "shape": "WindowsAuditLogCreateConfiguration", "documentation": "The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system..
" }, "DiskIopsConfiguration": { "shape": "DiskIopsConfiguration", "documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" } }, "documentation": "Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.
" }, "UpdateOntapVolumeConfiguration": { "type": "structure", "members": { "JunctionPath": { "shape": "JunctionPath", "documentation": "Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
The security style for the volume, which can be UNIX, NTFS, or MIXED.
Specifies the size of the volume in megabytes.
" }, "StorageEfficiencyEnabled": { "shape": "Flag", "documentation": "Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
Update the volume's data tiering policy.
" }, "SnapshotPolicy": { "shape": "SnapshotPolicy", "documentation": "Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
" }, "CopyTagsToBackups": { "shape": "Flag", "documentation": "A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
" }, "SnaplockConfiguration": { "shape": "UpdateSnaplockConfiguration", "documentation": "The configuration object for updating the SnapLock configuration of an FSx for ONTAP SnapLock volume.
" }, "SizeInBytes": { "shape": "VolumeCapacityBytes", "documentation": "The configured size of the volume, in bytes.
" } }, "documentation": "Used to specify changes to the ONTAP configuration for the volume you are updating.
" }, "UpdateOpenZFSVolumeConfiguration": { "type": "structure", "members": { "StorageCapacityReservationGiB": { "shape": "IntegerNoMaxFromNegativeOne", "documentation": "The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of -1 to unset a volume's storage capacity reservation.
The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.
Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
" }, "DataCompressionType": { "shape": "OpenZFSDataCompressionType", "documentation": "Specifies the method used to compress the data on the volume. The compression type is NONE by default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
The configuration object for mounting a Network File System (NFS) file system.
" }, "UserAndGroupQuotas": { "shape": "OpenZFSUserAndGroupQuotas", "documentation": "An object specifying how much storage users or groups can use on the volume.
" }, "ReadOnly": { "shape": "ReadOnly", "documentation": "A Boolean value indicating whether the volume is read-only.
" } }, "documentation": "Used to specify changes to the OpenZFS configuration for the volume that you are updating.
" }, "UpdateOpenZFSVolumeOption": { "type": "string", "enum": [ "DELETE_INTERMEDIATE_SNAPSHOTS", "DELETE_CLONED_VOLUMES", "DELETE_INTERMEDIATE_DATA" ] }, "UpdateOpenZFSVolumeOptions": { "type": "list", "member": { "shape": "UpdateOpenZFSVolumeOption" } }, "UpdateSharedVpcConfigurationRequest": { "type": "structure", "members": { "EnableFsxRouteTableUpdatesFromParticipantAccounts": { "shape": "VerboseFlag", "documentation": "Specifies whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets. Set to true to enable or false to disable.
Indicates whether participant accounts can create FSx for ONTAP Multi-AZ file systems in shared subnets.
" } } }, "UpdateSnaplockConfiguration": { "type": "structure", "members": { "AuditLogVolume": { "shape": "Flag", "documentation": "Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.
For more information, see SnapLock audit log volumes.
" }, "AutocommitPeriod": { "shape": "AutocommitPeriod", "documentation": "The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
" }, "PrivilegedDelete": { "shape": "PrivilegedDelete", "documentation": "Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.
For more information, see Privileged delete.
" }, "RetentionPeriod": { "shape": "SnaplockRetentionPeriod", "documentation": "Specifies the retention period of an FSx for ONTAP SnapLock volume.
" }, "VolumeAppendModeEnabled": { "shape": "Flag", "documentation": "Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.
For more information, see Volume-append mode.
" } }, "documentation": "Updates the SnapLock configuration for an existing FSx for ONTAP volume.
" }, "UpdateSnapshotRequest": { "type": "structure", "required": [ "Name", "SnapshotId" ], "members": { "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "Name": { "shape": "SnapshotName", "documentation": "The name of the snapshot to update.
" }, "SnapshotId": { "shape": "SnapshotId", "documentation": "The ID of the snapshot that you want to update, in the format fsvolsnap-0123456789abcdef0.
Returned after a successful UpdateSnapshot operation, describing the snapshot that you updated.
Specifies updates to an SVM's Microsoft Active Directory (AD) configuration.
" }, "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "StorageVirtualMachineId": { "shape": "StorageVirtualMachineId", "documentation": "The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.
Specifies a new SvmAdminPassword.
" } } }, "UpdateStorageVirtualMachineResponse": { "type": "structure", "members": { "StorageVirtualMachine": { "shape": "StorageVirtualMachine" } } }, "UpdateSvmActiveDirectoryConfiguration": { "type": "structure", "members": { "SelfManagedActiveDirectoryConfiguration": { "shape": "SelfManagedActiveDirectoryConfigurationUpdates" }, "NetBiosName": { "shape": "NetBiosAlias", "documentation": "Specifies an updated NetBIOS name of the AD computer object NetBiosName to which an SVM is joined.
Specifies updates to an FSx for ONTAP storage virtual machine's (SVM) Microsoft Active Directory (AD) configuration. Note that account credentials are not returned in the response payload.
" }, "UpdateVolumeRequest": { "type": "structure", "required": [ "VolumeId" ], "members": { "ClientRequestToken": { "shape": "ClientRequestToken", "idempotencyToken": true }, "VolumeId": { "shape": "VolumeId", "documentation": "The ID of the volume that you want to update, in the format fsvol-0123456789abcdef0.
The configuration of the ONTAP volume that you are updating.
" }, "Name": { "shape": "VolumeName", "documentation": "The name of the OpenZFS volume. OpenZFS root volumes are automatically named FSX. Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume.
The configuration of the OpenZFS volume that you are updating.
" } } }, "UpdateVolumeResponse": { "type": "structure", "members": { "Volume": { "shape": "Volume", "documentation": "A description of the volume just updated. Returned after a successful UpdateVolume API operation.
The lifecycle status of the volume.
AVAILABLE - The volume is fully available for use.
CREATED - The volume has been created.
CREATING - Amazon FSx is creating the new volume.
DELETING - Amazon FSx is deleting an existing volume.
FAILED - Amazon FSx was unable to create the volume.
MISCONFIGURED - The volume is in a failed but recoverable state.
PENDING - Amazon FSx hasn't started creating the volume.
The name of the volume.
" }, "OntapConfiguration": { "shape": "OntapVolumeConfiguration" }, "ResourceARN": { "shape": "ResourceARN" }, "Tags": { "shape": "Tags" }, "VolumeId": { "shape": "VolumeId", "documentation": "The system-generated, unique ID of the volume.
" }, "VolumeType": { "shape": "VolumeType", "documentation": "The type of the volume.
" }, "LifecycleTransitionReason": { "shape": "LifecycleTransitionReason", "documentation": "The reason why the volume lifecycle status changed.
" }, "AdministrativeActions": { "shape": "AdministrativeActions", "documentation": "A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.
The configuration of an Amazon FSx for OpenZFS volume.
" } }, "documentation": "Describes an Amazon FSx volume.
" }, "VolumeCapacity": { "type": "integer", "max": 2147483647, "min": 0 }, "VolumeCapacityBytes": { "type": "long", "max": 22517998000000000, "min": 0 }, "VolumeFilter": { "type": "structure", "members": { "Name": { "shape": "VolumeFilterName", "documentation": "The name for this filter.
" }, "Values": { "shape": "VolumeFilterValues", "documentation": "The values of the filter. These are all the values for any of the applied filters.
" } }, "documentation": "A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use multiple filters to return results that meet all applied filter requirements.
" }, "VolumeFilterName": { "type": "string", "enum": [ "file-system-id", "storage-virtual-machine-id" ] }, "VolumeFilterValue": { "type": "string", "max": 128, "min": 1, "pattern": "^[0-9a-zA-Z\\*\\.\\\\/\\?\\-\\_]*$" }, "VolumeFilterValues": { "type": "list", "member": { "shape": "VolumeFilterValue" }, "max": 20 }, "VolumeFilters": { "type": "list", "member": { "shape": "VolumeFilter" }, "max": 2 }, "VolumeId": { "type": "string", "max": 23, "min": 23, "pattern": "^(fsvol-[0-9a-f]{17,})$" }, "VolumeIds": { "type": "list", "member": { "shape": "VolumeId" }, "max": 50 }, "VolumeLifecycle": { "type": "string", "enum": [ "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING", "AVAILABLE" ] }, "VolumeName": { "type": "string", "max": 203, "min": 1, "pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,203}$" }, "VolumePath": { "type": "string", "max": 2048, "min": 1, "pattern": "^[A-za-z0-9\\_\\.\\:\\-\\/]*$" }, "VolumeStyle": { "type": "string", "enum": [ "FLEXVOL", "FLEXGROUP" ] }, "VolumeType": { "type": "string", "enum": [ "ONTAP", "OPENZFS" ] }, "Volumes": { "type": "list", "member": { "shape": "Volume" }, "max": 50 }, "VpcId": { "type": "string", "documentation": "The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.
", "max": 21, "min": 12, "pattern": "^(vpc-[0-9a-f]{8,})$" }, "WeeklyTime": { "type": "string", "documentation": "A recurring weekly time, in the format D:HH:MM.
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
" } }, "documentation": "The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. For more information, see File access auditing.
" }, "WindowsAuditLogCreateConfiguration": { "type": "structure", "required": [ "FileAccessAuditLogLevel", "FileShareAccessAuditLogLevel" ], "members": { "FileAccessAuditLogLevel": { "shape": "WindowsAccessAuditLogLevel", "documentation": "Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements:
The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.
If you do not provide a destination in AuditLogDestination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
If AuditLogDestination is provided and the resource does not exist, the request will fail with a BadRequest error.
If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to DISABLED, you cannot specify a destination in AuditLogDestination.
The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.
" }, "WindowsDeploymentType": { "type": "string", "enum": [ "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2" ] }, "WindowsFileSystemConfiguration": { "type": "structure", "members": { "ActiveDirectoryId": { "shape": "DirectoryId", "documentation": "The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
" }, "SelfManagedActiveDirectoryConfiguration": { "shape": "SelfManagedActiveDirectoryAttributes" }, "DeploymentType": { "shape": "WindowsDeploymentType", "documentation": "Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems.
" }, "RemoteAdministrationEndpoint": { "shape": "DNSName", "documentation": "For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
" }, "PreferredSubnetId": { "shape": "SubnetId", "documentation": "For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.
" }, "ThroughputCapacity": { "shape": "MegabytesPerSecond", "documentation": "The throughput of the Amazon FSx file system, measured in megabytes per second.
" }, "MaintenanceOperationsInProgress": { "shape": "FileSystemMaintenanceOperations", "documentation": "The list of maintenance operations in progress for this file system.
" }, "WeeklyMaintenanceStartTime": { "shape": "WeeklyTime", "documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" }, "DailyAutomaticBackupStartTime": { "shape": "DailyTime", "documentation": "The preferred time to take daily automatic backups, in the UTC time zone.
" }, "AutomaticBackupRetentionDays": { "shape": "AutomaticBackupRetentionDays", "documentation": "The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
" }, "CopyTagsToBackups": { "shape": "Flag", "documentation": "A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
" }, "Aliases": { "shape": "Aliases" }, "AuditLogConfiguration": { "shape": "WindowsAuditLogConfiguration", "documentation": "The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
" }, "DiskIopsConfiguration": { "shape": "DiskIopsConfiguration", "documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
" } }, "documentation": "The configuration for this Microsoft Windows file system.
" } }, "documentation": "Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
" }