aws-sdk 2.981.0 → 2.982.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -1
- package/README.md +1 -1
- package/apis/acm-pca-2017-08-22.min.json +26 -14
- package/apis/elasticfilesystem-2015-02-01.min.json +2 -1
- package/apis/fsx-2018-03-01.min.json +639 -66
- package/apis/fsx-2018-03-01.paginators.json +15 -0
- package/apis/quicksight-2018-04-01.min.json +162 -127
- package/apis/s3control-2018-08-20.min.json +470 -24
- package/apis/s3control-2018-08-20.paginators.json +5 -0
- package/apis/schemas-2019-12-02.min.json +49 -31
- package/apis/securityhub-2018-10-26.min.json +492 -205
- package/apis/securityhub-2018-10-26.paginators.json +22 -11
- package/apis/transfer-2018-11-05.min.json +403 -9
- package/apis/transfer-2018-11-05.paginators.json +10 -0
- package/clients/accessanalyzer.d.ts +46 -43
- package/clients/acmpca.d.ts +21 -7
- package/clients/ebs.d.ts +1 -1
- package/clients/efs.d.ts +57 -31
- package/clients/fsx.d.ts +694 -52
- package/clients/lexmodelbuildingservice.d.ts +1 -1
- package/clients/quicksight.d.ts +343 -310
- package/clients/s3control.d.ts +439 -44
- package/clients/schemas.d.ts +25 -0
- package/clients/securityhub.d.ts +524 -21
- package/clients/transfer.d.ts +556 -28
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +13 -13
- package/dist/aws-sdk.js +5 -4
- package/dist/aws-sdk.min.js +6 -6
- package/lib/core.js +1 -1
- package/package.json +1 -1
package/clients/fsx.d.ts
CHANGED
|
@@ -12,11 +12,11 @@ declare class FSx extends Service {
|
|
|
12
12
|
constructor(options?: FSx.Types.ClientConfiguration)
|
|
13
13
|
config: Config & FSx.Types.ClientConfiguration;
|
|
14
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
|
|
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 system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias. The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.
|
|
16
16
|
*/
|
|
17
17
|
associateFileSystemAliases(params: FSx.Types.AssociateFileSystemAliasesRequest, callback?: (err: AWSError, data: FSx.Types.AssociateFileSystemAliasesResponse) => void): Request<FSx.Types.AssociateFileSystemAliasesResponse, AWSError>;
|
|
18
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
|
|
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 system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias. The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.
|
|
20
20
|
*/
|
|
21
21
|
associateFileSystemAliases(callback?: (err: AWSError, data: FSx.Types.AssociateFileSystemAliasesResponse) => void): Request<FSx.Types.AssociateFileSystemAliasesResponse, AWSError>;
|
|
22
22
|
/**
|
|
@@ -28,19 +28,19 @@ declare class FSx extends Service {
|
|
|
28
28
|
*/
|
|
29
29
|
cancelDataRepositoryTask(callback?: (err: AWSError, data: FSx.Types.CancelDataRepositoryTaskResponse) => void): Request<FSx.Types.CancelDataRepositoryTaskResponse, AWSError>;
|
|
30
30
|
/**
|
|
31
|
-
* Copies an existing backup within the same
|
|
31
|
+
* Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account. You can use cross-Region backup copies for cross-region disaster recovery. You periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. 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 Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy). For more information 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
32
|
*/
|
|
33
33
|
copyBackup(params: FSx.Types.CopyBackupRequest, callback?: (err: AWSError, data: FSx.Types.CopyBackupResponse) => void): Request<FSx.Types.CopyBackupResponse, AWSError>;
|
|
34
34
|
/**
|
|
35
|
-
* Copies an existing backup within the same
|
|
35
|
+
* Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account. You can use cross-Region backup copies for cross-region disaster recovery. You periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. 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 Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy). For more information 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
36
|
*/
|
|
37
37
|
copyBackup(callback?: (err: AWSError, data: FSx.Types.CopyBackupResponse) => void): Request<FSx.Types.CopyBackupResponse, AWSError>;
|
|
38
38
|
/**
|
|
39
|
-
* Creates a backup of an existing Amazon FSx
|
|
39
|
+
* Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to restore a file system or volume from a backup if an issue arises with the original file system or volume. For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration: a Persistent deployment type is not linked to a data repository. For more information about backups, see the following: For Amazon FSx for Lustre, see Working with FSx for Lustre backups. For Amazon FSx for Windows, see Working with FSx for Windows backups. For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups. 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
40
|
*/
|
|
41
41
|
createBackup(params: FSx.Types.CreateBackupRequest, callback?: (err: AWSError, data: FSx.Types.CreateBackupResponse) => void): Request<FSx.Types.CreateBackupResponse, AWSError>;
|
|
42
42
|
/**
|
|
43
|
-
* Creates a backup of an existing Amazon FSx
|
|
43
|
+
* Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to restore a file system or volume from a backup if an issue arises with the original file system or volume. For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration: a Persistent deployment type is not linked to a data repository. For more information about backups, see the following: For Amazon FSx for Lustre, see Working with FSx for Lustre backups. For Amazon FSx for Windows, see Working with FSx for Windows backups. For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups. 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
44
|
*/
|
|
45
45
|
createBackup(callback?: (err: AWSError, data: FSx.Types.CreateBackupResponse) => void): Request<FSx.Types.CreateBackupResponse, AWSError>;
|
|
46
46
|
/**
|
|
@@ -60,13 +60,37 @@ declare class FSx extends Service {
|
|
|
60
60
|
*/
|
|
61
61
|
createFileSystem(callback?: (err: AWSError, data: FSx.Types.CreateFileSystemResponse) => void): Request<FSx.Types.CreateFileSystemResponse, AWSError>;
|
|
62
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.
|
|
63
|
+
* Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server 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
64
|
*/
|
|
65
65
|
createFileSystemFromBackup(params: FSx.Types.CreateFileSystemFromBackupRequest, callback?: (err: AWSError, data: FSx.Types.CreateFileSystemFromBackupResponse) => void): Request<FSx.Types.CreateFileSystemFromBackupResponse, AWSError>;
|
|
66
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.
|
|
67
|
+
* Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server 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
68
|
*/
|
|
69
69
|
createFileSystemFromBackup(callback?: (err: AWSError, data: FSx.Types.CreateFileSystemFromBackupResponse) => void): Request<FSx.Types.CreateFileSystemFromBackupResponse, AWSError>;
|
|
70
|
+
/**
|
|
71
|
+
* Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
|
|
72
|
+
*/
|
|
73
|
+
createStorageVirtualMachine(params: FSx.Types.CreateStorageVirtualMachineRequest, callback?: (err: AWSError, data: FSx.Types.CreateStorageVirtualMachineResponse) => void): Request<FSx.Types.CreateStorageVirtualMachineResponse, AWSError>;
|
|
74
|
+
/**
|
|
75
|
+
* Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
|
|
76
|
+
*/
|
|
77
|
+
createStorageVirtualMachine(callback?: (err: AWSError, data: FSx.Types.CreateStorageVirtualMachineResponse) => void): Request<FSx.Types.CreateStorageVirtualMachineResponse, AWSError>;
|
|
78
|
+
/**
|
|
79
|
+
* Creates an Amazon FSx for NetApp ONTAP storage volume.
|
|
80
|
+
*/
|
|
81
|
+
createVolume(params: FSx.Types.CreateVolumeRequest, callback?: (err: AWSError, data: FSx.Types.CreateVolumeResponse) => void): Request<FSx.Types.CreateVolumeResponse, AWSError>;
|
|
82
|
+
/**
|
|
83
|
+
* Creates an Amazon FSx for NetApp ONTAP storage volume.
|
|
84
|
+
*/
|
|
85
|
+
createVolume(callback?: (err: AWSError, data: FSx.Types.CreateVolumeResponse) => void): Request<FSx.Types.CreateVolumeResponse, AWSError>;
|
|
86
|
+
/**
|
|
87
|
+
* Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
|
|
88
|
+
*/
|
|
89
|
+
createVolumeFromBackup(params: FSx.Types.CreateVolumeFromBackupRequest, callback?: (err: AWSError, data: FSx.Types.CreateVolumeFromBackupResponse) => void): Request<FSx.Types.CreateVolumeFromBackupResponse, AWSError>;
|
|
90
|
+
/**
|
|
91
|
+
* Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
|
|
92
|
+
*/
|
|
93
|
+
createVolumeFromBackup(callback?: (err: AWSError, data: FSx.Types.CreateVolumeFromBackupResponse) => void): Request<FSx.Types.CreateVolumeFromBackupResponse, AWSError>;
|
|
70
94
|
/**
|
|
71
95
|
* 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
96
|
*/
|
|
@@ -76,27 +100,43 @@ declare class FSx extends Service {
|
|
|
76
100
|
*/
|
|
77
101
|
deleteBackup(callback?: (err: AWSError, data: FSx.Types.DeleteBackupResponse) => void): Request<FSx.Types.DeleteBackupResponse, AWSError>;
|
|
78
102
|
/**
|
|
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.
|
|
103
|
+
* 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. To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and SVMs on the file system. Then provide a FileSystemId value to the DeleFileSystem operation. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup 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
104
|
*/
|
|
81
105
|
deleteFileSystem(params: FSx.Types.DeleteFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.DeleteFileSystemResponse) => void): Request<FSx.Types.DeleteFileSystemResponse, AWSError>;
|
|
82
106
|
/**
|
|
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.
|
|
107
|
+
* 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. To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and SVMs on the file system. Then provide a FileSystemId value to the DeleFileSystem operation. By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup 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
108
|
*/
|
|
85
109
|
deleteFileSystem(callback?: (err: AWSError, data: FSx.Types.DeleteFileSystemResponse) => void): Request<FSx.Types.DeleteFileSystemResponse, AWSError>;
|
|
86
110
|
/**
|
|
87
|
-
*
|
|
111
|
+
* Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
|
|
112
|
+
*/
|
|
113
|
+
deleteStorageVirtualMachine(params: FSx.Types.DeleteStorageVirtualMachineRequest, callback?: (err: AWSError, data: FSx.Types.DeleteStorageVirtualMachineResponse) => void): Request<FSx.Types.DeleteStorageVirtualMachineResponse, AWSError>;
|
|
114
|
+
/**
|
|
115
|
+
* Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
|
|
116
|
+
*/
|
|
117
|
+
deleteStorageVirtualMachine(callback?: (err: AWSError, data: FSx.Types.DeleteStorageVirtualMachineResponse) => void): Request<FSx.Types.DeleteStorageVirtualMachineResponse, AWSError>;
|
|
118
|
+
/**
|
|
119
|
+
* Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume, you have the option of creating a final backup. If you create a final backup, you have the option to apply Tags to the backup. You need to have fsx:TagResource permission in order to apply tags to the backup.
|
|
120
|
+
*/
|
|
121
|
+
deleteVolume(params: FSx.Types.DeleteVolumeRequest, callback?: (err: AWSError, data: FSx.Types.DeleteVolumeResponse) => void): Request<FSx.Types.DeleteVolumeResponse, AWSError>;
|
|
122
|
+
/**
|
|
123
|
+
* Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume, you have the option of creating a final backup. If you create a final backup, you have the option to apply Tags to the backup. You need to have fsx:TagResource permission in order to apply tags to the backup.
|
|
124
|
+
*/
|
|
125
|
+
deleteVolume(callback?: (err: AWSError, data: FSx.Types.DeleteVolumeResponse) => void): Request<FSx.Types.DeleteVolumeResponse, AWSError>;
|
|
126
|
+
/**
|
|
127
|
+
* 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 Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of 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 backup 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
128
|
*/
|
|
89
129
|
describeBackups(params: FSx.Types.DescribeBackupsRequest, callback?: (err: AWSError, data: FSx.Types.DescribeBackupsResponse) => void): Request<FSx.Types.DescribeBackupsResponse, AWSError>;
|
|
90
130
|
/**
|
|
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
|
|
131
|
+
* 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 Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of 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 backup 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
132
|
*/
|
|
93
133
|
describeBackups(callback?: (err: AWSError, data: FSx.Types.DescribeBackupsResponse) => void): Request<FSx.Types.DescribeBackupsResponse, AWSError>;
|
|
94
134
|
/**
|
|
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
|
|
135
|
+
* 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 Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, 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
136
|
*/
|
|
97
137
|
describeDataRepositoryTasks(params: FSx.Types.DescribeDataRepositoryTasksRequest, callback?: (err: AWSError, data: FSx.Types.DescribeDataRepositoryTasksResponse) => void): Request<FSx.Types.DescribeDataRepositoryTasksResponse, AWSError>;
|
|
98
138
|
/**
|
|
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
|
|
139
|
+
* 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 Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, 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
140
|
*/
|
|
101
141
|
describeDataRepositoryTasks(callback?: (err: AWSError, data: FSx.Types.DescribeDataRepositoryTasksResponse) => void): Request<FSx.Types.DescribeDataRepositoryTasksResponse, AWSError>;
|
|
102
142
|
/**
|
|
@@ -108,13 +148,29 @@ declare class FSx extends Service {
|
|
|
108
148
|
*/
|
|
109
149
|
describeFileSystemAliases(callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemAliasesResponse) => void): Request<FSx.Types.DescribeFileSystemAliasesResponse, AWSError>;
|
|
110
150
|
/**
|
|
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
|
|
151
|
+
* Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This 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
152
|
*/
|
|
113
153
|
describeFileSystems(params: FSx.Types.DescribeFileSystemsRequest, callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemsResponse) => void): Request<FSx.Types.DescribeFileSystemsResponse, AWSError>;
|
|
114
154
|
/**
|
|
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
|
|
155
|
+
* Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response. This 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
156
|
*/
|
|
117
157
|
describeFileSystems(callback?: (err: AWSError, data: FSx.Types.DescribeFileSystemsResponse) => void): Request<FSx.Types.DescribeFileSystemsResponse, AWSError>;
|
|
158
|
+
/**
|
|
159
|
+
* Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
|
|
160
|
+
*/
|
|
161
|
+
describeStorageVirtualMachines(params: FSx.Types.DescribeStorageVirtualMachinesRequest, callback?: (err: AWSError, data: FSx.Types.DescribeStorageVirtualMachinesResponse) => void): Request<FSx.Types.DescribeStorageVirtualMachinesResponse, AWSError>;
|
|
162
|
+
/**
|
|
163
|
+
* Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
|
|
164
|
+
*/
|
|
165
|
+
describeStorageVirtualMachines(callback?: (err: AWSError, data: FSx.Types.DescribeStorageVirtualMachinesResponse) => void): Request<FSx.Types.DescribeStorageVirtualMachinesResponse, AWSError>;
|
|
166
|
+
/**
|
|
167
|
+
* Describes one or more Amazon FSx for NetApp ONTAP volumes.
|
|
168
|
+
*/
|
|
169
|
+
describeVolumes(params: FSx.Types.DescribeVolumesRequest, callback?: (err: AWSError, data: FSx.Types.DescribeVolumesResponse) => void): Request<FSx.Types.DescribeVolumesResponse, AWSError>;
|
|
170
|
+
/**
|
|
171
|
+
* Describes one or more Amazon FSx for NetApp ONTAP volumes.
|
|
172
|
+
*/
|
|
173
|
+
describeVolumes(callback?: (err: AWSError, data: FSx.Types.DescribeVolumesResponse) => void): Request<FSx.Types.DescribeVolumesResponse, AWSError>;
|
|
118
174
|
/**
|
|
119
175
|
* 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
176
|
*/
|
|
@@ -148,13 +204,29 @@ declare class FSx extends Service {
|
|
|
148
204
|
*/
|
|
149
205
|
untagResource(callback?: (err: AWSError, data: FSx.Types.UntagResourceResponse) => void): Request<FSx.Types.UntagResourceResponse, AWSError>;
|
|
150
206
|
/**
|
|
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
|
|
207
|
+
* 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 For Amazon FSx for NetApp ONTAP file systems, you can update the following properties: AutomaticBackupRetentionDays DailyAutomaticBackupStartTime FsxAdminPassword WeeklyMaintenanceStartTime
|
|
152
208
|
*/
|
|
153
209
|
updateFileSystem(params: FSx.Types.UpdateFileSystemRequest, callback?: (err: AWSError, data: FSx.Types.UpdateFileSystemResponse) => void): Request<FSx.Types.UpdateFileSystemResponse, AWSError>;
|
|
154
210
|
/**
|
|
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
|
|
211
|
+
* 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 For Amazon FSx for NetApp ONTAP file systems, you can update the following properties: AutomaticBackupRetentionDays DailyAutomaticBackupStartTime FsxAdminPassword WeeklyMaintenanceStartTime
|
|
156
212
|
*/
|
|
157
213
|
updateFileSystem(callback?: (err: AWSError, data: FSx.Types.UpdateFileSystemResponse) => void): Request<FSx.Types.UpdateFileSystemResponse, AWSError>;
|
|
214
|
+
/**
|
|
215
|
+
* Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
|
|
216
|
+
*/
|
|
217
|
+
updateStorageVirtualMachine(params: FSx.Types.UpdateStorageVirtualMachineRequest, callback?: (err: AWSError, data: FSx.Types.UpdateStorageVirtualMachineResponse) => void): Request<FSx.Types.UpdateStorageVirtualMachineResponse, AWSError>;
|
|
218
|
+
/**
|
|
219
|
+
* Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
|
|
220
|
+
*/
|
|
221
|
+
updateStorageVirtualMachine(callback?: (err: AWSError, data: FSx.Types.UpdateStorageVirtualMachineResponse) => void): Request<FSx.Types.UpdateStorageVirtualMachineResponse, AWSError>;
|
|
222
|
+
/**
|
|
223
|
+
* Updates an Amazon FSx for NetApp ONTAP volume's configuration.
|
|
224
|
+
*/
|
|
225
|
+
updateVolume(params: FSx.Types.UpdateVolumeRequest, callback?: (err: AWSError, data: FSx.Types.UpdateVolumeResponse) => void): Request<FSx.Types.UpdateVolumeResponse, AWSError>;
|
|
226
|
+
/**
|
|
227
|
+
* Updates an Amazon FSx for NetApp ONTAP volume's configuration.
|
|
228
|
+
*/
|
|
229
|
+
updateVolume(callback?: (err: AWSError, data: FSx.Types.UpdateVolumeResponse) => void): Request<FSx.Types.UpdateVolumeResponse, AWSError>;
|
|
158
230
|
}
|
|
159
231
|
declare namespace FSx {
|
|
160
232
|
export type AWSAccountId = string;
|
|
@@ -164,12 +236,13 @@ declare namespace FSx {
|
|
|
164
236
|
*/
|
|
165
237
|
DomainName?: ActiveDirectoryFullyQualifiedName;
|
|
166
238
|
/**
|
|
167
|
-
* The ID of the
|
|
239
|
+
* The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.
|
|
168
240
|
*/
|
|
169
241
|
ActiveDirectoryId?: DirectoryId;
|
|
170
242
|
ResourceARN?: ResourceARN;
|
|
171
243
|
}
|
|
172
244
|
export type ActiveDirectoryFullyQualifiedName = string;
|
|
245
|
+
export type AdminPassword = string;
|
|
173
246
|
export interface AdministrativeAction {
|
|
174
247
|
AdministrativeActionType?: AdministrativeActionType;
|
|
175
248
|
/**
|
|
@@ -189,6 +262,7 @@ declare namespace FSx {
|
|
|
189
262
|
*/
|
|
190
263
|
TargetFileSystemValues?: FileSystem;
|
|
191
264
|
FailureDetails?: AdministrativeActionFailureDetails;
|
|
265
|
+
TargetVolumeValues?: Volume;
|
|
192
266
|
}
|
|
193
267
|
export interface AdministrativeActionFailureDetails {
|
|
194
268
|
/**
|
|
@@ -204,7 +278,7 @@ declare namespace FSx {
|
|
|
204
278
|
*/
|
|
205
279
|
Name?: AlternateDNSName;
|
|
206
280
|
/**
|
|
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
|
|
281
|
+
* Describes the state of the DNS alias. AVAILABLE - The DNS alias is associated with an Amazon FSx file system. CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.
|
|
208
282
|
*/
|
|
209
283
|
Lifecycle?: AliasLifecycle;
|
|
210
284
|
}
|
|
@@ -255,7 +329,7 @@ declare namespace FSx {
|
|
|
255
329
|
*/
|
|
256
330
|
CreationTime: CreationTime;
|
|
257
331
|
/**
|
|
258
|
-
* The ID of the
|
|
332
|
+
* The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
|
|
259
333
|
*/
|
|
260
334
|
KmsKeyId?: KmsKeyId;
|
|
261
335
|
/**
|
|
@@ -280,6 +354,11 @@ declare namespace FSx {
|
|
|
280
354
|
* The source Region of the backup. Specifies the Region from where this backup is copied.
|
|
281
355
|
*/
|
|
282
356
|
SourceBackupRegion?: Region;
|
|
357
|
+
/**
|
|
358
|
+
* Specifies the resource type that is backed up.
|
|
359
|
+
*/
|
|
360
|
+
ResourceType?: ResourceType;
|
|
361
|
+
Volume?: Volume;
|
|
283
362
|
}
|
|
284
363
|
export interface BackupFailureDetails {
|
|
285
364
|
/**
|
|
@@ -327,6 +406,7 @@ declare namespace FSx {
|
|
|
327
406
|
*/
|
|
328
407
|
Scope?: ReportScope;
|
|
329
408
|
}
|
|
409
|
+
export type CoolingPeriod = number;
|
|
330
410
|
export interface CopyBackupRequest {
|
|
331
411
|
ClientRequestToken?: ClientRequestToken;
|
|
332
412
|
/**
|
|
@@ -334,7 +414,7 @@ declare namespace FSx {
|
|
|
334
414
|
*/
|
|
335
415
|
SourceBackupId: SourceBackupId;
|
|
336
416
|
/**
|
|
337
|
-
* The source
|
|
417
|
+
* The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).
|
|
338
418
|
*/
|
|
339
419
|
SourceRegion?: Region;
|
|
340
420
|
KmsKeyId?: KmsKeyId;
|
|
@@ -351,15 +431,19 @@ declare namespace FSx {
|
|
|
351
431
|
/**
|
|
352
432
|
* The ID of the file system to back up.
|
|
353
433
|
*/
|
|
354
|
-
FileSystemId
|
|
434
|
+
FileSystemId?: FileSystemId;
|
|
355
435
|
/**
|
|
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
|
|
436
|
+
* (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 Command Line Interface (CLI) or an Amazon Web Services SDK.
|
|
357
437
|
*/
|
|
358
438
|
ClientRequestToken?: ClientRequestToken;
|
|
359
439
|
/**
|
|
360
440
|
* (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
441
|
*/
|
|
362
442
|
Tags?: Tags;
|
|
443
|
+
/**
|
|
444
|
+
* The ID of he FSx for NetApp ONTAP volume to back up.
|
|
445
|
+
*/
|
|
446
|
+
VolumeId?: VolumeId;
|
|
363
447
|
}
|
|
364
448
|
export interface CreateBackupResponse {
|
|
365
449
|
/**
|
|
@@ -393,7 +477,7 @@ declare namespace FSx {
|
|
|
393
477
|
export interface CreateFileSystemFromBackupRequest {
|
|
394
478
|
BackupId: BackupId;
|
|
395
479
|
/**
|
|
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
|
|
480
|
+
* 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 Command Line Interface (CLI) or an Amazon Web Services SDK.
|
|
397
481
|
*/
|
|
398
482
|
ClientRequestToken?: ClientRequestToken;
|
|
399
483
|
/**
|
|
@@ -443,7 +527,7 @@ declare namespace FSx {
|
|
|
443
527
|
*/
|
|
444
528
|
ImportedFileChunkSize?: Megabytes;
|
|
445
529
|
/**
|
|
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
|
|
530
|
+
* 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 Amazon Web Services Regions. To learn more, Encrypting Data in Transit.
|
|
447
531
|
*/
|
|
448
532
|
DeploymentType?: LustreDeploymentType;
|
|
449
533
|
/**
|
|
@@ -469,25 +553,52 @@ declare namespace FSx {
|
|
|
469
553
|
*/
|
|
470
554
|
DataCompressionType?: DataCompressionType;
|
|
471
555
|
}
|
|
556
|
+
export interface CreateFileSystemOntapConfiguration {
|
|
557
|
+
AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays;
|
|
558
|
+
DailyAutomaticBackupStartTime?: DailyTime;
|
|
559
|
+
/**
|
|
560
|
+
* Specifies the ONTAP file system deployment type to use in creating the file system.
|
|
561
|
+
*/
|
|
562
|
+
DeploymentType: OntapDeploymentType;
|
|
563
|
+
/**
|
|
564
|
+
* Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
|
|
565
|
+
*/
|
|
566
|
+
EndpointIpAddressRange?: IpAddressRange;
|
|
567
|
+
/**
|
|
568
|
+
* The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
|
|
569
|
+
*/
|
|
570
|
+
FsxAdminPassword?: AdminPassword;
|
|
571
|
+
/**
|
|
572
|
+
* The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system.
|
|
573
|
+
*/
|
|
574
|
+
DiskIopsConfiguration?: DiskIopsConfiguration;
|
|
575
|
+
PreferredSubnetId?: SubnetId;
|
|
576
|
+
/**
|
|
577
|
+
* Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
|
|
578
|
+
*/
|
|
579
|
+
RouteTableIds?: RouteTableIds;
|
|
580
|
+
ThroughputCapacity: MegabytesPerSecond;
|
|
581
|
+
WeeklyMaintenanceStartTime?: WeeklyTime;
|
|
582
|
+
}
|
|
472
583
|
export interface CreateFileSystemRequest {
|
|
473
584
|
/**
|
|
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
|
|
585
|
+
* 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 Command Line Interface (CLI) or an Amazon Web Services SDK.
|
|
475
586
|
*/
|
|
476
587
|
ClientRequestToken?: ClientRequestToken;
|
|
477
588
|
/**
|
|
478
|
-
* The type of Amazon FSx file system to create
|
|
589
|
+
* The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, and ONTAP.
|
|
479
590
|
*/
|
|
480
591
|
FileSystemType: FileSystemType;
|
|
481
592
|
/**
|
|
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).
|
|
593
|
+
* 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). For ONTAP file systems: Valid values are 1024 GiB - 196,608 GiB (192 TiB).
|
|
483
594
|
*/
|
|
484
595
|
StorageCapacity: StorageCapacity;
|
|
485
596
|
/**
|
|
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
|
|
597
|
+
* 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, Lustre, and ONTAP 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
598
|
*/
|
|
488
599
|
StorageType?: StorageType;
|
|
489
600
|
/**
|
|
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
|
|
601
|
+
* Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP 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 or OntapConfiguration > PreferredSubnetID properties. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide. For Windows SINGLE_AZ_1 and SINGLE_AZ_2 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
602
|
*/
|
|
492
603
|
SubnetIds: SubnetIds;
|
|
493
604
|
/**
|
|
@@ -504,6 +615,7 @@ declare namespace FSx {
|
|
|
504
615
|
*/
|
|
505
616
|
WindowsConfiguration?: CreateFileSystemWindowsConfiguration;
|
|
506
617
|
LustreConfiguration?: CreateFileSystemLustreConfiguration;
|
|
618
|
+
OntapConfiguration?: CreateFileSystemOntapConfiguration;
|
|
507
619
|
}
|
|
508
620
|
export interface CreateFileSystemResponse {
|
|
509
621
|
/**
|
|
@@ -513,16 +625,16 @@ declare namespace FSx {
|
|
|
513
625
|
}
|
|
514
626
|
export interface CreateFileSystemWindowsConfiguration {
|
|
515
627
|
/**
|
|
516
|
-
* The ID for an existing
|
|
628
|
+
* The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
|
|
517
629
|
*/
|
|
518
630
|
ActiveDirectoryId?: DirectoryId;
|
|
519
631
|
SelfManagedActiveDirectoryConfiguration?: SelfManagedActiveDirectoryConfiguration;
|
|
520
632
|
/**
|
|
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
|
|
633
|
+
* Specifies the file system deployment type, valid values are the following: MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy. SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type. For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.
|
|
522
634
|
*/
|
|
523
635
|
DeploymentType?: WindowsDeploymentType;
|
|
524
636
|
/**
|
|
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-
|
|
637
|
+
* Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.
|
|
526
638
|
*/
|
|
527
639
|
PreferredSubnetId?: SubnetId;
|
|
528
640
|
/**
|
|
@@ -554,6 +666,104 @@ declare namespace FSx {
|
|
|
554
666
|
*/
|
|
555
667
|
AuditLogConfiguration?: WindowsAuditLogCreateConfiguration;
|
|
556
668
|
}
|
|
669
|
+
export interface CreateOntapVolumeConfiguration {
|
|
670
|
+
/**
|
|
671
|
+
* Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
|
|
672
|
+
*/
|
|
673
|
+
JunctionPath: JunctionPath;
|
|
674
|
+
/**
|
|
675
|
+
* The security style for the volume. Specify one of the following values: UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. UNIX is the default. NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
|
|
676
|
+
*/
|
|
677
|
+
SecurityStyle?: SecurityStyle;
|
|
678
|
+
/**
|
|
679
|
+
* Specifies the size of the volume, in megabytes (MB), that you are creating.
|
|
680
|
+
*/
|
|
681
|
+
SizeInMegabytes: VolumeCapacity;
|
|
682
|
+
/**
|
|
683
|
+
* Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
|
|
684
|
+
*/
|
|
685
|
+
StorageEfficiencyEnabled: Flag;
|
|
686
|
+
/**
|
|
687
|
+
* Specifies the ONTAP SVM in which to create the volume.
|
|
688
|
+
*/
|
|
689
|
+
StorageVirtualMachineId: StorageVirtualMachineId;
|
|
690
|
+
TieringPolicy?: TieringPolicy;
|
|
691
|
+
}
|
|
692
|
+
export interface CreateStorageVirtualMachineRequest {
|
|
693
|
+
/**
|
|
694
|
+
* Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS client accessing the file system.
|
|
695
|
+
*/
|
|
696
|
+
ActiveDirectoryConfiguration?: CreateSvmActiveDirectoryConfiguration;
|
|
697
|
+
ClientRequestToken?: ClientRequestToken;
|
|
698
|
+
FileSystemId: FileSystemId;
|
|
699
|
+
/**
|
|
700
|
+
* The name of the SVM.
|
|
701
|
+
*/
|
|
702
|
+
Name: StorageVirtualMachineName;
|
|
703
|
+
/**
|
|
704
|
+
* The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM.
|
|
705
|
+
*/
|
|
706
|
+
SvmAdminPassword?: AdminPassword;
|
|
707
|
+
Tags?: Tags;
|
|
708
|
+
/**
|
|
709
|
+
* The security style of the root volume of the SVM. Specify one of the following values: UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
|
|
710
|
+
*/
|
|
711
|
+
RootVolumeSecurityStyle?: StorageVirtualMachineRootVolumeSecurityStyle;
|
|
712
|
+
}
|
|
713
|
+
export interface CreateStorageVirtualMachineResponse {
|
|
714
|
+
/**
|
|
715
|
+
* Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.
|
|
716
|
+
*/
|
|
717
|
+
StorageVirtualMachine?: StorageVirtualMachine;
|
|
718
|
+
}
|
|
719
|
+
export interface CreateSvmActiveDirectoryConfiguration {
|
|
720
|
+
/**
|
|
721
|
+
* The NetBIOS name of the Active Directory computer object that will be created for your SVM.
|
|
722
|
+
*/
|
|
723
|
+
NetBiosName: NetBiosAlias;
|
|
724
|
+
SelfManagedActiveDirectoryConfiguration?: SelfManagedActiveDirectoryConfiguration;
|
|
725
|
+
}
|
|
726
|
+
export interface CreateVolumeFromBackupRequest {
|
|
727
|
+
BackupId: BackupId;
|
|
728
|
+
ClientRequestToken?: ClientRequestToken;
|
|
729
|
+
/**
|
|
730
|
+
* The name of the new volume you're creating.
|
|
731
|
+
*/
|
|
732
|
+
Name: VolumeName;
|
|
733
|
+
/**
|
|
734
|
+
* Specifies the configuration of the ONTAP volume that you are creating.
|
|
735
|
+
*/
|
|
736
|
+
OntapConfiguration?: CreateOntapVolumeConfiguration;
|
|
737
|
+
Tags?: Tags;
|
|
738
|
+
}
|
|
739
|
+
export interface CreateVolumeFromBackupResponse {
|
|
740
|
+
/**
|
|
741
|
+
* Returned after a successful CreateVolumeFromBackup API operation, describing the volume just created.
|
|
742
|
+
*/
|
|
743
|
+
Volume?: Volume;
|
|
744
|
+
}
|
|
745
|
+
export interface CreateVolumeRequest {
|
|
746
|
+
ClientRequestToken?: ClientRequestToken;
|
|
747
|
+
/**
|
|
748
|
+
* Specifies the type of volume to create; ONTAP is the only valid volume type.
|
|
749
|
+
*/
|
|
750
|
+
VolumeType: VolumeType;
|
|
751
|
+
/**
|
|
752
|
+
* Specifies the name of the volume you're creating.
|
|
753
|
+
*/
|
|
754
|
+
Name: VolumeName;
|
|
755
|
+
/**
|
|
756
|
+
* Specifies the ONTAP configuration to use in creating the volume.
|
|
757
|
+
*/
|
|
758
|
+
OntapConfiguration?: CreateOntapVolumeConfiguration;
|
|
759
|
+
Tags?: Tags;
|
|
760
|
+
}
|
|
761
|
+
export interface CreateVolumeResponse {
|
|
762
|
+
/**
|
|
763
|
+
* Returned after a successful CreateVolume API operation, describing the volume just created.
|
|
764
|
+
*/
|
|
765
|
+
Volume?: Volume;
|
|
766
|
+
}
|
|
557
767
|
export type CreationTime = Date;
|
|
558
768
|
export type DNSName = string;
|
|
559
769
|
export type DailyTime = string;
|
|
@@ -670,7 +880,7 @@ declare namespace FSx {
|
|
|
670
880
|
*/
|
|
671
881
|
BackupId: BackupId;
|
|
672
882
|
/**
|
|
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
|
|
883
|
+
* 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 CLI or SDK.
|
|
674
884
|
*/
|
|
675
885
|
ClientRequestToken?: ClientRequestToken;
|
|
676
886
|
}
|
|
@@ -710,7 +920,7 @@ declare namespace FSx {
|
|
|
710
920
|
*/
|
|
711
921
|
FileSystemId: FileSystemId;
|
|
712
922
|
/**
|
|
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
|
|
923
|
+
* 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 Command Line Interface (CLI) or an Amazon Web Services SDK.
|
|
714
924
|
*/
|
|
715
925
|
ClientRequestToken?: ClientRequestToken;
|
|
716
926
|
WindowsConfiguration?: DeleteFileSystemWindowsConfiguration;
|
|
@@ -748,13 +958,66 @@ declare namespace FSx {
|
|
|
748
958
|
*/
|
|
749
959
|
FinalBackupTags?: Tags;
|
|
750
960
|
}
|
|
961
|
+
export interface DeleteStorageVirtualMachineRequest {
|
|
962
|
+
ClientRequestToken?: ClientRequestToken;
|
|
963
|
+
/**
|
|
964
|
+
* The ID of the SVM that you want to delete.
|
|
965
|
+
*/
|
|
966
|
+
StorageVirtualMachineId: StorageVirtualMachineId;
|
|
967
|
+
}
|
|
968
|
+
export interface DeleteStorageVirtualMachineResponse {
|
|
969
|
+
/**
|
|
970
|
+
* The ID of the SVM Amazon FSx is deleting.
|
|
971
|
+
*/
|
|
972
|
+
StorageVirtualMachineId?: StorageVirtualMachineId;
|
|
973
|
+
/**
|
|
974
|
+
* Describes the lifecycle state of the SVM being deleted.
|
|
975
|
+
*/
|
|
976
|
+
Lifecycle?: StorageVirtualMachineLifecycle;
|
|
977
|
+
}
|
|
978
|
+
export interface DeleteVolumeOntapConfiguration {
|
|
979
|
+
/**
|
|
980
|
+
* Set to true if you want to skip taking a final backup of the volume you are deleting.
|
|
981
|
+
*/
|
|
982
|
+
SkipFinalBackup?: Flag;
|
|
983
|
+
FinalBackupTags?: Tags;
|
|
984
|
+
}
|
|
985
|
+
export interface DeleteVolumeOntapResponse {
|
|
986
|
+
FinalBackupId?: BackupId;
|
|
987
|
+
FinalBackupTags?: Tags;
|
|
988
|
+
}
|
|
989
|
+
export interface DeleteVolumeRequest {
|
|
990
|
+
ClientRequestToken?: ClientRequestToken;
|
|
991
|
+
/**
|
|
992
|
+
* The ID of the volume you are deleting.
|
|
993
|
+
*/
|
|
994
|
+
VolumeId: VolumeId;
|
|
995
|
+
/**
|
|
996
|
+
* For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume, and apply tags to the backup.
|
|
997
|
+
*/
|
|
998
|
+
OntapConfiguration?: DeleteVolumeOntapConfiguration;
|
|
999
|
+
}
|
|
1000
|
+
export interface DeleteVolumeResponse {
|
|
1001
|
+
/**
|
|
1002
|
+
* The ID of the volume being deleted.
|
|
1003
|
+
*/
|
|
1004
|
+
VolumeId?: VolumeId;
|
|
1005
|
+
/**
|
|
1006
|
+
* Describes the lifecycle state of the volume being deleted.
|
|
1007
|
+
*/
|
|
1008
|
+
Lifecycle?: VolumeLifecycle;
|
|
1009
|
+
/**
|
|
1010
|
+
* Returned after a DeleteVolume request, showing the status of the delete request.
|
|
1011
|
+
*/
|
|
1012
|
+
OntapResponse?: DeleteVolumeOntapResponse;
|
|
1013
|
+
}
|
|
751
1014
|
export interface DescribeBackupsRequest {
|
|
752
1015
|
/**
|
|
753
1016
|
* IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.
|
|
754
1017
|
*/
|
|
755
1018
|
BackupIds?: BackupIds;
|
|
756
1019
|
/**
|
|
757
|
-
* Filters structure. Supported names are file-system-id and
|
|
1020
|
+
* Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.
|
|
758
1021
|
*/
|
|
759
1022
|
Filters?: Filters;
|
|
760
1023
|
/**
|
|
@@ -844,6 +1107,44 @@ declare namespace FSx {
|
|
|
844
1107
|
*/
|
|
845
1108
|
NextToken?: NextToken;
|
|
846
1109
|
}
|
|
1110
|
+
export interface DescribeStorageVirtualMachinesRequest {
|
|
1111
|
+
/**
|
|
1112
|
+
* Enter the ID of one or more SVMs that you want to view.
|
|
1113
|
+
*/
|
|
1114
|
+
StorageVirtualMachineIds?: StorageVirtualMachineIds;
|
|
1115
|
+
/**
|
|
1116
|
+
* Enter a filter name:value pair to view a select set of SVMs.
|
|
1117
|
+
*/
|
|
1118
|
+
Filters?: StorageVirtualMachineFilters;
|
|
1119
|
+
MaxResults?: MaxResults;
|
|
1120
|
+
NextToken?: NextToken;
|
|
1121
|
+
}
|
|
1122
|
+
export interface DescribeStorageVirtualMachinesResponse {
|
|
1123
|
+
/**
|
|
1124
|
+
* Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.
|
|
1125
|
+
*/
|
|
1126
|
+
StorageVirtualMachines?: StorageVirtualMachines;
|
|
1127
|
+
NextToken?: NextToken;
|
|
1128
|
+
}
|
|
1129
|
+
export interface DescribeVolumesRequest {
|
|
1130
|
+
/**
|
|
1131
|
+
* IDs of the volumes whose descriptions you want to retrieve.
|
|
1132
|
+
*/
|
|
1133
|
+
VolumeIds?: VolumeIds;
|
|
1134
|
+
/**
|
|
1135
|
+
* Enter a filter name:value pair to view a select set of volumes.
|
|
1136
|
+
*/
|
|
1137
|
+
Filters?: VolumeFilters;
|
|
1138
|
+
MaxResults?: MaxResults;
|
|
1139
|
+
NextToken?: NextToken;
|
|
1140
|
+
}
|
|
1141
|
+
export interface DescribeVolumesResponse {
|
|
1142
|
+
/**
|
|
1143
|
+
* Returned after a successful DescribeVolumes operation, describing each volume.
|
|
1144
|
+
*/
|
|
1145
|
+
Volumes?: Volumes;
|
|
1146
|
+
NextToken?: NextToken;
|
|
1147
|
+
}
|
|
847
1148
|
export type DirectoryId = string;
|
|
848
1149
|
export type DirectoryPassword = string;
|
|
849
1150
|
export type DirectoryUserName = string;
|
|
@@ -864,6 +1165,17 @@ declare namespace FSx {
|
|
|
864
1165
|
*/
|
|
865
1166
|
Aliases?: Aliases;
|
|
866
1167
|
}
|
|
1168
|
+
export interface DiskIopsConfiguration {
|
|
1169
|
+
/**
|
|
1170
|
+
* Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC) or was provisioned by the customer (USER_PROVISIONED).
|
|
1171
|
+
*/
|
|
1172
|
+
Mode?: DiskIopsConfigurationMode;
|
|
1173
|
+
/**
|
|
1174
|
+
* The total number of SSD IOPS provisioned for the file system.
|
|
1175
|
+
*/
|
|
1176
|
+
Iops?: Iops;
|
|
1177
|
+
}
|
|
1178
|
+
export type DiskIopsConfigurationMode = "AUTOMATIC"|"USER_PROVISIONED"|string;
|
|
867
1179
|
export type DnsIps = IpAddress[];
|
|
868
1180
|
export type DriveCacheType = "NONE"|"READ"|string;
|
|
869
1181
|
export type EndTime = Date;
|
|
@@ -871,7 +1183,7 @@ declare namespace FSx {
|
|
|
871
1183
|
export type FailedCount = number;
|
|
872
1184
|
export interface FileSystem {
|
|
873
1185
|
/**
|
|
874
|
-
* The
|
|
1186
|
+
* The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.
|
|
875
1187
|
*/
|
|
876
1188
|
OwnerId?: AWSAccountId;
|
|
877
1189
|
/**
|
|
@@ -883,7 +1195,7 @@ declare namespace FSx {
|
|
|
883
1195
|
*/
|
|
884
1196
|
FileSystemId?: FileSystemId;
|
|
885
1197
|
/**
|
|
886
|
-
* The type of Amazon FSx file system,
|
|
1198
|
+
* The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, or ONTAP.
|
|
887
1199
|
*/
|
|
888
1200
|
FileSystemType?: FileSystemType;
|
|
889
1201
|
/**
|
|
@@ -904,7 +1216,7 @@ declare namespace FSx {
|
|
|
904
1216
|
*/
|
|
905
1217
|
VpcId?: VpcId;
|
|
906
1218
|
/**
|
|
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.
|
|
1219
|
+
* Specifies the IDs of the subnets that the file system is accessible from. For Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID. For 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 and ONTAP file systems, the endpoint for the file system is available in the PreferredSubnetID.
|
|
908
1220
|
*/
|
|
909
1221
|
SubnetIds?: SubnetIds;
|
|
910
1222
|
/**
|
|
@@ -916,7 +1228,7 @@ declare namespace FSx {
|
|
|
916
1228
|
*/
|
|
917
1229
|
DNSName?: DNSName;
|
|
918
1230
|
/**
|
|
919
|
-
* The ID of the
|
|
1231
|
+
* The ID of the Key Management Service (KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and persistent Amazon FSx for Lustre file systems at rest. 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 Key Management Service API Reference.
|
|
920
1232
|
*/
|
|
921
1233
|
KmsKeyId?: KmsKeyId;
|
|
922
1234
|
/**
|
|
@@ -933,11 +1245,32 @@ declare namespace FSx {
|
|
|
933
1245
|
WindowsConfiguration?: WindowsFileSystemConfiguration;
|
|
934
1246
|
LustreConfiguration?: LustreFileSystemConfiguration;
|
|
935
1247
|
/**
|
|
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
|
|
1248
|
+
* A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx file system that you have initiated using the UpdateFileSystem action.
|
|
937
1249
|
*/
|
|
938
1250
|
AdministrativeActions?: AdministrativeActions;
|
|
1251
|
+
/**
|
|
1252
|
+
* The configuration for this FSx for NetApp ONTAP file system.
|
|
1253
|
+
*/
|
|
1254
|
+
OntapConfiguration?: OntapFileSystemConfiguration;
|
|
939
1255
|
}
|
|
940
1256
|
export type FileSystemAdministratorsGroupName = string;
|
|
1257
|
+
export interface FileSystemEndpoint {
|
|
1258
|
+
DNSName?: DNSName;
|
|
1259
|
+
/**
|
|
1260
|
+
* IP addresses of the file system endpoint.
|
|
1261
|
+
*/
|
|
1262
|
+
IpAddresses?: OntapEndpointIpAddresses;
|
|
1263
|
+
}
|
|
1264
|
+
export interface FileSystemEndpoints {
|
|
1265
|
+
/**
|
|
1266
|
+
* An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
|
|
1267
|
+
*/
|
|
1268
|
+
Intercluster?: FileSystemEndpoint;
|
|
1269
|
+
/**
|
|
1270
|
+
* An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
|
|
1271
|
+
*/
|
|
1272
|
+
Management?: FileSystemEndpoint;
|
|
1273
|
+
}
|
|
941
1274
|
export interface FileSystemFailureDetails {
|
|
942
1275
|
/**
|
|
943
1276
|
* A message describing any failures that occurred during file system creation.
|
|
@@ -949,7 +1282,7 @@ declare namespace FSx {
|
|
|
949
1282
|
export type FileSystemLifecycle = "AVAILABLE"|"CREATING"|"FAILED"|"DELETING"|"MISCONFIGURED"|"UPDATING"|string;
|
|
950
1283
|
export type FileSystemMaintenanceOperation = "PATCHING"|"BACKING_UP"|string;
|
|
951
1284
|
export type FileSystemMaintenanceOperations = FileSystemMaintenanceOperation[];
|
|
952
|
-
export type FileSystemType = "WINDOWS"|"LUSTRE"|string;
|
|
1285
|
+
export type FileSystemType = "WINDOWS"|"LUSTRE"|"ONTAP"|string;
|
|
953
1286
|
export type FileSystems = FileSystem[];
|
|
954
1287
|
export interface Filter {
|
|
955
1288
|
/**
|
|
@@ -961,15 +1294,22 @@ declare namespace FSx {
|
|
|
961
1294
|
*/
|
|
962
1295
|
Values?: FilterValues;
|
|
963
1296
|
}
|
|
964
|
-
export type FilterName = "file-system-id"|"backup-type"|"file-system-type"|string;
|
|
1297
|
+
export type FilterName = "file-system-id"|"backup-type"|"file-system-type"|"volume-id"|string;
|
|
965
1298
|
export type FilterValue = string;
|
|
966
1299
|
export type FilterValues = FilterValue[];
|
|
967
1300
|
export type Filters = Filter[];
|
|
968
1301
|
export type Flag = boolean;
|
|
1302
|
+
export type FlexCacheEndpointType = "NONE"|"ORIGIN"|"CACHE"|string;
|
|
969
1303
|
export type GeneralARN = string;
|
|
1304
|
+
export type Iops = number;
|
|
970
1305
|
export type IpAddress = string;
|
|
1306
|
+
export type IpAddressRange = string;
|
|
1307
|
+
export type JunctionPath = string;
|
|
971
1308
|
export type KmsKeyId = string;
|
|
972
1309
|
export type LastUpdatedTime = Date;
|
|
1310
|
+
export interface LifecycleTransitionReason {
|
|
1311
|
+
Message?: ErrorMessage;
|
|
1312
|
+
}
|
|
973
1313
|
export interface ListTagsForResourceRequest {
|
|
974
1314
|
/**
|
|
975
1315
|
* The ARN of the Amazon FSx resource that will have its tags listed.
|
|
@@ -1010,7 +1350,7 @@ declare namespace FSx {
|
|
|
1010
1350
|
*/
|
|
1011
1351
|
PerUnitStorageThroughput?: PerUnitStorageThroughput;
|
|
1012
1352
|
/**
|
|
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
|
|
1353
|
+
* 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 Amazon Web Services Region.
|
|
1014
1354
|
*/
|
|
1015
1355
|
MountName?: LustreFileSystemMountName;
|
|
1016
1356
|
DailyAutomaticBackupStartTime?: DailyTime;
|
|
@@ -1032,9 +1372,82 @@ declare namespace FSx {
|
|
|
1032
1372
|
export type MaxResults = number;
|
|
1033
1373
|
export type Megabytes = number;
|
|
1034
1374
|
export type MegabytesPerSecond = number;
|
|
1375
|
+
export type NetBiosAlias = string;
|
|
1035
1376
|
export type NetworkInterfaceId = string;
|
|
1036
1377
|
export type NetworkInterfaceIds = NetworkInterfaceId[];
|
|
1037
1378
|
export type NextToken = string;
|
|
1379
|
+
export type OntapDeploymentType = "MULTI_AZ_1"|string;
|
|
1380
|
+
export type OntapEndpointIpAddresses = IpAddress[];
|
|
1381
|
+
export interface OntapFileSystemConfiguration {
|
|
1382
|
+
AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays;
|
|
1383
|
+
DailyAutomaticBackupStartTime?: DailyTime;
|
|
1384
|
+
/**
|
|
1385
|
+
* The ONTAP file system deployment type.
|
|
1386
|
+
*/
|
|
1387
|
+
DeploymentType?: OntapDeploymentType;
|
|
1388
|
+
/**
|
|
1389
|
+
* The IP address range in which the endpoints to access your file system are created.
|
|
1390
|
+
*/
|
|
1391
|
+
EndpointIpAddressRange?: IpAddressRange;
|
|
1392
|
+
/**
|
|
1393
|
+
* The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
|
|
1394
|
+
*/
|
|
1395
|
+
Endpoints?: FileSystemEndpoints;
|
|
1396
|
+
/**
|
|
1397
|
+
* The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
|
|
1398
|
+
*/
|
|
1399
|
+
DiskIopsConfiguration?: DiskIopsConfiguration;
|
|
1400
|
+
PreferredSubnetId?: SubnetId;
|
|
1401
|
+
/**
|
|
1402
|
+
* The VPC route tables in which your file system's endpoints are created.
|
|
1403
|
+
*/
|
|
1404
|
+
RouteTableIds?: RouteTableIds;
|
|
1405
|
+
ThroughputCapacity?: MegabytesPerSecond;
|
|
1406
|
+
WeeklyMaintenanceStartTime?: WeeklyTime;
|
|
1407
|
+
}
|
|
1408
|
+
export interface OntapVolumeConfiguration {
|
|
1409
|
+
/**
|
|
1410
|
+
* Specifies the FlexCache endpoint type of the volume. Valid values are the following: NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default. ORIGIN specifies that the volume is the origin volume for a FlexCache volume. CACHE specifies that the volume is a FlexCache volume.
|
|
1411
|
+
*/
|
|
1412
|
+
FlexCacheEndpointType?: FlexCacheEndpointType;
|
|
1413
|
+
/**
|
|
1414
|
+
* Specifies the directory that NAS clients use to mount the volume, along with the SVM DNS name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3..
|
|
1415
|
+
*/
|
|
1416
|
+
JunctionPath?: JunctionPath;
|
|
1417
|
+
/**
|
|
1418
|
+
* The security style for the volume, which can be UNIX, NTFS, or MIXED.
|
|
1419
|
+
*/
|
|
1420
|
+
SecurityStyle?: SecurityStyle;
|
|
1421
|
+
/**
|
|
1422
|
+
* The configured size of the volume, in megabytes (MBs).
|
|
1423
|
+
*/
|
|
1424
|
+
SizeInMegabytes?: VolumeCapacity;
|
|
1425
|
+
/**
|
|
1426
|
+
* The volume's storage efficiency setting.
|
|
1427
|
+
*/
|
|
1428
|
+
StorageEfficiencyEnabled?: Flag;
|
|
1429
|
+
/**
|
|
1430
|
+
* The ID of the volume's storage virtual machine.
|
|
1431
|
+
*/
|
|
1432
|
+
StorageVirtualMachineId?: StorageVirtualMachineId;
|
|
1433
|
+
/**
|
|
1434
|
+
* A boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume. This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
|
|
1435
|
+
*/
|
|
1436
|
+
StorageVirtualMachineRoot?: Flag;
|
|
1437
|
+
/**
|
|
1438
|
+
* The volume's TieringPolicy setting.
|
|
1439
|
+
*/
|
|
1440
|
+
TieringPolicy?: TieringPolicy;
|
|
1441
|
+
/**
|
|
1442
|
+
* The volume's UUID (universally unique identifier).
|
|
1443
|
+
*/
|
|
1444
|
+
UUID?: UUID;
|
|
1445
|
+
/**
|
|
1446
|
+
* Specifies the type of volume. Valid values are the following: RW specifies a read-write volume. RW is the default. DP specifies a data protection volume. You can protect data by replicating it to data protection mirror copies and use data protection mirror copies to recover data when a disaster occurs. LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
|
|
1447
|
+
*/
|
|
1448
|
+
OntapVolumeType?: OntapVolumeType;
|
|
1449
|
+
}
|
|
1450
|
+
export type OntapVolumeType = "RW"|"DP"|"LS"|string;
|
|
1038
1451
|
export type OrganizationalUnitDistinguishedName = string;
|
|
1039
1452
|
export type PerUnitStorageThroughput = number;
|
|
1040
1453
|
export type ProgressPercent = number;
|
|
@@ -1043,15 +1456,19 @@ declare namespace FSx {
|
|
|
1043
1456
|
export type ReportScope = "FAILED_FILES_ONLY"|string;
|
|
1044
1457
|
export type RequestTime = Date;
|
|
1045
1458
|
export type ResourceARN = string;
|
|
1459
|
+
export type ResourceType = "FILE_SYSTEM"|"VOLUME"|string;
|
|
1460
|
+
export type RouteTableId = string;
|
|
1461
|
+
export type RouteTableIds = RouteTableId[];
|
|
1046
1462
|
export type SecurityGroupId = string;
|
|
1047
1463
|
export type SecurityGroupIds = SecurityGroupId[];
|
|
1464
|
+
export type SecurityStyle = "UNIX"|"NTFS"|"MIXED"|string;
|
|
1048
1465
|
export interface SelfManagedActiveDirectoryAttributes {
|
|
1049
1466
|
/**
|
|
1050
1467
|
* The fully qualified domain name of the self-managed AD directory.
|
|
1051
1468
|
*/
|
|
1052
1469
|
DomainName?: ActiveDirectoryFullyQualifiedName;
|
|
1053
1470
|
/**
|
|
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.
|
|
1471
|
+
* The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
|
|
1055
1472
|
*/
|
|
1056
1473
|
OrganizationalUnitDistinguishedName?: OrganizationalUnitDistinguishedName;
|
|
1057
1474
|
/**
|
|
@@ -1073,7 +1490,7 @@ declare namespace FSx {
|
|
|
1073
1490
|
*/
|
|
1074
1491
|
DomainName: ActiveDirectoryFullyQualifiedName;
|
|
1075
1492
|
/**
|
|
1076
|
-
* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory
|
|
1493
|
+
* (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory. Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
|
|
1077
1494
|
*/
|
|
1078
1495
|
OrganizationalUnitDistinguishedName?: OrganizationalUnitDistinguishedName;
|
|
1079
1496
|
/**
|
|
@@ -1112,9 +1529,104 @@ declare namespace FSx {
|
|
|
1112
1529
|
export type Status = "FAILED"|"IN_PROGRESS"|"PENDING"|"COMPLETED"|"UPDATED_OPTIMIZING"|string;
|
|
1113
1530
|
export type StorageCapacity = number;
|
|
1114
1531
|
export type StorageType = "SSD"|"HDD"|string;
|
|
1532
|
+
export interface StorageVirtualMachine {
|
|
1533
|
+
/**
|
|
1534
|
+
* Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
|
|
1535
|
+
*/
|
|
1536
|
+
ActiveDirectoryConfiguration?: SvmActiveDirectoryConfiguration;
|
|
1537
|
+
CreationTime?: CreationTime;
|
|
1538
|
+
/**
|
|
1539
|
+
* The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.
|
|
1540
|
+
*/
|
|
1541
|
+
Endpoints?: SvmEndpoints;
|
|
1542
|
+
FileSystemId?: FileSystemId;
|
|
1543
|
+
/**
|
|
1544
|
+
* Describes the SVM's lifecycle status. CREATED - The SVM is fully available for use. CREATING - Amazon FSx is creating the new SVM. DELETING - Amazon FSx is deleting an existing SVM. FAILED - Amazon FSx was unable to create the SVM. MISCONFIGURED - The SVM is in a failed but recoverable state. PENDING - Amazon FSx has not started creating the SVM.
|
|
1545
|
+
*/
|
|
1546
|
+
Lifecycle?: StorageVirtualMachineLifecycle;
|
|
1547
|
+
/**
|
|
1548
|
+
* The name of the SVM, if provisioned.
|
|
1549
|
+
*/
|
|
1550
|
+
Name?: StorageVirtualMachineName;
|
|
1551
|
+
ResourceARN?: ResourceARN;
|
|
1552
|
+
/**
|
|
1553
|
+
* The SVM's system generated unique ID.
|
|
1554
|
+
*/
|
|
1555
|
+
StorageVirtualMachineId?: StorageVirtualMachineId;
|
|
1556
|
+
/**
|
|
1557
|
+
* Describes the SVM's subtype.
|
|
1558
|
+
*/
|
|
1559
|
+
Subtype?: StorageVirtualMachineSubtype;
|
|
1560
|
+
/**
|
|
1561
|
+
* The SVM's UUID (universally unique identifier).
|
|
1562
|
+
*/
|
|
1563
|
+
UUID?: UUID;
|
|
1564
|
+
Tags?: Tags;
|
|
1565
|
+
/**
|
|
1566
|
+
* Describes why the SVM lifecycle state changed.
|
|
1567
|
+
*/
|
|
1568
|
+
LifecycleTransitionReason?: LifecycleTransitionReason;
|
|
1569
|
+
/**
|
|
1570
|
+
* The security style of the root volume of the SVM.
|
|
1571
|
+
*/
|
|
1572
|
+
RootVolumeSecurityStyle?: StorageVirtualMachineRootVolumeSecurityStyle;
|
|
1573
|
+
}
|
|
1574
|
+
export interface StorageVirtualMachineFilter {
|
|
1575
|
+
/**
|
|
1576
|
+
* The name for this filter.
|
|
1577
|
+
*/
|
|
1578
|
+
Name?: StorageVirtualMachineFilterName;
|
|
1579
|
+
/**
|
|
1580
|
+
* The values of the filter. These are all the values for any of the applied filters.
|
|
1581
|
+
*/
|
|
1582
|
+
Values?: StorageVirtualMachineFilterValues;
|
|
1583
|
+
}
|
|
1584
|
+
export type StorageVirtualMachineFilterName = "file-system-id"|string;
|
|
1585
|
+
export type StorageVirtualMachineFilterValue = string;
|
|
1586
|
+
export type StorageVirtualMachineFilterValues = StorageVirtualMachineFilterValue[];
|
|
1587
|
+
export type StorageVirtualMachineFilters = StorageVirtualMachineFilter[];
|
|
1588
|
+
export type StorageVirtualMachineId = string;
|
|
1589
|
+
export type StorageVirtualMachineIds = StorageVirtualMachineId[];
|
|
1590
|
+
export type StorageVirtualMachineLifecycle = "CREATED"|"CREATING"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING"|string;
|
|
1591
|
+
export type StorageVirtualMachineName = string;
|
|
1592
|
+
export type StorageVirtualMachineRootVolumeSecurityStyle = "UNIX"|"NTFS"|"MIXED"|string;
|
|
1593
|
+
export type StorageVirtualMachineSubtype = "DEFAULT"|"DP_DESTINATION"|"SYNC_DESTINATION"|"SYNC_SOURCE"|string;
|
|
1594
|
+
export type StorageVirtualMachines = StorageVirtualMachine[];
|
|
1115
1595
|
export type SubnetId = string;
|
|
1116
1596
|
export type SubnetIds = SubnetId[];
|
|
1117
1597
|
export type SucceededCount = number;
|
|
1598
|
+
export interface SvmActiveDirectoryConfiguration {
|
|
1599
|
+
/**
|
|
1600
|
+
* The NetBIOS name of the Active Directory computer object that is joined to your SVM.
|
|
1601
|
+
*/
|
|
1602
|
+
NetBiosName?: NetBiosAlias;
|
|
1603
|
+
SelfManagedActiveDirectoryConfiguration?: SelfManagedActiveDirectoryAttributes;
|
|
1604
|
+
}
|
|
1605
|
+
export interface SvmEndpoint {
|
|
1606
|
+
DNSName?: DNSName;
|
|
1607
|
+
/**
|
|
1608
|
+
* The SVM endpoint's IP addresses.
|
|
1609
|
+
*/
|
|
1610
|
+
IpAddresses?: OntapEndpointIpAddresses;
|
|
1611
|
+
}
|
|
1612
|
+
export interface SvmEndpoints {
|
|
1613
|
+
/**
|
|
1614
|
+
* An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
|
|
1615
|
+
*/
|
|
1616
|
+
Iscsi?: SvmEndpoint;
|
|
1617
|
+
/**
|
|
1618
|
+
* An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
|
|
1619
|
+
*/
|
|
1620
|
+
Management?: SvmEndpoint;
|
|
1621
|
+
/**
|
|
1622
|
+
* An endpoint for connecting using the Network File System (NFS) protocol.
|
|
1623
|
+
*/
|
|
1624
|
+
Nfs?: SvmEndpoint;
|
|
1625
|
+
/**
|
|
1626
|
+
* An endpoint for connecting using the Server Message Block (SMB) protocol.
|
|
1627
|
+
*/
|
|
1628
|
+
Smb?: SvmEndpoint;
|
|
1629
|
+
}
|
|
1118
1630
|
export interface Tag {
|
|
1119
1631
|
/**
|
|
1120
1632
|
* A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.
|
|
@@ -1143,7 +1655,19 @@ declare namespace FSx {
|
|
|
1143
1655
|
export type Tags = Tag[];
|
|
1144
1656
|
export type TaskId = string;
|
|
1145
1657
|
export type TaskIds = TaskId[];
|
|
1658
|
+
export interface TieringPolicy {
|
|
1659
|
+
/**
|
|
1660
|
+
* Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
|
|
1661
|
+
*/
|
|
1662
|
+
CoolingPeriod?: CoolingPeriod;
|
|
1663
|
+
/**
|
|
1664
|
+
* Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY. SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier. AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns. ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier. NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
|
|
1665
|
+
*/
|
|
1666
|
+
Name?: TieringPolicyName;
|
|
1667
|
+
}
|
|
1668
|
+
export type TieringPolicyName = "SNAPSHOT_ONLY"|"AUTO"|"ALL"|"NONE"|string;
|
|
1146
1669
|
export type TotalCount = number;
|
|
1670
|
+
export type UUID = string;
|
|
1147
1671
|
export interface UntagResourceRequest {
|
|
1148
1672
|
/**
|
|
1149
1673
|
* The ARN of the Amazon FSx resource to untag.
|
|
@@ -1172,17 +1696,26 @@ declare namespace FSx {
|
|
|
1172
1696
|
*/
|
|
1173
1697
|
DataCompressionType?: DataCompressionType;
|
|
1174
1698
|
}
|
|
1699
|
+
export interface UpdateFileSystemOntapConfiguration {
|
|
1700
|
+
AutomaticBackupRetentionDays?: AutomaticBackupRetentionDays;
|
|
1701
|
+
DailyAutomaticBackupStartTime?: DailyTime;
|
|
1702
|
+
/**
|
|
1703
|
+
* The ONTAP administrative password for the fsxadmin user.
|
|
1704
|
+
*/
|
|
1705
|
+
FsxAdminPassword?: AdminPassword;
|
|
1706
|
+
WeeklyMaintenanceStartTime?: WeeklyTime;
|
|
1707
|
+
}
|
|
1175
1708
|
export interface UpdateFileSystemRequest {
|
|
1176
1709
|
/**
|
|
1177
1710
|
* Identifies the file system that you are updating.
|
|
1178
1711
|
*/
|
|
1179
1712
|
FileSystemId: FileSystemId;
|
|
1180
1713
|
/**
|
|
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
|
|
1714
|
+
* 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 Command Line Interface (CLI) or an Amazon Web Services SDK.
|
|
1182
1715
|
*/
|
|
1183
1716
|
ClientRequestToken?: ClientRequestToken;
|
|
1184
1717
|
/**
|
|
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.
|
|
1718
|
+
* Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre 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
1719
|
*/
|
|
1187
1720
|
StorageCapacity?: StorageCapacity;
|
|
1188
1721
|
/**
|
|
@@ -1190,6 +1723,7 @@ declare namespace FSx {
|
|
|
1190
1723
|
*/
|
|
1191
1724
|
WindowsConfiguration?: UpdateFileSystemWindowsConfiguration;
|
|
1192
1725
|
LustreConfiguration?: UpdateFileSystemLustreConfiguration;
|
|
1726
|
+
OntapConfiguration?: UpdateFileSystemOntapConfiguration;
|
|
1193
1727
|
}
|
|
1194
1728
|
export interface UpdateFileSystemResponse {
|
|
1195
1729
|
/**
|
|
@@ -1223,6 +1757,114 @@ declare namespace FSx {
|
|
|
1223
1757
|
*/
|
|
1224
1758
|
AuditLogConfiguration?: WindowsAuditLogCreateConfiguration;
|
|
1225
1759
|
}
|
|
1760
|
+
export interface UpdateOntapVolumeConfiguration {
|
|
1761
|
+
/**
|
|
1762
|
+
* Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
|
|
1763
|
+
*/
|
|
1764
|
+
JunctionPath?: JunctionPath;
|
|
1765
|
+
/**
|
|
1766
|
+
* The security style for the volume, which can be UNIX. NTFS, or MIXED.
|
|
1767
|
+
*/
|
|
1768
|
+
SecurityStyle?: SecurityStyle;
|
|
1769
|
+
/**
|
|
1770
|
+
* Specifies the size of the volume in megabytes.
|
|
1771
|
+
*/
|
|
1772
|
+
SizeInMegabytes?: VolumeCapacity;
|
|
1773
|
+
/**
|
|
1774
|
+
* Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
|
|
1775
|
+
*/
|
|
1776
|
+
StorageEfficiencyEnabled?: Flag;
|
|
1777
|
+
/**
|
|
1778
|
+
* Update the volume's data tiering policy.
|
|
1779
|
+
*/
|
|
1780
|
+
TieringPolicy?: TieringPolicy;
|
|
1781
|
+
}
|
|
1782
|
+
export interface UpdateStorageVirtualMachineRequest {
|
|
1783
|
+
/**
|
|
1784
|
+
* Updates the Microsoft Active Directory (AD) configuration for an SVM that is joined to an AD.
|
|
1785
|
+
*/
|
|
1786
|
+
ActiveDirectoryConfiguration?: UpdateSvmActiveDirectoryConfiguration;
|
|
1787
|
+
ClientRequestToken?: ClientRequestToken;
|
|
1788
|
+
/**
|
|
1789
|
+
* The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.
|
|
1790
|
+
*/
|
|
1791
|
+
StorageVirtualMachineId: StorageVirtualMachineId;
|
|
1792
|
+
/**
|
|
1793
|
+
* Enter a new SvmAdminPassword if you are updating it.
|
|
1794
|
+
*/
|
|
1795
|
+
SvmAdminPassword?: AdminPassword;
|
|
1796
|
+
}
|
|
1797
|
+
export interface UpdateStorageVirtualMachineResponse {
|
|
1798
|
+
StorageVirtualMachine?: StorageVirtualMachine;
|
|
1799
|
+
}
|
|
1800
|
+
export interface UpdateSvmActiveDirectoryConfiguration {
|
|
1801
|
+
SelfManagedActiveDirectoryConfiguration?: SelfManagedActiveDirectoryConfigurationUpdates;
|
|
1802
|
+
}
|
|
1803
|
+
export interface UpdateVolumeRequest {
|
|
1804
|
+
ClientRequestToken?: ClientRequestToken;
|
|
1805
|
+
/**
|
|
1806
|
+
* Specifies the volume that you want to update, formatted fsvol-0123456789abcdef0.
|
|
1807
|
+
*/
|
|
1808
|
+
VolumeId: VolumeId;
|
|
1809
|
+
/**
|
|
1810
|
+
* The ONTAP configuration of the volume you are updating.
|
|
1811
|
+
*/
|
|
1812
|
+
OntapConfiguration?: UpdateOntapVolumeConfiguration;
|
|
1813
|
+
}
|
|
1814
|
+
export interface UpdateVolumeResponse {
|
|
1815
|
+
/**
|
|
1816
|
+
* Returned after a successful UpdateVolume API operation, describing the volume just updated.
|
|
1817
|
+
*/
|
|
1818
|
+
Volume?: Volume;
|
|
1819
|
+
}
|
|
1820
|
+
export interface Volume {
|
|
1821
|
+
CreationTime?: CreationTime;
|
|
1822
|
+
FileSystemId?: FileSystemId;
|
|
1823
|
+
/**
|
|
1824
|
+
* The lifecycle status of the volume. CREATED - The volume is fully available for use. CREATING - Amazon FSx is creating the new volume. DELETING - Amazon FSx is deleting an existing volume. FAILED - Amazon FSx was unable to create the volume. MISCONFIGURED - The volume is in a failed but recoverable state. PENDING - Amazon FSx has not started creating the volume.
|
|
1825
|
+
*/
|
|
1826
|
+
Lifecycle?: VolumeLifecycle;
|
|
1827
|
+
/**
|
|
1828
|
+
* The name of the volume.
|
|
1829
|
+
*/
|
|
1830
|
+
Name?: VolumeName;
|
|
1831
|
+
OntapConfiguration?: OntapVolumeConfiguration;
|
|
1832
|
+
ResourceARN?: ResourceARN;
|
|
1833
|
+
Tags?: Tags;
|
|
1834
|
+
/**
|
|
1835
|
+
* The system-generated, unique ID of the volume.
|
|
1836
|
+
*/
|
|
1837
|
+
VolumeId?: VolumeId;
|
|
1838
|
+
/**
|
|
1839
|
+
* The type of volume; ONTAP is the only valid volume type.
|
|
1840
|
+
*/
|
|
1841
|
+
VolumeType?: VolumeType;
|
|
1842
|
+
/**
|
|
1843
|
+
* Describes why the volume lifecycle state changed.
|
|
1844
|
+
*/
|
|
1845
|
+
LifecycleTransitionReason?: LifecycleTransitionReason;
|
|
1846
|
+
}
|
|
1847
|
+
export type VolumeCapacity = number;
|
|
1848
|
+
export interface VolumeFilter {
|
|
1849
|
+
/**
|
|
1850
|
+
* The name for this filter.
|
|
1851
|
+
*/
|
|
1852
|
+
Name?: VolumeFilterName;
|
|
1853
|
+
/**
|
|
1854
|
+
* The values of the filter. These are all the values for any of the applied filters.
|
|
1855
|
+
*/
|
|
1856
|
+
Values?: VolumeFilterValues;
|
|
1857
|
+
}
|
|
1858
|
+
export type VolumeFilterName = "file-system-id"|"storage-virtual-machine-id"|string;
|
|
1859
|
+
export type VolumeFilterValue = string;
|
|
1860
|
+
export type VolumeFilterValues = VolumeFilterValue[];
|
|
1861
|
+
export type VolumeFilters = VolumeFilter[];
|
|
1862
|
+
export type VolumeId = string;
|
|
1863
|
+
export type VolumeIds = VolumeId[];
|
|
1864
|
+
export type VolumeLifecycle = "CREATING"|"CREATED"|"DELETING"|"FAILED"|"MISCONFIGURED"|"PENDING"|string;
|
|
1865
|
+
export type VolumeName = string;
|
|
1866
|
+
export type VolumeType = "ONTAP"|string;
|
|
1867
|
+
export type Volumes = Volume[];
|
|
1226
1868
|
export type VpcId = string;
|
|
1227
1869
|
export type WeeklyTime = string;
|
|
1228
1870
|
export type WindowsAccessAuditLogLevel = "DISABLED"|"SUCCESS_ONLY"|"FAILURE_ONLY"|"SUCCESS_AND_FAILURE"|string;
|
|
@@ -1236,7 +1878,7 @@ declare namespace FSx {
|
|
|
1236
1878
|
*/
|
|
1237
1879
|
FileShareAccessAuditLogLevel: WindowsAccessAuditLogLevel;
|
|
1238
1880
|
/**
|
|
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
|
|
1881
|
+
* 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 Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
|
|
1240
1882
|
*/
|
|
1241
1883
|
AuditLogDestination?: GeneralARN;
|
|
1242
1884
|
}
|
|
@@ -1250,14 +1892,14 @@ declare namespace FSx {
|
|
|
1250
1892
|
*/
|
|
1251
1893
|
FileShareAccessAuditLogLevel: WindowsAccessAuditLogLevel;
|
|
1252
1894
|
/**
|
|
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
|
|
1895
|
+
* The Amazon Resource Name (ARN) that specifies the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements: The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data 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
1896
|
*/
|
|
1255
1897
|
AuditLogDestination?: GeneralARN;
|
|
1256
1898
|
}
|
|
1257
1899
|
export type WindowsDeploymentType = "MULTI_AZ_1"|"SINGLE_AZ_1"|"SINGLE_AZ_2"|string;
|
|
1258
1900
|
export interface WindowsFileSystemConfiguration {
|
|
1259
1901
|
/**
|
|
1260
|
-
* The ID for an existing
|
|
1902
|
+
* The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
|
|
1261
1903
|
*/
|
|
1262
1904
|
ActiveDirectoryId?: DirectoryId;
|
|
1263
1905
|
SelfManagedActiveDirectoryConfiguration?: SelfManagedActiveDirectoryAttributes;
|