fsx.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class FSx extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: FSx.Types.ClientConfiguration) 13 config: Config & FSx.Types.ClientConfiguration; 14 /** 15 * 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 systen 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. 16 */ 17 associateFileSystemAliases(params: FSx.Types.AssociateFileSystemAliasesRequest, callback?: (err: AWSError, data: FSx.Types.AssociateFileSystemAliasesResponse) => void): Request<FSx.Types.AssociateFileSystemAliasesResponse, AWSError>; 18 /** 19 * 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 systen 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. 20 */ 21 associateFileSystemAliases(callback?: (err: AWSError, data: FSx.Types.AssociateFileSystemAliasesResponse) => void): Request<FSx.Types.AssociateFileSystemAliasesResponse, AWSError>; 22 /** 23 * Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a 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. 24 */ 25 cancelDataRepositoryTask(params: FSx.Types.CancelDataRepositoryTaskRequest, callback?: (err: AWSError, data: FSx.Types.CancelDataRepositoryTaskResponse) => void): Request<FSx.Types.CancelDataRepositoryTaskResponse, AWSError>; 26 /** 27 * Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a 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. 28 */ 29 cancelDataRepositoryTask(callback?: (err: AWSError, data: FSx.Types.CancelDataRepositoryTaskResponse) => void): Request<FSx.Types.CancelDataRepositoryTaskResponse, AWSError>; 30 /** 31 * Copies an existing backup within the same AWS account to another Region (cross-Region copy) or within the same 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 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 AWS partition. You can also use backup copies to clone your file data set to another Region or within the same Region. You can use the SourceRegion parameter to specify the AWS 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 on creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide and Copying backups in the Amazon FSx for Lustre User Guide. 32 */ 33 copyBackup(params: FSx.Types.CopyBackupRequest, callback?: (err: AWSError, data: FSx.Types.CopyBackupResponse) => void): Request<FSx.Types.CopyBackupResponse, AWSError>; 34 /** 35 * Copies an existing backup within the same AWS account to another Region (cross-Region copy) or within the same 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 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 AWS partition. You can also use backup copies to clone your file data set to another Region or within the same Region. You can use the SourceRegion parameter to specify the AWS 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 on creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide and Copying backups in the Amazon FSx for Lustre User Guide. 36 */ 37 copyBackup(callback?: (err: AWSError, data: FSx.Types.CopyBackupResponse) => void): Request<FSx.Types.CopyBackupResponse, AWSError>; 38 /** 39 * Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system. For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration: a Persistent deployment type is not linked to a data respository. For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups. For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows 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 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. 40 */ 41 createBackup(params: FSx.Types.CreateBackupRequest, callback?: (err: AWSError, data: FSx.Types.CreateBackupResponse) => void): Request<FSx.Types.CreateBackupResponse, AWSError>; 42 /** 43 * Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system. For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration: a Persistent deployment type is not linked to a data respository. For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups. For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows 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 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. 44 */ 45 createBackup(callback?: (err: AWSError, data: FSx.Types.CreateBackupResponse) => void): Request<FSx.Types.CreateBackupResponse, AWSError>; 46 /** 47 * Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. 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 its linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx 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. 48 */ 49 createDataRepositoryTask(params: FSx.Types.CreateDataRepositoryTaskRequest, callback?: (err: AWSError, data: FSx.Types.CreateDataRepositoryTaskResponse) => void): Request<FSx.Types.CreateDataRepositoryTaskResponse, AWSError>; 50 /** 51 * Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. 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 its linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx 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. 52 */ 53 createDataRepositoryTask(callback?: (err: AWSError, data: FSx.Types.CreateDataRepositoryTaskResponse) => void): Request<FSx.Types.CreateDataRepositoryTaskResponse, AWSError>; 54 /** 55 * Creates a new, empty Amazon FSx file system. 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 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. 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. 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. 56 */ 57 createFileSystem(params: FSx.Types.CreateFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.CreateFileSystemResponse) => void): Request<FSx.Types.CreateFileSystemResponse, AWSError>; 58 /** 59 * Creates a new, empty Amazon FSx file system. 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 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. 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. 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. 60 */ 61 createFileSystem(callback?: (err: AWSError, data: FSx.Types.CreateFileSystemResponse) => void): Request<FSx.Types.CreateFileSystemResponse, AWSError>; 62 /** 63 * Creates a new Amazon FSx 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 client request token specified by the file system exists and 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 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 success 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. 64 */ 65 createFileSystemFromBackup(params: FSx.Types.CreateFileSystemFromBackupRequest, callback?: (err: AWSError, data: FSx.Types.CreateFileSystemFromBackupResponse) => void): Request<FSx.Types.CreateFileSystemFromBackupResponse, AWSError>; 66 /** 67 * Creates a new Amazon FSx 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 client request token specified by the file system exists and 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 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 success 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. 68 */ 69 createFileSystemFromBackup(callback?: (err: AWSError, data: FSx.Types.CreateFileSystemFromBackupResponse) => void): Request<FSx.Types.CreateFileSystemFromBackupResponse, AWSError>; 70 /** 71 * Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone. The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls. The data in a deleted backup is also deleted and can't be recovered by any means. 72 */ 73 deleteBackup(params: FSx.Types.DeleteBackupRequest, callback?: (err: AWSError, data: FSx.Types.DeleteBackupResponse) => void): Request<FSx.Types.DeleteBackupResponse, AWSError>; 74 /** 75 * Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone. The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls. The data in a deleted backup is also deleted and can't be recovered by any means. 76 */ 77 deleteBackup(callback?: (err: AWSError, data: FSx.Types.DeleteBackupResponse) => void): Request<FSx.Types.DeleteBackupResponse, AWSError>; 78 /** 79 * Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted. The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error. Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state. The data in a deleted file system is also deleted and can't be recovered by any means. 80 */ 81 deleteFileSystem(params: FSx.Types.DeleteFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.DeleteFileSystemResponse) => void): Request<FSx.Types.DeleteFileSystemResponse, AWSError>; 82 /** 83 * Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted. The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error. Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state. The data in a deleted file system is also deleted and can't be recovered by any means. 84 */ 85 deleteFileSystem(callback?: (err: AWSError, data: FSx.Types.DeleteFileSystemResponse) => void): Request<FSx.Types.DeleteFileSystemResponse, AWSError>; 86 /** 87 * Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS 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 NextToken from the last response. This action is used in an iterative process to retrieve a list of your backups. DescribeBackups 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 backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified. 88 */ 89 describeBackups(params: FSx.Types.DescribeBackupsRequest, callback?: (err: AWSError, data: FSx.Types.DescribeBackupsResponse) => void): Request<FSx.Types.DescribeBackupsResponse, AWSError>; 90 /** 91 * Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS 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 NextToken from the last response. This action is used in an iterative process to retrieve a list of your backups. DescribeBackups 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 backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified. 92 */ 93 describeBackups(callback?: (err: AWSError, data: FSx.Types.DescribeBackupsResponse) => void): Request<FSx.Types.DescribeBackupsResponse, AWSError>; 94 /** 95 * Returns the description of specific Amazon FSx for Lustre 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 tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS 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, 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. 96 */ 97 describeDataRepositoryTasks(params: FSx.Types.DescribeDataRepositoryTasksRequest, callback?: (err: AWSError, data: FSx.Types.DescribeDataRepositoryTasksResponse) => void): Request<FSx.Types.DescribeDataRepositoryTasksResponse, AWSError>; 98 /** 99 * Returns the description of specific Amazon FSx for Lustre 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 tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS 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, 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. 100 */ 101 describeDataRepositoryTasks(callback?: (err: AWSError, data: FSx.Types.DescribeDataRepositoryTasksResponse) => void): Request<FSx.Types.DescribeDataRepositoryTasksResponse, AWSError>; 102 /** 103 * 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. 104 */ 105 describeFileSystemAliases(params: FSx.Types.DescribeFileSystemAliasesRequest, callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemAliasesResponse) => void): Request<FSx.Types.DescribeFileSystemAliasesResponse, AWSError>; 106 /** 107 * 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. 108 */ 109 describeFileSystemAliases(callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemAliasesResponse) => void): Request<FSx.Types.DescribeFileSystemAliasesResponse, AWSError>; 110 /** 111 * 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 AWS account in the AWS 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 action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems 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 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. 112 */ 113 describeFileSystems(params: FSx.Types.DescribeFileSystemsRequest, callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemsResponse) => void): Request<FSx.Types.DescribeFileSystemsResponse, AWSError>; 114 /** 115 * 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 AWS account in the AWS 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 action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems 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 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. 116 */ 117 describeFileSystems(callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemsResponse) => void): Request<FSx.Types.DescribeFileSystemsResponse, AWSError>; 118 /** 119 * 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 a 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. 120 */ 121 disassociateFileSystemAliases(params: FSx.Types.DisassociateFileSystemAliasesRequest, callback?: (err: AWSError, data: FSx.Types.DisassociateFileSystemAliasesResponse) => void): Request<FSx.Types.DisassociateFileSystemAliasesResponse, AWSError>; 122 /** 123 * 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 a 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. 124 */ 125 disassociateFileSystemAliases(callback?: (err: AWSError, data: FSx.Types.DisassociateFileSystemAliasesResponse) => void): Request<FSx.Types.DisassociateFileSystemAliasesResponse, AWSError>; 126 /** 127 * Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server. 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. 128 */ 129 listTagsForResource(params: FSx.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: FSx.Types.ListTagsForResourceResponse) => void): Request<FSx.Types.ListTagsForResourceResponse, AWSError>; 130 /** 131 * Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server. 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. 132 */ 133 listTagsForResource(callback?: (err: AWSError, data: FSx.Types.ListTagsForResourceResponse) => void): Request<FSx.Types.ListTagsForResourceResponse, AWSError>; 134 /** 135 * Tags an Amazon FSx resource. 136 */ 137 tagResource(params: FSx.Types.TagResourceRequest, callback?: (err: AWSError, data: FSx.Types.TagResourceResponse) => void): Request<FSx.Types.TagResourceResponse, AWSError>; 138 /** 139 * Tags an Amazon FSx resource. 140 */ 141 tagResource(callback?: (err: AWSError, data: FSx.Types.TagResourceResponse) => void): Request<FSx.Types.TagResourceResponse, AWSError>; 142 /** 143 * This action removes a tag from an Amazon FSx resource. 144 */ 145 untagResource(params: FSx.Types.UntagResourceRequest, callback?: (err: AWSError, data: FSx.Types.UntagResourceResponse) => void): Request<FSx.Types.UntagResourceResponse, AWSError>; 146 /** 147 * This action removes a tag from an Amazon FSx resource. 148 */ 149 untagResource(callback?: (err: AWSError, data: FSx.Types.UntagResourceResponse) => void): Request<FSx.Types.UntagResourceResponse, AWSError>; 150 /** 151 * Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For Amazon FSx for Windows File Server file systems, you can update the following properties: AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For Amazon FSx for Lustre file systems, you can update the following properties: AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType StorageCapacity WeeklyMaintenanceStartTime 152 */ 153 updateFileSystem(params: FSx.Types.UpdateFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.UpdateFileSystemResponse) => void): Request<FSx.Types.UpdateFileSystemResponse, AWSError>; 154 /** 155 * Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For Amazon FSx for Windows File Server file systems, you can update the following properties: AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime SelfManagedActiveDirectoryConfiguration StorageCapacity ThroughputCapacity WeeklyMaintenanceStartTime For Amazon FSx for Lustre file systems, you can update the following properties: AutoImportPolicy AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DataCompressionType StorageCapacity WeeklyMaintenanceStartTime 156 */ 157 updateFileSystem(callback?: (err: AWSError, data: FSx.Types.UpdateFileSystemResponse) => void): Request<FSx.Types.UpdateFileSystemResponse, AWSError>; 158 } 159 declare namespace FSx { 160 export type AWSAccountId = string; 161 export interface ActiveDirectoryBackupAttributes { 162 /** 163 * The fully qualified domain name of the self-managed AD directory. 164 */ 165 DomainName?: ActiveDirectoryFullyQualifiedName; 166 /** 167 * The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined. 168 */ 169 ActiveDirectoryId?: DirectoryId; 170 ResourceARN?: ResourceARN; 171 } 172 export type ActiveDirectoryFullyQualifiedName = string; 173 export interface AdministrativeAction { 174 AdministrativeActionType?: AdministrativeActionType; 175 /** 176 * Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type. 177 */ 178 ProgressPercent?: ProgressPercent; 179 /** 180 * Time that the administrative action request was received. 181 */ 182 RequestTime?: RequestTime; 183 /** 184 * Describes 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. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide. 185 */ 186 Status?: Status; 187 /** 188 * Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions. 189 */ 190 TargetFileSystemValues?: FileSystem; 191 FailureDetails?: AdministrativeActionFailureDetails; 192 } 193 export interface AdministrativeActionFailureDetails { 194 /** 195 * Error message providing details about the failed administrative action. 196 */ 197 Message?: ErrorMessage; 198 } 199 export type AdministrativeActionType = "FILE_SYSTEM_UPDATE"|"STORAGE_OPTIMIZATION"|"FILE_SYSTEM_ALIAS_ASSOCIATION"|"FILE_SYSTEM_ALIAS_DISASSOCIATION"|string; 200 export type AdministrativeActions = AdministrativeAction[]; 201 export interface Alias { 202 /** 203 * 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. 204 */ 205 Name?: AlternateDNSName; 206 /** 207 * 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 disassocate the DNS alias from the file system. 208 */ 209 Lifecycle?: AliasLifecycle; 210 } 211 export type AliasLifecycle = "AVAILABLE"|"CREATING"|"DELETING"|"CREATE_FAILED"|"DELETE_FAILED"|string; 212 export type Aliases = Alias[]; 213 export type AlternateDNSName = string; 214 export type AlternateDNSNames = AlternateDNSName[]; 215 export type ArchivePath = string; 216 export interface AssociateFileSystemAliasesRequest { 217 ClientRequestToken?: ClientRequestToken; 218 /** 219 * Specifies the file system with which you want to associate one or more DNS aliases. 220 */ 221 FileSystemId: FileSystemId; 222 /** 223 * 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. 224 */ 225 Aliases: AlternateDNSNames; 226 } 227 export interface AssociateFileSystemAliasesResponse { 228 /** 229 * An array of the DNS aliases that Amazon FSx is associating with the file system. 230 */ 231 Aliases?: Aliases; 232 } 233 export type AutoImportPolicyType = "NONE"|"NEW"|"NEW_CHANGED"|string; 234 export type AutomaticBackupRetentionDays = number; 235 export interface Backup { 236 /** 237 * The ID of the backup. 238 */ 239 BackupId: BackupId; 240 /** 241 * The lifecycle status of the backup. AVAILABLE - The backup is fully available. PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not 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 S3. COPYING - Amazon FSx is copying the backup. DELETED - Amazon FSx deleted the backup and it is no longer available. FAILED - Amazon FSx could not complete the backup. 242 */ 243 Lifecycle: BackupLifecycle; 244 /** 245 * Details explaining any failures that occur when creating a backup. 246 */ 247 FailureDetails?: BackupFailureDetails; 248 /** 249 * The type of the file system backup. 250 */ 251 Type: BackupType; 252 ProgressPercent?: ProgressPercent; 253 /** 254 * The time when a particular backup was created. 255 */ 256 CreationTime: CreationTime; 257 /** 258 * The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest. 259 */ 260 KmsKeyId?: KmsKeyId; 261 /** 262 * The Amazon Resource Name (ARN) for the backup resource. 263 */ 264 ResourceARN?: ResourceARN; 265 /** 266 * Tags associated with a particular file system. 267 */ 268 Tags?: Tags; 269 /** 270 * Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted. 271 */ 272 FileSystem: FileSystem; 273 /** 274 * The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined. 275 */ 276 DirectoryInformation?: ActiveDirectoryBackupAttributes; 277 OwnerId?: AWSAccountId; 278 SourceBackupId?: BackupId; 279 /** 280 * The source Region of the backup. Specifies the Region from where this backup is copied. 281 */ 282 SourceBackupRegion?: Region; 283 } 284 export interface BackupFailureDetails { 285 /** 286 * A message describing the backup creation failure. 287 */ 288 Message?: ErrorMessage; 289 } 290 export type BackupId = string; 291 export type BackupIds = BackupId[]; 292 export type BackupLifecycle = "AVAILABLE"|"CREATING"|"TRANSFERRING"|"DELETED"|"FAILED"|"PENDING"|"COPYING"|string; 293 export type BackupType = "AUTOMATIC"|"USER_INITIATED"|"AWS_BACKUP"|string; 294 export type Backups = Backup[]; 295 export interface CancelDataRepositoryTaskRequest { 296 /** 297 * Specifies the data repository task to cancel. 298 */ 299 TaskId: TaskId; 300 } 301 export interface CancelDataRepositoryTaskResponse { 302 /** 303 * 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. 304 */ 305 Lifecycle?: DataRepositoryTaskLifecycle; 306 /** 307 * The ID of the task being canceled. 308 */ 309 TaskId?: TaskId; 310 } 311 export type ClientRequestToken = string; 312 export interface CompletionReport { 313 /** 314 * 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. 315 */ 316 Enabled: Flag; 317 /** 318 * 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. To learn more about a file system's ExportPath, see . 319 */ 320 Path?: ArchivePath; 321 /** 322 * 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. 323 */ 324 Format?: ReportFormat; 325 /** 326 * 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. 327 */ 328 Scope?: ReportScope; 329 } 330 export interface CopyBackupRequest { 331 ClientRequestToken?: ClientRequestToken; 332 /** 333 * The ID of the source backup. Specifies the ID of the backup that is being copied. 334 */ 335 SourceBackupId: SourceBackupId; 336 /** 337 * The source AWS Region of the backup. Specifies the AWS Region from which the backup is being copied. The source and destination Regions must be in the same AWS partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy). 338 */ 339 SourceRegion?: Region; 340 KmsKeyId?: KmsKeyId; 341 /** 342 * 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. 343 */ 344 CopyTags?: Flag; 345 Tags?: Tags; 346 } 347 export interface CopyBackupResponse { 348 Backup?: Backup; 349 } 350 export interface CreateBackupRequest { 351 /** 352 * The ID of the file system to back up. 353 */ 354 FileSystemId: FileSystemId; 355 /** 356 * (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. 357 */ 358 ClientRequestToken?: ClientRequestToken; 359 /** 360 * (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 action, no existing file system tags are copied from the file system to the backup. 361 */ 362 Tags?: Tags; 363 } 364 export interface CreateBackupResponse { 365 /** 366 * A description of the backup. 367 */ 368 Backup?: Backup; 369 } 370 export interface CreateDataRepositoryTaskRequest { 371 /** 372 * Specifies the type of data repository task to create. 373 */ 374 Type: DataRepositoryTaskType; 375 /** 376 * (Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. 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. If a path that you provide isn't valid, the task fails. 377 */ 378 Paths?: DataRepositoryTaskPaths; 379 FileSystemId: FileSystemId; 380 /** 381 * 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. 382 */ 383 Report: CompletionReport; 384 ClientRequestToken?: ClientRequestToken; 385 Tags?: Tags; 386 } 387 export interface CreateDataRepositoryTaskResponse { 388 /** 389 * The description of the data repository task that you just created. 390 */ 391 DataRepositoryTask?: DataRepositoryTask; 392 } 393 export interface CreateFileSystemFromBackupRequest { 394 BackupId: BackupId; 395 /** 396 * A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. 397 */ 398 ClientRequestToken?: ClientRequestToken; 399 /** 400 * 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. For Windows SINGLE_AZ_1 and SINGLE_AZ_2 deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone. 401 */ 402 SubnetIds: SubnetIds; 403 /** 404 * 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. 405 */ 406 SecurityGroupIds?: SecurityGroupIds; 407 /** 408 * 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. 409 */ 410 Tags?: Tags; 411 /** 412 * The configuration for this Microsoft Windows file system. 413 */ 414 WindowsConfiguration?: CreateFileSystemWindowsConfiguration; 415 LustreConfiguration?: CreateFileSystemLustreConfiguration; 416 /** 417 * Sets the storage type for the Windows file system you're creating from a backup. Valid values are SSD and HDD. Set to SSD to use solid state drive storage. Supported on all Windows deployment types. Set to HDD to use hard disk drive storage. Supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types. 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 only if the original SSD file system had a storage capacity of at least 2000 GiB. 418 */ 419 StorageType?: StorageType; 420 KmsKeyId?: KmsKeyId; 421 } 422 export interface CreateFileSystemFromBackupResponse { 423 /** 424 * A description of the file system. 425 */ 426 FileSystem?: FileSystem; 427 } 428 export interface CreateFileSystemLustreConfiguration { 429 /** 430 * (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. 431 */ 432 WeeklyMaintenanceStartTime?: WeeklyTime; 433 /** 434 * (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. 435 */ 436 ImportPath?: ArchivePath; 437 /** 438 * (Optional) The path in Amazon S3 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 only specify 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. 439 */ 440 ExportPath?: ArchivePath; 441 /** 442 * (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. 443 */ 444 ImportedFileChunkSize?: Megabytes; 445 /** 446 * 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 deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options. Encryption of data in-transit is automatically enabled when you access a SCRATCH_2 or PERSISTENT_1 file system from Amazon EC2 instances that support this feature. (Default = SCRATCH_1) Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, Encrypting Data in Transit. 447 */ 448 DeploymentType?: LustreDeploymentType; 449 /** 450 * (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 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. For more information, see Automatically import updates from your S3 bucket. 451 */ 452 AutoImportPolicy?: AutoImportPolicyType; 453 /** 454 * Required for the PERSISTENT_1 deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, 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 SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40. 455 */ 456 PerUnitStorageThroughput?: PerUnitStorageThroughput; 457 DailyAutomaticBackupStartTime?: DailyTime; 458 AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; 459 /** 460 * (Optional) Not available to 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 it's 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 this value is 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. For more information, see Working with backups. 461 */ 462 CopyTagsToBackups?: Flag; 463 /** 464 * 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 to READ, improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached. This parameter is required when StorageType is set to HDD. 465 */ 466 DriveCacheType?: DriveCacheType; 467 /** 468 * 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. 469 */ 470 DataCompressionType?: DataCompressionType; 471 } 472 export interface CreateFileSystemRequest { 473 /** 474 * A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. 475 */ 476 ClientRequestToken?: ClientRequestToken; 477 /** 478 * The type of Amazon FSx file system to create, either WINDOWS or LUSTRE. 479 */ 480 FileSystemType: FileSystemType; 481 /** 482 * Sets the storage capacity of the file system that you're creating. For Lustre file systems: For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. For PERSISTENT 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. For Windows file systems: If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB). If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB). 483 */ 484 StorageCapacity: StorageCapacity; 485 /** 486 * Sets the storage type for the file system you're creating. Valid values are SSD and HDD. Set to SSD to use solid state drive storage. SSD is supported on all Windows and Lustre 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 Lustre file system deployment types. Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide and Multiple Storage Options in the Amazon FSx for Lustre User Guide. 487 */ 488 StorageType?: StorageType; 489 /** 490 * 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. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems. For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone. 491 */ 492 SubnetIds: SubnetIds; 493 /** 494 * 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. 495 */ 496 SecurityGroupIds?: SecurityGroupIds; 497 /** 498 * The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name. 499 */ 500 Tags?: Tags; 501 KmsKeyId?: KmsKeyId; 502 /** 503 * The Microsoft Windows configuration for the file system being created. 504 */ 505 WindowsConfiguration?: CreateFileSystemWindowsConfiguration; 506 LustreConfiguration?: CreateFileSystemLustreConfiguration; 507 } 508 export interface CreateFileSystemResponse { 509 /** 510 * The configuration of the file system that was created. 511 */ 512 FileSystem?: FileSystem; 513 } 514 export interface CreateFileSystemWindowsConfiguration { 515 /** 516 * The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created. 517 */ 518 ActiveDirectoryId?: DirectoryId; 519 SelfManagedActiveDirectoryConfiguration?: SelfManagedActiveDirectoryConfiguration; 520 /** 521 * 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 AWS 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. 522 */ 523 DeploymentType?: WindowsDeploymentType; 524 /** 525 * 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-AWS 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. 526 */ 527 PreferredSubnetId?: SubnetId; 528 /** 529 * The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 (8) and 2^11 (2048). 530 */ 531 ThroughputCapacity: MegabytesPerSecond; 532 /** 533 * 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. 534 */ 535 WeeklyMaintenanceStartTime?: WeeklyTime; 536 /** 537 * The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone. 538 */ 539 DailyAutomaticBackupStartTime?: DailyTime; 540 /** 541 * The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days. 542 */ 543 AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; 544 /** 545 * 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. 546 */ 547 CopyTagsToBackups?: Flag; 548 /** 549 * 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. 550 */ 551 Aliases?: AlternateDNSNames; 552 /** 553 * 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. 554 */ 555 AuditLogConfiguration?: WindowsAuditLogCreateConfiguration; 556 } 557 export type CreationTime = Date; 558 export type DNSName = string; 559 export type DailyTime = string; 560 export type DataCompressionType = "NONE"|"LZ4"|string; 561 export interface DataRepositoryConfiguration { 562 /** 563 * 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. 564 */ 565 Lifecycle?: DataRepositoryLifecycle; 566 /** 567 * 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. 568 */ 569 ImportPath?: ArchivePath; 570 /** 571 * 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. 572 */ 573 ExportPath?: ArchivePath; 574 /** 575 * 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. 576 */ 577 ImportedFileChunkSize?: Megabytes; 578 /** 579 * 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. For more information, see Automatically import updates from your S3 bucket. 580 */ 581 AutoImportPolicy?: AutoImportPolicyType; 582 FailureDetails?: DataRepositoryFailureDetails; 583 } 584 export interface DataRepositoryFailureDetails { 585 Message?: ErrorMessage; 586 } 587 export type DataRepositoryLifecycle = "CREATING"|"AVAILABLE"|"MISCONFIGURED"|"UPDATING"|"DELETING"|string; 588 export interface DataRepositoryTask { 589 /** 590 * The system-generated, unique 17-digit ID of the data repository task. 591 */ 592 TaskId: TaskId; 593 /** 594 * 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. 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. 595 */ 596 Lifecycle: DataRepositoryTaskLifecycle; 597 /** 598 * The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported. 599 */ 600 Type: DataRepositoryTaskType; 601 CreationTime: CreationTime; 602 /** 603 * The time that Amazon FSx began processing the task. 604 */ 605 StartTime?: StartTime; 606 /** 607 * The time that Amazon FSx completed processing the task, populated after the task is complete. 608 */ 609 EndTime?: EndTime; 610 ResourceARN?: ResourceARN; 611 Tags?: Tags; 612 FileSystemId: FileSystemId; 613 /** 614 * An array of paths on the Amazon FSx for Lustre file system 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. 615 */ 616 Paths?: DataRepositoryTaskPaths; 617 /** 618 * Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED. 619 */ 620 FailureDetails?: DataRepositoryTaskFailureDetails; 621 /** 622 * Provides the status of the number of files that the task has processed successfully and failed to process. 623 */ 624 Status?: DataRepositoryTaskStatus; 625 Report?: CompletionReport; 626 } 627 export interface DataRepositoryTaskFailureDetails { 628 Message?: ErrorMessage; 629 } 630 export interface DataRepositoryTaskFilter { 631 /** 632 * 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. 633 */ 634 Name?: DataRepositoryTaskFilterName; 635 /** 636 * Use Values to include the specific file system IDs and task lifecycle states for the filters you are using. 637 */ 638 Values?: DataRepositoryTaskFilterValues; 639 } 640 export type DataRepositoryTaskFilterName = "file-system-id"|"task-lifecycle"|string; 641 export type DataRepositoryTaskFilterValue = string; 642 export type DataRepositoryTaskFilterValues = DataRepositoryTaskFilterValue[]; 643 export type DataRepositoryTaskFilters = DataRepositoryTaskFilter[]; 644 export type DataRepositoryTaskLifecycle = "PENDING"|"EXECUTING"|"FAILED"|"SUCCEEDED"|"CANCELED"|"CANCELING"|string; 645 export type DataRepositoryTaskPath = string; 646 export type DataRepositoryTaskPaths = DataRepositoryTaskPath[]; 647 export interface DataRepositoryTaskStatus { 648 /** 649 * 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. 650 */ 651 TotalCount?: TotalCount; 652 /** 653 * A running total of the number of files that the task has successfully processed. 654 */ 655 SucceededCount?: SucceededCount; 656 /** 657 * A running total of the number of files that the task failed to process. 658 */ 659 FailedCount?: FailedCount; 660 /** 661 * The time at which the task status was last updated. 662 */ 663 LastUpdatedTime?: LastUpdatedTime; 664 } 665 export type DataRepositoryTaskType = "EXPORT_TO_REPOSITORY"|string; 666 export type DataRepositoryTasks = DataRepositoryTask[]; 667 export interface DeleteBackupRequest { 668 /** 669 * The ID of the backup you want to delete. 670 */ 671 BackupId: BackupId; 672 /** 673 * A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK. 674 */ 675 ClientRequestToken?: ClientRequestToken; 676 } 677 export interface DeleteBackupResponse { 678 /** 679 * The ID of the backup deleted. 680 */ 681 BackupId?: BackupId; 682 /** 683 * The lifecycle of the backup. Should be DELETED. 684 */ 685 Lifecycle?: BackupLifecycle; 686 } 687 export interface DeleteFileSystemLustreConfiguration { 688 /** 689 * 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) 690 */ 691 SkipFinalBackup?: Flag; 692 /** 693 * 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. 694 */ 695 FinalBackupTags?: Tags; 696 } 697 export interface DeleteFileSystemLustreResponse { 698 /** 699 * The ID of the final backup for this file system. 700 */ 701 FinalBackupId?: BackupId; 702 /** 703 * The set of tags applied to the final backup. 704 */ 705 FinalBackupTags?: Tags; 706 } 707 export interface DeleteFileSystemRequest { 708 /** 709 * The ID of the file system you want to delete. 710 */ 711 FileSystemId: FileSystemId; 712 /** 713 * A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK. 714 */ 715 ClientRequestToken?: ClientRequestToken; 716 WindowsConfiguration?: DeleteFileSystemWindowsConfiguration; 717 LustreConfiguration?: DeleteFileSystemLustreConfiguration; 718 } 719 export interface DeleteFileSystemResponse { 720 /** 721 * The ID of the file system being deleted. 722 */ 723 FileSystemId?: FileSystemId; 724 /** 725 * The file system lifecycle for the deletion request. Should be DELETING. 726 */ 727 Lifecycle?: FileSystemLifecycle; 728 WindowsResponse?: DeleteFileSystemWindowsResponse; 729 LustreResponse?: DeleteFileSystemLustreResponse; 730 } 731 export interface DeleteFileSystemWindowsConfiguration { 732 /** 733 * 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. 734 */ 735 SkipFinalBackup?: Flag; 736 /** 737 * A set of tags for your final backup. 738 */ 739 FinalBackupTags?: Tags; 740 } 741 export interface DeleteFileSystemWindowsResponse { 742 /** 743 * The ID of the final backup for this file system. 744 */ 745 FinalBackupId?: BackupId; 746 /** 747 * The set of tags applied to the final backup. 748 */ 749 FinalBackupTags?: Tags; 750 } 751 export interface DescribeBackupsRequest { 752 /** 753 * IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown. 754 */ 755 BackupIds?: BackupIds; 756 /** 757 * Filters structure. Supported names are file-system-id and backup-type. 758 */ 759 Filters?: Filters; 760 /** 761 * Maximum number of backups 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. 762 */ 763 MaxResults?: MaxResults; 764 /** 765 * Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off. 766 */ 767 NextToken?: NextToken; 768 } 769 export interface DescribeBackupsResponse { 770 /** 771 * An array of backups. 772 */ 773 Backups?: Backups; 774 /** 775 * This is present if there are more backups than returned in the response (String). You can use the NextToken value in the later request to fetch the backups. 776 */ 777 NextToken?: NextToken; 778 } 779 export interface DescribeDataRepositoryTasksRequest { 780 /** 781 * (Optional) IDs of the tasks whose descriptions you want to retrieve (String). 782 */ 783 TaskIds?: TaskIds; 784 /** 785 * (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. 786 */ 787 Filters?: DataRepositoryTaskFilters; 788 MaxResults?: MaxResults; 789 NextToken?: NextToken; 790 } 791 export interface DescribeDataRepositoryTasksResponse { 792 /** 793 * The collection of data repository task descriptions returned. 794 */ 795 DataRepositoryTasks?: DataRepositoryTasks; 796 NextToken?: NextToken; 797 } 798 export interface DescribeFileSystemAliasesRequest { 799 ClientRequestToken?: ClientRequestToken; 800 /** 801 * The ID of the file system to return the associated DNS aliases for (String). 802 */ 803 FileSystemId: FileSystemId; 804 /** 805 * 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. 806 */ 807 MaxResults?: MaxResults; 808 /** 809 * 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. 810 */ 811 NextToken?: NextToken; 812 } 813 export interface DescribeFileSystemAliasesResponse { 814 /** 815 * An array of one or more DNS aliases currently associated with the specified file system. 816 */ 817 Aliases?: Aliases; 818 /** 819 * 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. 820 */ 821 NextToken?: NextToken; 822 } 823 export interface DescribeFileSystemsRequest { 824 /** 825 * IDs of the file systems whose descriptions you want to retrieve (String). 826 */ 827 FileSystemIds?: FileSystemIds; 828 /** 829 * 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. 830 */ 831 MaxResults?: MaxResults; 832 /** 833 * Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the action continues the list from where the returning call left off. 834 */ 835 NextToken?: NextToken; 836 } 837 export interface DescribeFileSystemsResponse { 838 /** 839 * An array of file system descriptions. 840 */ 841 FileSystems?: FileSystems; 842 /** 843 * 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. 844 */ 845 NextToken?: NextToken; 846 } 847 export type DirectoryId = string; 848 export type DirectoryPassword = string; 849 export type DirectoryUserName = string; 850 export interface DisassociateFileSystemAliasesRequest { 851 ClientRequestToken?: ClientRequestToken; 852 /** 853 * Specifies the file system from which to disassociate the DNS aliases. 854 */ 855 FileSystemId: FileSystemId; 856 /** 857 * An array of one or more DNS alias names to disassociate, or remove, from the file system. 858 */ 859 Aliases: AlternateDNSNames; 860 } 861 export interface DisassociateFileSystemAliasesResponse { 862 /** 863 * An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system. 864 */ 865 Aliases?: Aliases; 866 } 867 export type DnsIps = IpAddress[]; 868 export type DriveCacheType = "NONE"|"READ"|string; 869 export type EndTime = Date; 870 export type ErrorMessage = string; 871 export type FailedCount = number; 872 export interface FileSystem { 873 /** 874 * The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner. 875 */ 876 OwnerId?: AWSAccountId; 877 /** 878 * The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. 879 */ 880 CreationTime?: CreationTime; 881 /** 882 * The system-generated, unique 17-digit ID of the file system. 883 */ 884 FileSystemId?: FileSystemId; 885 /** 886 * The type of Amazon FSx file system, either LUSTRE or WINDOWS. 887 */ 888 FileSystemType?: FileSystemType; 889 /** 890 * The lifecycle status of the file system, 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 indicates that the file system is in a failed but recoverable state. UPDATING indicates that the file system is undergoing a customer initiated update. 891 */ 892 Lifecycle?: FileSystemLifecycle; 893 FailureDetails?: FileSystemFailureDetails; 894 /** 895 * The storage capacity of the file system in gibibytes (GiB). 896 */ 897 StorageCapacity?: StorageCapacity; 898 /** 899 * The storage type of the file system. Valid values are SSD and HDD. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage. 900 */ 901 StorageType?: StorageType; 902 /** 903 * The ID of the primary VPC for the file system. 904 */ 905 VpcId?: VpcId; 906 /** 907 * Specifies the IDs of the subnets that the file system is accessible from. For Windows 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 Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID. 908 */ 909 SubnetIds?: SubnetIds; 910 /** 911 * The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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. 912 */ 913 NetworkInterfaceIds?: NetworkInterfaceIds; 914 /** 915 * The DNS name for the file system. 916 */ 917 DNSName?: DNSName; 918 /** 919 * The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference. 920 */ 921 KmsKeyId?: KmsKeyId; 922 /** 923 * The Amazon Resource Name (ARN) for the file system resource. 924 */ 925 ResourceARN?: ResourceARN; 926 /** 927 * The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide. 928 */ 929 Tags?: Tags; 930 /** 931 * The configuration for this Microsoft Windows file system. 932 */ 933 WindowsConfiguration?: WindowsFileSystemConfiguration; 934 LustreConfiguration?: LustreFileSystemConfiguration; 935 /** 936 * A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action. 937 */ 938 AdministrativeActions?: AdministrativeActions; 939 } 940 export type FileSystemAdministratorsGroupName = string; 941 export interface FileSystemFailureDetails { 942 /** 943 * A message describing any failures that occurred during file system creation. 944 */ 945 Message?: ErrorMessage; 946 } 947 export type FileSystemId = string; 948 export type FileSystemIds = FileSystemId[]; 949 export type FileSystemLifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|"MISCONFIGURED"|"UPDATING"|string; 950 export type FileSystemMaintenanceOperation = "PATCHING"|"BACKING_UP"|string; 951 export type FileSystemMaintenanceOperations = FileSystemMaintenanceOperation[]; 952 export type FileSystemType = "WINDOWS"|"LUSTRE"|string; 953 export type FileSystems = FileSystem[]; 954 export interface Filter { 955 /** 956 * The name for this filter. 957 */ 958 Name?: FilterName; 959 /** 960 * The values of the filter. These are all the values for any of the applied filters. 961 */ 962 Values?: FilterValues; 963 } 964 export type FilterName = "file-system-id"|"backup-type"|"file-system-type"|string; 965 export type FilterValue = string; 966 export type FilterValues = FilterValue[]; 967 export type Filters = Filter[]; 968 export type Flag = boolean; 969 export type GeneralARN = string; 970 export type IpAddress = string; 971 export type KmsKeyId = string; 972 export type LastUpdatedTime = Date; 973 export interface ListTagsForResourceRequest { 974 /** 975 * The ARN of the Amazon FSx resource that will have its tags listed. 976 */ 977 ResourceARN: ResourceARN; 978 /** 979 * 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. 980 */ 981 MaxResults?: MaxResults; 982 /** 983 * 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. 984 */ 985 NextToken?: NextToken; 986 } 987 export interface ListTagsForResourceResponse { 988 /** 989 * A list of tags on the resource. 990 */ 991 Tags?: Tags; 992 /** 993 * 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. 994 */ 995 NextToken?: NextToken; 996 } 997 export type LustreDeploymentType = "SCRATCH_1"|"SCRATCH_2"|"PERSISTENT_1"|string; 998 export interface LustreFileSystemConfiguration { 999 /** 1000 * 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. 1001 */ 1002 WeeklyMaintenanceStartTime?: WeeklyTime; 1003 DataRepositoryConfiguration?: DataRepositoryConfiguration; 1004 /** 1005 * 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 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options. (Default = SCRATCH_1) 1006 */ 1007 DeploymentType?: LustreDeploymentType; 1008 /** 1009 * 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 deployment types. Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40. 1010 */ 1011 PerUnitStorageThroughput?: PerUnitStorageThroughput; 1012 /** 1013 * You use the MountName value when mounting the file system. For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS Region. 1014 */ 1015 MountName?: LustreFileSystemMountName; 1016 DailyAutomaticBackupStartTime?: DailyTime; 1017 AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; 1018 /** 1019 * A boolean flag 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. (Default = false) 1020 */ 1021 CopyTagsToBackups?: Flag; 1022 /** 1023 * 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 to READ, improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached. This parameter is required when StorageType is set to HDD. 1024 */ 1025 DriveCacheType?: DriveCacheType; 1026 /** 1027 * 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. 1028 */ 1029 DataCompressionType?: DataCompressionType; 1030 } 1031 export type LustreFileSystemMountName = string; 1032 export type MaxResults = number; 1033 export type Megabytes = number; 1034 export type MegabytesPerSecond = number; 1035 export type NetworkInterfaceId = string; 1036 export type NetworkInterfaceIds = NetworkInterfaceId[]; 1037 export type NextToken = string; 1038 export type OrganizationalUnitDistinguishedName = string; 1039 export type PerUnitStorageThroughput = number; 1040 export type ProgressPercent = number; 1041 export type Region = string; 1042 export type ReportFormat = "REPORT_CSV_20191124"|string; 1043 export type ReportScope = "FAILED_FILES_ONLY"|string; 1044 export type RequestTime = Date; 1045 export type ResourceARN = string; 1046 export type SecurityGroupId = string; 1047 export type SecurityGroupIds = SecurityGroupId[]; 1048 export interface SelfManagedActiveDirectoryAttributes { 1049 /** 1050 * The fully qualified domain name of the self-managed AD directory. 1051 */ 1052 DomainName?: ActiveDirectoryFullyQualifiedName; 1053 /** 1054 * The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined. 1055 */ 1056 OrganizationalUnitDistinguishedName?: OrganizationalUnitDistinguishedName; 1057 /** 1058 * The name of the domain group whose members have administrative privileges for the FSx file system. 1059 */ 1060 FileSystemAdministratorsGroup?: FileSystemAdministratorsGroupName; 1061 /** 1062 * The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. 1063 */ 1064 UserName?: DirectoryUserName; 1065 /** 1066 * A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. 1067 */ 1068 DnsIps?: DnsIps; 1069 } 1070 export interface SelfManagedActiveDirectoryConfiguration { 1071 /** 1072 * The fully qualified domain name of the self-managed AD directory, such as corp.example.com. 1073 */ 1074 DomainName: ActiveDirectoryFullyQualifiedName; 1075 /** 1076 * (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. 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. 1077 */ 1078 OrganizationalUnitDistinguishedName?: OrganizationalUnitDistinguishedName; 1079 /** 1080 * (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. 1081 */ 1082 FileSystemAdministratorsGroup?: FileSystemAdministratorsGroupName; 1083 /** 1084 * 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. 1085 */ 1086 UserName: DirectoryUserName; 1087 /** 1088 * The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. 1089 */ 1090 Password: DirectoryPassword; 1091 /** 1092 * A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. 1093 */ 1094 DnsIps: DnsIps; 1095 } 1096 export interface SelfManagedActiveDirectoryConfigurationUpdates { 1097 /** 1098 * 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. 1099 */ 1100 UserName?: DirectoryUserName; 1101 /** 1102 * The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. 1103 */ 1104 Password?: DirectoryPassword; 1105 /** 1106 * A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. 1107 */ 1108 DnsIps?: DnsIps; 1109 } 1110 export type SourceBackupId = string; 1111 export type StartTime = Date; 1112 export type Status = "FAILED"|"IN_PROGRESS"|"PENDING"|"COMPLETED"|"UPDATED_OPTIMIZING"|string; 1113 export type StorageCapacity = number; 1114 export type StorageType = "SSD"|"HDD"|string; 1115 export type SubnetId = string; 1116 export type SubnetIds = SubnetId[]; 1117 export type SucceededCount = number; 1118 export interface Tag { 1119 /** 1120 * A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached. 1121 */ 1122 Key: TagKey; 1123 /** 1124 * 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. 1125 */ 1126 Value: TagValue; 1127 } 1128 export type TagKey = string; 1129 export type TagKeys = TagKey[]; 1130 export interface TagResourceRequest { 1131 /** 1132 * The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag. 1133 */ 1134 ResourceARN: ResourceARN; 1135 /** 1136 * 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. 1137 */ 1138 Tags: Tags; 1139 } 1140 export interface TagResourceResponse { 1141 } 1142 export type TagValue = string; 1143 export type Tags = Tag[]; 1144 export type TaskId = string; 1145 export type TaskIds = TaskId[]; 1146 export type TotalCount = number; 1147 export interface UntagResourceRequest { 1148 /** 1149 * The ARN of the Amazon FSx resource to untag. 1150 */ 1151 ResourceARN: ResourceARN; 1152 /** 1153 * 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. 1154 */ 1155 TagKeys: TagKeys; 1156 } 1157 export interface UntagResourceResponse { 1158 } 1159 export interface UpdateFileSystemLustreConfiguration { 1160 /** 1161 * (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. 1162 */ 1163 WeeklyMaintenanceStartTime?: WeeklyTime; 1164 DailyAutomaticBackupStartTime?: DailyTime; 1165 AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; 1166 /** 1167 * (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. For more information, see Automatically import updates from your S3 bucket. 1168 */ 1169 AutoImportPolicy?: AutoImportPolicyType; 1170 /** 1171 * 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. 1172 */ 1173 DataCompressionType?: DataCompressionType; 1174 } 1175 export interface UpdateFileSystemRequest { 1176 /** 1177 * Identifies the file system that you are updating. 1178 */ 1179 FileSystemId: FileSystemId; 1180 /** 1181 * A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK. 1182 */ 1183 ClientRequestToken?: ClientRequestToken; 1184 /** 1185 * Use this parameter to increase the storage capacity of an Amazon FSx file system. Specifies the storage capacity target value, GiB, to increase the storage capacity for the file system that you're updating. You cannot make a storage capacity increase request if there is an existing storage capacity increase request in progress. For Windows file systems, the storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value. In order to increase storage capacity, the file system must have at least 16 MB/s of throughput capacity. For Lustre file systems, the storage capacity target value can be the following: For SCRATCH_2 and PERSISTENT_1 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 MB/s/TiB file systems and multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater than the current storage capacity. For SCRATCH_1 file systems, you cannot increase the storage capacity. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide. 1186 */ 1187 StorageCapacity?: StorageCapacity; 1188 /** 1189 * The configuration updates for an Amazon FSx for Windows File Server file system. 1190 */ 1191 WindowsConfiguration?: UpdateFileSystemWindowsConfiguration; 1192 LustreConfiguration?: UpdateFileSystemLustreConfiguration; 1193 } 1194 export interface UpdateFileSystemResponse { 1195 /** 1196 * A description of the file system that was updated. 1197 */ 1198 FileSystem?: FileSystem; 1199 } 1200 export interface UpdateFileSystemWindowsConfiguration { 1201 /** 1202 * 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. 1203 */ 1204 WeeklyMaintenanceStartTime?: WeeklyTime; 1205 /** 1206 * The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00 1207 */ 1208 DailyAutomaticBackupStartTime?: DailyTime; 1209 /** 1210 * The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups. 1211 */ 1212 AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; 1213 /** 1214 * 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. 1215 */ 1216 ThroughputCapacity?: MegabytesPerSecond; 1217 /** 1218 * 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. 1219 */ 1220 SelfManagedActiveDirectoryConfiguration?: SelfManagedActiveDirectoryConfigurationUpdates; 1221 /** 1222 * 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.. 1223 */ 1224 AuditLogConfiguration?: WindowsAuditLogCreateConfiguration; 1225 } 1226 export type VpcId = string; 1227 export type WeeklyTime = string; 1228 export type WindowsAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE"|string; 1229 export interface WindowsAuditLogConfiguration { 1230 /** 1231 * 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. 1232 */ 1233 FileAccessAuditLogLevel: WindowsAccessAuditLogLevel; 1234 /** 1235 * 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. 1236 */ 1237 FileShareAccessAuditLogLevel: WindowsAccessAuditLogLevel; 1238 /** 1239 * 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 Firehouse 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 AWS partition, AWS region, and AWS account as your Amazon FSx file system. 1240 */ 1241 AuditLogDestination?: GeneralARN; 1242 } 1243 export interface WindowsAuditLogCreateConfiguration { 1244 /** 1245 * 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. 1246 */ 1247 FileAccessAuditLogLevel: WindowsAccessAuditLogLevel; 1248 /** 1249 * 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. 1250 */ 1251 FileShareAccessAuditLogLevel: WindowsAccessAuditLogLevel; 1252 /** 1253 * 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 AWS partition, AWS region, and AWS 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 Firehouse 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. 1254 */ 1255 AuditLogDestination?: GeneralARN; 1256 } 1257 export type WindowsDeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2"|string; 1258 export interface WindowsFileSystemConfiguration { 1259 /** 1260 * The ID for an existing AWS Managed Microsoft Active Directory instance that the file system is joined to. 1261 */ 1262 ActiveDirectoryId?: DirectoryId; 1263 SelfManagedActiveDirectoryConfiguration?: SelfManagedActiveDirectoryAttributes; 1264 /** 1265 * 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. 1266 */ 1267 DeploymentType?: WindowsDeploymentType; 1268 /** 1269 * 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. 1270 */ 1271 RemoteAdministrationEndpoint?: DNSName; 1272 /** 1273 * 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. 1274 */ 1275 PreferredSubnetId?: SubnetId; 1276 /** 1277 * 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. 1278 */ 1279 PreferredFileServerIp?: IpAddress; 1280 /** 1281 * The throughput of the Amazon FSx file system, measured in megabytes per second. 1282 */ 1283 ThroughputCapacity?: MegabytesPerSecond; 1284 /** 1285 * The list of maintenance operations in progress for this file system. 1286 */ 1287 MaintenanceOperationsInProgress?: FileSystemMaintenanceOperations; 1288 /** 1289 * 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. 1290 */ 1291 WeeklyMaintenanceStartTime?: WeeklyTime; 1292 /** 1293 * The preferred time to take daily automatic backups, in the UTC time zone. 1294 */ 1295 DailyAutomaticBackupStartTime?: DailyTime; 1296 /** 1297 * 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. 1298 */ 1299 AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays; 1300 /** 1301 * 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. 1302 */ 1303 CopyTagsToBackups?: Flag; 1304 Aliases?: Aliases; 1305 /** 1306 * 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. 1307 */ 1308 AuditLogConfiguration?: WindowsAuditLogConfiguration; 1309 } 1310 /** 1311 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1312 */ 1313 export type apiVersion = "2018-03-01"|"latest"|string; 1314 export interface ClientApiVersions { 1315 /** 1316 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1317 */ 1318 apiVersion?: apiVersion; 1319 } 1320 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1321 /** 1322 * Contains interfaces for use with the FSx client. 1323 */ 1324 export import Types = FSx; 1325 } 1326 export = FSx;