@aws-sdk/client-fsx 3.41.0 → 3.45.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 +38 -0
- package/dist-cjs/FSx.js +150 -0
- package/dist-cjs/commands/CreateDataRepositoryAssociationCommand.js +36 -0
- package/dist-cjs/commands/CreateSnapshotCommand.js +36 -0
- package/dist-cjs/commands/DeleteDataRepositoryAssociationCommand.js +36 -0
- package/dist-cjs/commands/DeleteSnapshotCommand.js +36 -0
- package/dist-cjs/commands/DescribeDataRepositoryAssociationsCommand.js +36 -0
- package/dist-cjs/commands/DescribeSnapshotsCommand.js +36 -0
- package/dist-cjs/commands/ReleaseFileSystemNfsV3LocksCommand.js +36 -0
- package/dist-cjs/commands/RestoreVolumeFromSnapshotCommand.js +36 -0
- package/dist-cjs/commands/UpdateDataRepositoryAssociationCommand.js +36 -0
- package/dist-cjs/commands/UpdateSnapshotCommand.js +36 -0
- package/dist-cjs/commands/index.js +10 -0
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +386 -44
- package/dist-cjs/pagination/DescribeDataRepositoryAssociationsPaginator.js +35 -0
- package/dist-cjs/pagination/DescribeSnapshotsPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_json1_1.js +1745 -131
- package/dist-es/FSx.js +150 -0
- package/dist-es/commands/CreateDataRepositoryAssociationCommand.js +39 -0
- package/dist-es/commands/CreateSnapshotCommand.js +39 -0
- package/dist-es/commands/DeleteDataRepositoryAssociationCommand.js +39 -0
- package/dist-es/commands/DeleteSnapshotCommand.js +39 -0
- package/dist-es/commands/DescribeDataRepositoryAssociationsCommand.js +39 -0
- package/dist-es/commands/DescribeSnapshotsCommand.js +39 -0
- package/dist-es/commands/ReleaseFileSystemNfsV3LocksCommand.js +39 -0
- package/dist-es/commands/RestoreVolumeFromSnapshotCommand.js +39 -0
- package/dist-es/commands/UpdateDataRepositoryAssociationCommand.js +39 -0
- package/dist-es/commands/UpdateSnapshotCommand.js +39 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/endpoints.js +1 -0
- package/dist-es/models/models_0.js +277 -28
- package/dist-es/pagination/DescribeDataRepositoryAssociationsPaginator.js +74 -0
- package/dist-es/pagination/DescribeSnapshotsPaginator.js +74 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +1653 -74
- package/dist-types/FSx.d.ts +406 -146
- package/dist-types/FSxClient.d.ts +12 -2
- package/dist-types/commands/CopyBackupCommand.d.ts +12 -12
- package/dist-types/commands/CreateBackupCommand.d.ts +27 -25
- package/dist-types/commands/CreateDataRepositoryAssociationCommand.d.ts +45 -0
- package/dist-types/commands/CreateDataRepositoryTaskCommand.d.ts +6 -5
- package/dist-types/commands/CreateFileSystemCommand.d.ts +36 -16
- package/dist-types/commands/CreateFileSystemFromBackupCommand.d.ts +14 -14
- package/dist-types/commands/CreateSnapshotCommand.d.ts +62 -0
- package/dist-types/commands/CreateVolumeCommand.d.ts +2 -1
- package/dist-types/commands/DeleteBackupCommand.d.ts +4 -3
- package/dist-types/commands/DeleteDataRepositoryAssociationCommand.d.ts +41 -0
- package/dist-types/commands/DeleteFileSystemCommand.d.ts +14 -15
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +39 -0
- package/dist-types/commands/DeleteVolumeCommand.d.ts +2 -4
- package/dist-types/commands/DescribeBackupsCommand.d.ts +17 -18
- package/dist-types/commands/DescribeDataRepositoryAssociationsCommand.d.ts +53 -0
- package/dist-types/commands/DescribeFileSystemsCommand.d.ts +9 -9
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +61 -0
- package/dist-types/commands/DescribeVolumesCommand.d.ts +2 -1
- package/dist-types/commands/ReleaseFileSystemNfsV3LocksCommand.d.ts +36 -0
- package/dist-types/commands/RestoreVolumeFromSnapshotCommand.d.ts +36 -0
- package/dist-types/commands/UpdateDataRepositoryAssociationCommand.d.ts +37 -0
- package/dist-types/commands/UpdateFileSystemCommand.d.ts +95 -22
- package/dist-types/commands/UpdateSnapshotCommand.d.ts +35 -0
- package/dist-types/commands/UpdateVolumeCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +2705 -649
- package/dist-types/pagination/DescribeDataRepositoryAssociationsPaginator.d.ts +4 -0
- package/dist-types/pagination/DescribeSnapshotsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +30 -0
- package/dist-types/ts3.4/FSx.d.ts +50 -0
- package/dist-types/ts3.4/FSxClient.d.ts +12 -2
- package/dist-types/ts3.4/commands/CreateDataRepositoryAssociationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/CreateSnapshotCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteDataRepositoryAssociationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteSnapshotCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeDataRepositoryAssociationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeSnapshotsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ReleaseFileSystemNfsV3LocksCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/RestoreVolumeFromSnapshotCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateDataRepositoryAssociationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateSnapshotCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +790 -81
- package/dist-types/ts3.4/pagination/DescribeDataRepositoryAssociationsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/DescribeSnapshotsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +30 -0
- package/package.json +5 -5
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
2
|
/**
|
|
3
|
-
* <p>The Microsoft
|
|
3
|
+
* <p>The Microsoft Active Directory attributes of the Amazon FSx for Windows File
|
|
4
|
+
* Server file system.</p>
|
|
4
5
|
*/
|
|
5
6
|
export interface ActiveDirectoryBackupAttributes {
|
|
6
7
|
/**
|
|
7
|
-
* <p>The fully qualified domain name of the self-managed
|
|
8
|
+
* <p>The fully qualified domain name of the self-managed Active Directory directory.</p>
|
|
8
9
|
*/
|
|
9
10
|
DomainName?: string;
|
|
10
11
|
/**
|
|
@@ -60,7 +61,10 @@ export declare enum AdministrativeActionType {
|
|
|
60
61
|
FILE_SYSTEM_ALIAS_ASSOCIATION = "FILE_SYSTEM_ALIAS_ASSOCIATION",
|
|
61
62
|
FILE_SYSTEM_ALIAS_DISASSOCIATION = "FILE_SYSTEM_ALIAS_DISASSOCIATION",
|
|
62
63
|
FILE_SYSTEM_UPDATE = "FILE_SYSTEM_UPDATE",
|
|
63
|
-
|
|
64
|
+
RELEASE_NFS_V3_LOCKS = "RELEASE_NFS_V3_LOCKS",
|
|
65
|
+
SNAPSHOT_UPDATE = "SNAPSHOT_UPDATE",
|
|
66
|
+
STORAGE_OPTIMIZATION = "STORAGE_OPTIMIZATION",
|
|
67
|
+
VOLUME_UPDATE = "VOLUME_UPDATE"
|
|
64
68
|
}
|
|
65
69
|
/**
|
|
66
70
|
* <p>Provides information about a failed administrative action.</p>
|
|
@@ -85,8 +89,8 @@ export declare enum Status {
|
|
|
85
89
|
UPDATED_OPTIMIZING = "UPDATED_OPTIMIZING"
|
|
86
90
|
}
|
|
87
91
|
/**
|
|
88
|
-
* <p>A structure providing details of any failures that
|
|
89
|
-
*
|
|
92
|
+
* <p>A structure providing details of any failures that occurred when creating a file
|
|
93
|
+
* system.</p>
|
|
90
94
|
*/
|
|
91
95
|
export interface FileSystemFailureDetails {
|
|
92
96
|
/**
|
|
@@ -103,6 +107,7 @@ export declare namespace FileSystemFailureDetails {
|
|
|
103
107
|
export declare enum FileSystemType {
|
|
104
108
|
LUSTRE = "LUSTRE",
|
|
105
109
|
ONTAP = "ONTAP",
|
|
110
|
+
OPENZFS = "OPENZFS",
|
|
106
111
|
WINDOWS = "WINDOWS"
|
|
107
112
|
}
|
|
108
113
|
export declare enum FileSystemLifecycle {
|
|
@@ -120,11 +125,12 @@ export declare enum DataCompressionType {
|
|
|
120
125
|
export declare enum AutoImportPolicyType {
|
|
121
126
|
NEW = "NEW",
|
|
122
127
|
NEW_CHANGED = "NEW_CHANGED",
|
|
128
|
+
NEW_CHANGED_DELETED = "NEW_CHANGED_DELETED",
|
|
123
129
|
NONE = "NONE"
|
|
124
130
|
}
|
|
125
131
|
/**
|
|
126
132
|
* <p>Provides detailed information about the data respository if its <code>Lifecycle</code> is
|
|
127
|
-
* set to <code>MISCONFIGURED</code>.</p>
|
|
133
|
+
* set to <code>MISCONFIGURED</code> or <code>FAILED</code>.</p>
|
|
128
134
|
*/
|
|
129
135
|
export interface DataRepositoryFailureDetails {
|
|
130
136
|
/**
|
|
@@ -142,12 +148,15 @@ export declare enum DataRepositoryLifecycle {
|
|
|
142
148
|
AVAILABLE = "AVAILABLE",
|
|
143
149
|
CREATING = "CREATING",
|
|
144
150
|
DELETING = "DELETING",
|
|
151
|
+
FAILED = "FAILED",
|
|
145
152
|
MISCONFIGURED = "MISCONFIGURED",
|
|
146
153
|
UPDATING = "UPDATING"
|
|
147
154
|
}
|
|
148
155
|
/**
|
|
149
156
|
* <p>The data repository configuration object for Lustre file systems returned in the response of
|
|
150
157
|
* the <code>CreateFileSystem</code> operation.</p>
|
|
158
|
+
* <p>This data type is not supported for file systems with the <code>Persistent_2</code> deployment type.
|
|
159
|
+
* Instead, use .</p>
|
|
151
160
|
*/
|
|
152
161
|
export interface DataRepositoryConfiguration {
|
|
153
162
|
/**
|
|
@@ -173,7 +182,13 @@ export interface DataRepositoryConfiguration {
|
|
|
173
182
|
* </li>
|
|
174
183
|
* <li>
|
|
175
184
|
* <p>
|
|
176
|
-
* <code>UPDATING</code> - The data repository is undergoing a customer
|
|
185
|
+
* <code>UPDATING</code> - The data repository is undergoing a customer
|
|
186
|
+
* initiated update and availability may be impacted.</p>
|
|
187
|
+
* </li>
|
|
188
|
+
* <li>
|
|
189
|
+
* <p>
|
|
190
|
+
* <code>FAILED</code> - The data repository is in a terminal state that
|
|
191
|
+
* cannot be recovered.</p>
|
|
177
192
|
* </li>
|
|
178
193
|
* </ul>
|
|
179
194
|
*/
|
|
@@ -223,16 +238,21 @@ export interface DataRepositoryConfiguration {
|
|
|
223
238
|
* <p>
|
|
224
239
|
* <code>NEW_CHANGED</code> - AutoImport is on. Amazon FSx automatically imports
|
|
225
240
|
* file and directory listings of any new objects added to the S3 bucket and any
|
|
226
|
-
* existing objects that are changed in the S3 bucket after you choose this option
|
|
227
|
-
* </
|
|
241
|
+
* existing objects that are changed in the S3 bucket after you choose this option.</p>
|
|
242
|
+
* </li>
|
|
243
|
+
* <li>
|
|
244
|
+
* <p>
|
|
245
|
+
* <code>NEW_CHANGED_DELETED</code> - AutoImport is on. Amazon FSx automatically
|
|
246
|
+
* imports file and directory listings of any new objects added to the S3 bucket, any
|
|
247
|
+
* existing objects that are changed in the S3 bucket, and any objects that were deleted
|
|
248
|
+
* in the S3 bucket.</p>
|
|
228
249
|
* </li>
|
|
229
250
|
* </ul>
|
|
230
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html">Automatically import updates from your S3 bucket</a>.</p>
|
|
231
251
|
*/
|
|
232
252
|
AutoImportPolicy?: AutoImportPolicyType | string;
|
|
233
253
|
/**
|
|
234
254
|
* <p>Provides detailed information about the data respository if its <code>Lifecycle</code> is
|
|
235
|
-
* set to <code>MISCONFIGURED</code>.</p>
|
|
255
|
+
* set to <code>MISCONFIGURED</code> or <code>FAILED</code>.</p>
|
|
236
256
|
*/
|
|
237
257
|
FailureDetails?: DataRepositoryFailureDetails;
|
|
238
258
|
}
|
|
@@ -244,6 +264,7 @@ export declare namespace DataRepositoryConfiguration {
|
|
|
244
264
|
}
|
|
245
265
|
export declare enum LustreDeploymentType {
|
|
246
266
|
PERSISTENT_1 = "PERSISTENT_1",
|
|
267
|
+
PERSISTENT_2 = "PERSISTENT_2",
|
|
247
268
|
SCRATCH_1 = "SCRATCH_1",
|
|
248
269
|
SCRATCH_2 = "SCRATCH_2"
|
|
249
270
|
}
|
|
@@ -251,47 +272,119 @@ export declare enum DriveCacheType {
|
|
|
251
272
|
NONE = "NONE",
|
|
252
273
|
READ = "READ"
|
|
253
274
|
}
|
|
275
|
+
export declare enum LustreAccessAuditLogLevel {
|
|
276
|
+
DISABLED = "DISABLED",
|
|
277
|
+
ERROR_ONLY = "ERROR_ONLY",
|
|
278
|
+
WARN_ERROR = "WARN_ERROR",
|
|
279
|
+
WARN_ONLY = "WARN_ONLY"
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* <p>The configuration for Lustre logging used to write the enabled
|
|
283
|
+
* logging events for your file system to Amazon CloudWatch Logs.</p>
|
|
284
|
+
* <p>When logging is enabled, Lustre logs error and warning events
|
|
285
|
+
* from data repository operations such as automatic export and data repository tasks.
|
|
286
|
+
* To learn more about Lustre logging, see
|
|
287
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/cw-event-logging.html">Logging with Amazon CloudWatch Logs</a>.
|
|
288
|
+
* </p>
|
|
289
|
+
*/
|
|
290
|
+
export interface LustreLogConfiguration {
|
|
291
|
+
/**
|
|
292
|
+
* <p>The data repository events that are logged by Amazon FSx.</p>
|
|
293
|
+
* <ul>
|
|
294
|
+
* <li>
|
|
295
|
+
* <p>
|
|
296
|
+
* <code>WARN_ONLY</code> - only warning events are logged.</p>
|
|
297
|
+
* </li>
|
|
298
|
+
* <li>
|
|
299
|
+
* <p>
|
|
300
|
+
* <code>ERROR_ONLY</code> - only error events are logged.</p>
|
|
301
|
+
* </li>
|
|
302
|
+
* <li>
|
|
303
|
+
* <p>
|
|
304
|
+
* <code>WARN_ERROR</code> - both warning events and error events
|
|
305
|
+
* are logged.</p>
|
|
306
|
+
* </li>
|
|
307
|
+
* <li>
|
|
308
|
+
* <p>
|
|
309
|
+
* <code>DISABLED</code> - logging of data repository events
|
|
310
|
+
* is turned off.</p>
|
|
311
|
+
* </li>
|
|
312
|
+
* </ul>
|
|
313
|
+
*/
|
|
314
|
+
Level: LustreAccessAuditLogLevel | string | undefined;
|
|
315
|
+
/**
|
|
316
|
+
* <p>The Amazon Resource Name (ARN) that specifies the destination of the logs.
|
|
317
|
+
* The destination can be any Amazon CloudWatch Logs log group ARN. The destination
|
|
318
|
+
* ARN must be in the same Amazon Web Services partition, Amazon Web Services Region,
|
|
319
|
+
* and Amazon Web Services account as your Amazon FSx file system.</p>
|
|
320
|
+
*/
|
|
321
|
+
Destination?: string;
|
|
322
|
+
}
|
|
323
|
+
export declare namespace LustreLogConfiguration {
|
|
324
|
+
/**
|
|
325
|
+
* @internal
|
|
326
|
+
*/
|
|
327
|
+
const filterSensitiveLog: (obj: LustreLogConfiguration) => any;
|
|
328
|
+
}
|
|
254
329
|
/**
|
|
255
330
|
* <p>The configuration for the Amazon FSx for Lustre file system.</p>
|
|
256
331
|
*/
|
|
257
332
|
export interface LustreFileSystemConfiguration {
|
|
258
333
|
/**
|
|
259
334
|
* <p>The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC
|
|
260
|
-
* time zone. d is the weekday number, from 1 through 7, beginning with Monday and
|
|
335
|
+
* time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and
|
|
336
|
+
* ending with Sunday.</p>
|
|
261
337
|
*/
|
|
262
338
|
WeeklyMaintenanceStartTime?: string;
|
|
263
339
|
/**
|
|
264
340
|
* <p>The data repository configuration object for Lustre file systems returned in the response of
|
|
265
341
|
* the <code>CreateFileSystem</code> operation.</p>
|
|
342
|
+
* <p>This data type is not supported for file systems with the <code>Persistent_2</code> deployment type.
|
|
343
|
+
* Instead, use .</p>
|
|
266
344
|
*/
|
|
267
345
|
DataRepositoryConfiguration?: DataRepositoryConfiguration;
|
|
268
346
|
/**
|
|
269
|
-
* <p>The deployment type of the
|
|
347
|
+
* <p>The deployment type of the FSx for Lustre file system.
|
|
348
|
+
* <i>Scratch deployment type</i> is designed for temporary storage
|
|
270
349
|
* and shorter-term processing of data.</p>
|
|
271
350
|
* <p>
|
|
272
|
-
* <code>SCRATCH_1</code> and <code>SCRATCH_2</code> deployment
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
* <p>The <code>PERSISTENT_1</code> deployment type is used
|
|
277
|
-
* and workloads and encryption of data in transit.
|
|
278
|
-
*
|
|
279
|
-
*
|
|
351
|
+
* <code>SCRATCH_1</code> and <code>SCRATCH_2</code> deployment types are best suited
|
|
352
|
+
* for when you need temporary storage and shorter-term processing of data. The
|
|
353
|
+
* <code>SCRATCH_2</code> deployment type provides in-transit encryption of data and higher burst
|
|
354
|
+
* throughput capacity than <code>SCRATCH_1</code>.</p>
|
|
355
|
+
* <p>The <code>PERSISTENT_1</code> and <code>PERSISTENT_2</code> deployment type is used
|
|
356
|
+
* for longer-term storage and workloads and encryption of data in transit.
|
|
357
|
+
* <code>PERSISTENT_2</code> is built on Lustre v2.12 and offers higher
|
|
358
|
+
* <code>PerUnitStorageThroughput</code> (up to 1000 MB/s/TiB) along with a lower
|
|
359
|
+
* minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html">
|
|
360
|
+
* FSx for Lustre deployment options</a>.</p>
|
|
361
|
+
* <p>The default is <code>SCRATCH_1</code>.</p>
|
|
280
362
|
*/
|
|
281
363
|
DeploymentType?: LustreDeploymentType | string;
|
|
282
364
|
/**
|
|
283
|
-
* <p>
|
|
365
|
+
* <p>Per unit storage throughput represents the megabytes per second of read or write
|
|
284
366
|
* throughput per 1 tebibyte of storage provisioned. File system throughput capacity is
|
|
285
367
|
* equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is
|
|
286
|
-
* only valid for <code>PERSISTENT_1</code> deployment types. </p>
|
|
287
|
-
* <p>Valid values
|
|
368
|
+
* only valid for <code>PERSISTENT_1</code> and <code>PERSISTENT_2</code> deployment types. </p>
|
|
369
|
+
* <p>Valid values:</p>
|
|
370
|
+
* <ul>
|
|
371
|
+
* <li>
|
|
372
|
+
* <p>For <code>PERSISTENT_1</code> SSD storage: 50, 100, 200.</p>
|
|
373
|
+
* </li>
|
|
374
|
+
* <li>
|
|
375
|
+
* <p>For <code>PERSISTENT_1</code> HDD storage: 12, 40.</p>
|
|
376
|
+
* </li>
|
|
377
|
+
* <li>
|
|
378
|
+
* <p>For <code>PERSISTENT_2</code> SSD storage: 125, 250, 500, 1000.</p>
|
|
379
|
+
* </li>
|
|
380
|
+
* </ul>
|
|
288
381
|
*/
|
|
289
382
|
PerUnitStorageThroughput?: number;
|
|
290
383
|
/**
|
|
291
384
|
* <p>You use the <code>MountName</code> value when mounting the file system.</p>
|
|
292
385
|
* <p>For the <code>SCRATCH_1</code> deployment type, this value is always "<code>fsx</code>".
|
|
293
|
-
* For <code>SCRATCH_2</code> and <code>
|
|
294
|
-
* value is a string that is unique within an Amazon Web Services Region.
|
|
386
|
+
* For <code>SCRATCH_2</code>, <code>PERSISTENT_1</code>, and <code>PERSISTENT_2</code> deployment
|
|
387
|
+
* types, this value is a string that is unique within an Amazon Web Services Region.
|
|
295
388
|
*
|
|
296
389
|
* </p>
|
|
297
390
|
*/
|
|
@@ -303,12 +396,13 @@ export interface LustreFileSystemConfiguration {
|
|
|
303
396
|
*/
|
|
304
397
|
DailyAutomaticBackupStartTime?: string;
|
|
305
398
|
/**
|
|
306
|
-
* <p>The number of days to retain automatic backups. Setting this to
|
|
307
|
-
*
|
|
399
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
400
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
401
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
308
402
|
*/
|
|
309
403
|
AutomaticBackupRetentionDays?: number;
|
|
310
404
|
/**
|
|
311
|
-
* <p>A boolean flag indicating whether tags on the file system
|
|
405
|
+
* <p>A boolean flag indicating whether tags on the file system are copied to backups.
|
|
312
406
|
* If it's set to true, all tags on the file system are
|
|
313
407
|
* copied to all automatic backups and any user-initiated backups where the user
|
|
314
408
|
* doesn't specify any tags. If this value is true, and you specify one or more tags,
|
|
@@ -318,10 +412,11 @@ export interface LustreFileSystemConfiguration {
|
|
|
318
412
|
*/
|
|
319
413
|
CopyTagsToBackups?: boolean;
|
|
320
414
|
/**
|
|
321
|
-
* <p>The type of drive cache used by PERSISTENT_1 file systems that are provisioned with
|
|
322
|
-
* HDD storage devices. This parameter is required when
|
|
323
|
-
* <code>READ</code
|
|
324
|
-
*
|
|
415
|
+
* <p>The type of drive cache used by <code>PERSISTENT_1</code> file systems that are provisioned with
|
|
416
|
+
* HDD storage devices. This parameter is required when <code>StorageType</code> is HDD. When set to
|
|
417
|
+
* <code>READ</code> the file system has an SSD storage cache that is sized to 20% of the file system's
|
|
418
|
+
* storage capacity. This improves the performance for frequently accessed files by caching up to 20%
|
|
419
|
+
* of the total storage capacity.</p>
|
|
325
420
|
* <p>This parameter is required when <code>StorageType</code> is set to HDD.</p>
|
|
326
421
|
*/
|
|
327
422
|
DriveCacheType?: DriveCacheType | string;
|
|
@@ -343,6 +438,11 @@ export interface LustreFileSystemConfiguration {
|
|
|
343
438
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html">Lustre data compression</a>.</p>
|
|
344
439
|
*/
|
|
345
440
|
DataCompressionType?: DataCompressionType | string;
|
|
441
|
+
/**
|
|
442
|
+
* <p>The Lustre logging configuration. Lustre logging writes the enabled log
|
|
443
|
+
* events for your file system to Amazon CloudWatch Logs.</p>
|
|
444
|
+
*/
|
|
445
|
+
LogConfiguration?: LustreLogConfiguration;
|
|
346
446
|
}
|
|
347
447
|
export declare namespace LustreFileSystemConfiguration {
|
|
348
448
|
/**
|
|
@@ -358,12 +458,10 @@ export declare enum DiskIopsConfigurationMode {
|
|
|
358
458
|
USER_PROVISIONED = "USER_PROVISIONED"
|
|
359
459
|
}
|
|
360
460
|
/**
|
|
361
|
-
* <p>The SSD IOPS (input/output operations per second) configuration
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
* of provisioned SSD IOPS and how the amount was provisioned
|
|
366
|
-
* (by the customer or by the system).</p>
|
|
461
|
+
* <p>The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The
|
|
462
|
+
* default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per
|
|
463
|
+
* GB of storage. The configuration consists of the total number of provisioned SSD IOPS
|
|
464
|
+
* and how the amount was provisioned (by the customer or by the system).</p>
|
|
367
465
|
*/
|
|
368
466
|
export interface DiskIopsConfiguration {
|
|
369
467
|
/**
|
|
@@ -434,8 +532,9 @@ export declare namespace FileSystemEndpoints {
|
|
|
434
532
|
*/
|
|
435
533
|
export interface OntapFileSystemConfiguration {
|
|
436
534
|
/**
|
|
437
|
-
* <p>The number of days to retain automatic backups. Setting this to
|
|
438
|
-
*
|
|
535
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
536
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
537
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
439
538
|
*/
|
|
440
539
|
AutomaticBackupRetentionDays?: number;
|
|
441
540
|
/**
|
|
@@ -466,7 +565,7 @@ export interface OntapFileSystemConfiguration {
|
|
|
466
565
|
DiskIopsConfiguration?: DiskIopsConfiguration;
|
|
467
566
|
/**
|
|
468
567
|
* <p>The ID for a subnet. A <i>subnet</i> is a range of IP addresses in
|
|
469
|
-
* your virtual private cloud (VPC). For more information, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">VPC and
|
|
568
|
+
* your virtual private cloud (VPC). For more information, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html">VPC and subnets</a> in the
|
|
470
569
|
* <i>Amazon VPC User Guide.</i>
|
|
471
570
|
* </p>
|
|
472
571
|
*/
|
|
@@ -477,7 +576,7 @@ export interface OntapFileSystemConfiguration {
|
|
|
477
576
|
*/
|
|
478
577
|
RouteTableIds?: string[];
|
|
479
578
|
/**
|
|
480
|
-
* <p>
|
|
579
|
+
* <p>The sustained throughput of an Amazon FSx file system in MBps.</p>
|
|
481
580
|
*/
|
|
482
581
|
ThroughputCapacity?: number;
|
|
483
582
|
/**
|
|
@@ -498,6 +597,85 @@ export declare namespace OntapFileSystemConfiguration {
|
|
|
498
597
|
*/
|
|
499
598
|
const filterSensitiveLog: (obj: OntapFileSystemConfiguration) => any;
|
|
500
599
|
}
|
|
600
|
+
export declare enum OpenZFSDeploymentType {
|
|
601
|
+
SINGLE_AZ_1 = "SINGLE_AZ_1"
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* <p>The configuration for the Amazon FSx for OpenZFS file system. </p>
|
|
605
|
+
*/
|
|
606
|
+
export interface OpenZFSFileSystemConfiguration {
|
|
607
|
+
/**
|
|
608
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
609
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
610
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
611
|
+
*/
|
|
612
|
+
AutomaticBackupRetentionDays?: number;
|
|
613
|
+
/**
|
|
614
|
+
* <p>A Boolean value indicating whether tags on the file system should be copied to
|
|
615
|
+
* backups.
|
|
616
|
+
* If it's set to <code>true</code>, all tags on the file system are copied to all
|
|
617
|
+
* automatic backups and any user-initiated backups where the user doesn't specify any
|
|
618
|
+
* tags. If this value is <code>true</code> and you specify one or more tags, only the
|
|
619
|
+
* specified tags are copied to backups. If you specify one or more tags when creating a
|
|
620
|
+
* user-initiated backup, no tags are copied from the file system, regardless of this
|
|
621
|
+
* value. </p>
|
|
622
|
+
*/
|
|
623
|
+
CopyTagsToBackups?: boolean;
|
|
624
|
+
/**
|
|
625
|
+
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
|
626
|
+
* This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags
|
|
627
|
+
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
628
|
+
* value is <code>true</code> and you specify one or more tags, only the specified tags are
|
|
629
|
+
* copied to snapshots. If you specify one or more tags when creating the snapshot, no tags
|
|
630
|
+
* are copied from the volume, regardless of this value. </p>
|
|
631
|
+
*/
|
|
632
|
+
CopyTagsToVolumes?: boolean;
|
|
633
|
+
/**
|
|
634
|
+
* <p>A recurring daily time, in the format <code>HH:MM</code>. <code>HH</code> is the
|
|
635
|
+
* zero-padded hour of the day (0-23), and <code>MM</code> is the zero-padded minute of the
|
|
636
|
+
* hour. For example, <code>05:00</code> specifies 5 AM daily. </p>
|
|
637
|
+
*/
|
|
638
|
+
DailyAutomaticBackupStartTime?: string;
|
|
639
|
+
/**
|
|
640
|
+
* <p>Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
|
|
641
|
+
* <code>SINGLE_AZ_1</code>. <code>SINGLE_AZ_1</code> is a file system configured for a
|
|
642
|
+
* single Availability Zone (AZ) of redundancy. </p>
|
|
643
|
+
*/
|
|
644
|
+
DeploymentType?: OpenZFSDeploymentType | string;
|
|
645
|
+
/**
|
|
646
|
+
* <p>The throughput of an Amazon FSx file system, measured in megabytes per second
|
|
647
|
+
* (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048). </p>
|
|
648
|
+
*/
|
|
649
|
+
ThroughputCapacity?: number;
|
|
650
|
+
/**
|
|
651
|
+
* <p>A recurring weekly time, in the format <code>D:HH:MM</code>. </p>
|
|
652
|
+
* <p>
|
|
653
|
+
* <code>D</code> is the day of the week, for which 1 represents Monday and 7
|
|
654
|
+
* represents Sunday. For further details, see <a href="https://en.wikipedia.org/wiki/ISO_week_date">the ISO-8601 spec as described on Wikipedia</a>.</p>
|
|
655
|
+
* <p>
|
|
656
|
+
* <code>HH</code> is the zero-padded hour of the day (0-23), and <code>MM</code> is
|
|
657
|
+
* the zero-padded minute of the hour. </p>
|
|
658
|
+
* <p>For example, <code>1:05:00</code> specifies maintenance at 5 AM Monday.</p>
|
|
659
|
+
*/
|
|
660
|
+
WeeklyMaintenanceStartTime?: string;
|
|
661
|
+
/**
|
|
662
|
+
* <p>The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The
|
|
663
|
+
* default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per
|
|
664
|
+
* GB of storage. The configuration consists of the total number of provisioned SSD IOPS
|
|
665
|
+
* and how the amount was provisioned (by the customer or by the system).</p>
|
|
666
|
+
*/
|
|
667
|
+
DiskIopsConfiguration?: DiskIopsConfiguration;
|
|
668
|
+
/**
|
|
669
|
+
* <p>The ID of the root volume of the OpenZFS file system. </p>
|
|
670
|
+
*/
|
|
671
|
+
RootVolumeId?: string;
|
|
672
|
+
}
|
|
673
|
+
export declare namespace OpenZFSFileSystemConfiguration {
|
|
674
|
+
/**
|
|
675
|
+
* @internal
|
|
676
|
+
*/
|
|
677
|
+
const filterSensitiveLog: (obj: OpenZFSFileSystemConfiguration) => any;
|
|
678
|
+
}
|
|
501
679
|
export declare enum StorageType {
|
|
502
680
|
HDD = "HDD",
|
|
503
681
|
SSD = "SSD"
|
|
@@ -836,7 +1014,14 @@ export declare namespace WindowsFileSystemConfiguration {
|
|
|
836
1014
|
*/
|
|
837
1015
|
const filterSensitiveLog: (obj: WindowsFileSystemConfiguration) => any;
|
|
838
1016
|
}
|
|
1017
|
+
export declare enum SnapshotLifecycle {
|
|
1018
|
+
AVAILABLE = "AVAILABLE",
|
|
1019
|
+
CREATING = "CREATING",
|
|
1020
|
+
DELETING = "DELETING",
|
|
1021
|
+
PENDING = "PENDING"
|
|
1022
|
+
}
|
|
839
1023
|
export declare enum VolumeLifecycle {
|
|
1024
|
+
AVAILABLE = "AVAILABLE",
|
|
840
1025
|
CREATED = "CREATED",
|
|
841
1026
|
CREATING = "CREATING",
|
|
842
1027
|
DELETING = "DELETING",
|
|
@@ -926,7 +1111,7 @@ export declare namespace TieringPolicy {
|
|
|
926
1111
|
const filterSensitiveLog: (obj: TieringPolicy) => any;
|
|
927
1112
|
}
|
|
928
1113
|
/**
|
|
929
|
-
* <p>The configuration of an Amazon FSx for NetApp ONTAP volume
|
|
1114
|
+
* <p>The configuration of an Amazon FSx for NetApp ONTAP volume.</p>
|
|
930
1115
|
*/
|
|
931
1116
|
export interface OntapVolumeConfiguration {
|
|
932
1117
|
/**
|
|
@@ -950,15 +1135,18 @@ export interface OntapVolumeConfiguration {
|
|
|
950
1135
|
*/
|
|
951
1136
|
FlexCacheEndpointType?: FlexCacheEndpointType | string;
|
|
952
1137
|
/**
|
|
953
|
-
* <p>Specifies the directory that NAS clients use to mount the
|
|
954
|
-
*
|
|
955
|
-
*
|
|
956
|
-
*
|
|
1138
|
+
* <p>Specifies the directory that network-attached storage (NAS) clients use to mount the
|
|
1139
|
+
* volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP
|
|
1140
|
+
* address. You can create a <code>JunctionPath</code> directly below a parent volume
|
|
1141
|
+
* junction or on a directory within a volume. A <code>JunctionPath</code> for a volume
|
|
1142
|
+
* named <code>vol3</code> might be <code>/vol1/vol2/vol3</code>, or
|
|
1143
|
+
* <code>/vol1/dir2/vol3</code>, or even <code>/dir1/dir2/vol3</code>.</p>
|
|
957
1144
|
*/
|
|
958
1145
|
JunctionPath?: string;
|
|
959
1146
|
/**
|
|
960
|
-
* <p>The security style for the volume, which can be <code>UNIX</code>,
|
|
961
|
-
*
|
|
1147
|
+
* <p>The security style for the volume, which can be <code>UNIX</code>, <code>NTFS</code>,
|
|
1148
|
+
* or
|
|
1149
|
+
* <code>MIXED</code>.</p>
|
|
962
1150
|
*/
|
|
963
1151
|
SecurityStyle?: SecurityStyle | string;
|
|
964
1152
|
/**
|
|
@@ -974,13 +1162,13 @@ export interface OntapVolumeConfiguration {
|
|
|
974
1162
|
*/
|
|
975
1163
|
StorageVirtualMachineId?: string;
|
|
976
1164
|
/**
|
|
977
|
-
* <p>A
|
|
978
|
-
*
|
|
979
|
-
*
|
|
980
|
-
*
|
|
981
|
-
* <p>This flag is useful when you're deleting an SVM, because you must
|
|
982
|
-
*
|
|
983
|
-
*
|
|
1165
|
+
* <p>A Boolean flag indicating whether this volume is the root volume for its storage
|
|
1166
|
+
* virtual machine (SVM). Only one volume on an SVM can be the root volume. This value
|
|
1167
|
+
* defaults to <code>false</code>. If this value is <code>true</code>, then this is the SVM
|
|
1168
|
+
* root volume.</p>
|
|
1169
|
+
* <p>This flag is useful when you're deleting an SVM, because you must first delete all
|
|
1170
|
+
* non-root volumes. This flag, when set to <code>false</code>, helps you identify which
|
|
1171
|
+
* volumes to delete before you can delete the SVM.</p>
|
|
984
1172
|
*/
|
|
985
1173
|
StorageVirtualMachineRoot?: boolean;
|
|
986
1174
|
/**
|
|
@@ -988,7 +1176,7 @@ export interface OntapVolumeConfiguration {
|
|
|
988
1176
|
*/
|
|
989
1177
|
TieringPolicy?: TieringPolicy;
|
|
990
1178
|
/**
|
|
991
|
-
* <p>The volume's
|
|
1179
|
+
* <p>The volume's universally unique identifier (UUID).</p>
|
|
992
1180
|
*/
|
|
993
1181
|
UUID?: string;
|
|
994
1182
|
/**
|
|
@@ -996,20 +1184,19 @@ export interface OntapVolumeConfiguration {
|
|
|
996
1184
|
* <ul>
|
|
997
1185
|
* <li>
|
|
998
1186
|
* <p>
|
|
999
|
-
* <code>RW</code> specifies a read
|
|
1000
|
-
* <code>RW</code> is the default.</p>
|
|
1187
|
+
* <code>RW</code> specifies a read/write volume. <code>RW</code> is the default.</p>
|
|
1001
1188
|
* </li>
|
|
1002
1189
|
* <li>
|
|
1003
1190
|
* <p>
|
|
1004
|
-
* <code>DP</code> specifies a data
|
|
1005
|
-
*
|
|
1006
|
-
*
|
|
1191
|
+
* <code>DP</code> specifies a data-protection volume. You can protect data by replicating it to
|
|
1192
|
+
* data-protection mirror copies. If a disaster occurs, you can use these
|
|
1193
|
+
* data-protection mirror copies to recover data.</p>
|
|
1007
1194
|
* </li>
|
|
1008
1195
|
* <li>
|
|
1009
1196
|
* <p>
|
|
1010
|
-
* <code>LS</code> specifies a load-sharing mirror volume.
|
|
1011
|
-
*
|
|
1012
|
-
*
|
|
1197
|
+
* <code>LS</code> specifies a load-sharing mirror volume. A load-sharing mirror reduces the
|
|
1198
|
+
* network traffic to a FlexVol volume by providing additional read-only access to
|
|
1199
|
+
* clients.</p>
|
|
1013
1200
|
* </li>
|
|
1014
1201
|
* </ul>
|
|
1015
1202
|
*/
|
|
@@ -1021,89 +1208,213 @@ export declare namespace OntapVolumeConfiguration {
|
|
|
1021
1208
|
*/
|
|
1022
1209
|
const filterSensitiveLog: (obj: OntapVolumeConfiguration) => any;
|
|
1023
1210
|
}
|
|
1024
|
-
export declare enum
|
|
1025
|
-
|
|
1211
|
+
export declare enum OpenZFSDataCompressionType {
|
|
1212
|
+
NONE = "NONE",
|
|
1213
|
+
ZSTD = "ZSTD"
|
|
1026
1214
|
}
|
|
1027
1215
|
/**
|
|
1028
|
-
* <p>
|
|
1216
|
+
* <p>Specifies who can mount the file system and the options that can be used while
|
|
1217
|
+
* mounting the file system.</p>
|
|
1029
1218
|
*/
|
|
1030
|
-
export interface
|
|
1031
|
-
/**
|
|
1032
|
-
* <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z),
|
|
1033
|
-
* also known as Unix time.</p>
|
|
1034
|
-
*/
|
|
1035
|
-
CreationTime?: Date;
|
|
1219
|
+
export interface OpenZFSClientConfiguration {
|
|
1036
1220
|
/**
|
|
1037
|
-
* <p>
|
|
1221
|
+
* <p>A value that specifies who can mount the file system. You can provide a wildcard
|
|
1222
|
+
* character (<code>*</code>), an IP address (<code>0.0.0.0</code>), or a CIDR address
|
|
1223
|
+
* (<code>192.0.2.0/24</code>. By default, Amazon FSx uses the wildcard
|
|
1224
|
+
* character when specifying the client. </p>
|
|
1038
1225
|
*/
|
|
1039
|
-
|
|
1226
|
+
Clients: string | undefined;
|
|
1040
1227
|
/**
|
|
1041
|
-
* <p>The
|
|
1228
|
+
* <p>The options to use when mounting the file system. For a list of options that you can
|
|
1229
|
+
* use with Network File System (NFS), see the <a href="https://linux.die.net/man/5/exports">exports(5) - Linux man page</a>. When
|
|
1230
|
+
* choosing your options, consider the following:</p>
|
|
1042
1231
|
* <ul>
|
|
1043
1232
|
* <li>
|
|
1044
|
-
*
|
|
1045
|
-
* <code>
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
1048
|
-
* <p>
|
|
1049
|
-
* <code>CREATING</code> - Amazon FSx is creating the new volume.</p>
|
|
1050
|
-
* </li>
|
|
1051
|
-
* <li>
|
|
1052
|
-
* <p>
|
|
1053
|
-
* <code>DELETING</code> - Amazon FSx is deleting an existing volume.</p>
|
|
1054
|
-
* </li>
|
|
1055
|
-
* <li>
|
|
1056
|
-
* <p>
|
|
1057
|
-
* <code>FAILED</code> - Amazon FSx was unable to create the volume.</p>
|
|
1058
|
-
* </li>
|
|
1059
|
-
* <li>
|
|
1060
|
-
* <p>
|
|
1061
|
-
* <code>MISCONFIGURED</code> - The volume is in a failed but recoverable state.</p>
|
|
1233
|
+
* <p>
|
|
1234
|
+
* <code>crossmount</code> is used by default. If you don't specify
|
|
1235
|
+
* <code>crossmount</code> when changing the client configuration, you won't be
|
|
1236
|
+
* able to see or access snapshots in your file system's snapshot directory.</p>
|
|
1062
1237
|
* </li>
|
|
1063
1238
|
* <li>
|
|
1064
|
-
*
|
|
1065
|
-
* <code>
|
|
1239
|
+
* <p>
|
|
1240
|
+
* <code>sync</code> is used by default. If you instead specify
|
|
1241
|
+
* <code>async</code>, the system acknowledges writes before writing to disk.
|
|
1242
|
+
* If the system crashes before the writes are finished, you lose the unwritten
|
|
1243
|
+
* data. </p>
|
|
1066
1244
|
* </li>
|
|
1067
1245
|
* </ul>
|
|
1068
1246
|
*/
|
|
1069
|
-
|
|
1247
|
+
Options: string[] | undefined;
|
|
1248
|
+
}
|
|
1249
|
+
export declare namespace OpenZFSClientConfiguration {
|
|
1070
1250
|
/**
|
|
1071
|
-
*
|
|
1251
|
+
* @internal
|
|
1072
1252
|
*/
|
|
1073
|
-
|
|
1253
|
+
const filterSensitiveLog: (obj: OpenZFSClientConfiguration) => any;
|
|
1254
|
+
}
|
|
1255
|
+
/**
|
|
1256
|
+
* <p>The Network File System NFS) configurations for mounting an Amazon FSx for
|
|
1257
|
+
* OpenZFS file system. </p>
|
|
1258
|
+
*/
|
|
1259
|
+
export interface OpenZFSNfsExport {
|
|
1074
1260
|
/**
|
|
1075
|
-
* <p>
|
|
1261
|
+
* <p>A list of configuration objects that contain the client and options for mounting the
|
|
1262
|
+
* OpenZFS file system. </p>
|
|
1076
1263
|
*/
|
|
1077
|
-
|
|
1264
|
+
ClientConfigurations: OpenZFSClientConfiguration[] | undefined;
|
|
1265
|
+
}
|
|
1266
|
+
export declare namespace OpenZFSNfsExport {
|
|
1267
|
+
/**
|
|
1268
|
+
* @internal
|
|
1269
|
+
*/
|
|
1270
|
+
const filterSensitiveLog: (obj: OpenZFSNfsExport) => any;
|
|
1271
|
+
}
|
|
1272
|
+
export declare enum OpenZFSCopyStrategy {
|
|
1273
|
+
CLONE = "CLONE",
|
|
1274
|
+
FULL_COPY = "FULL_COPY"
|
|
1275
|
+
}
|
|
1276
|
+
/**
|
|
1277
|
+
* <p>The snapshot configuration to use when creating an OpenZFS volume from a
|
|
1278
|
+
* snapshot.</p>
|
|
1279
|
+
*/
|
|
1280
|
+
export interface OpenZFSOriginSnapshotConfiguration {
|
|
1078
1281
|
/**
|
|
1079
1282
|
* <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services
|
|
1080
1283
|
* resources. We require an ARN when you need to specify a resource unambiguously across
|
|
1081
1284
|
* all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in
|
|
1082
1285
|
* the <i>Amazon Web Services General Reference</i>.</p>
|
|
1083
1286
|
*/
|
|
1084
|
-
|
|
1287
|
+
SnapshotARN?: string;
|
|
1085
1288
|
/**
|
|
1086
|
-
* <p>
|
|
1289
|
+
* <p>The strategy used when copying data from the snapshot to the new volume. </p>
|
|
1290
|
+
* <ul>
|
|
1291
|
+
* <li>
|
|
1292
|
+
* <p>
|
|
1293
|
+
* <code>CLONE</code> - The new volume references the data in the origin
|
|
1294
|
+
* snapshot. Cloning a snapshot is faster than copying the data from a snapshot to
|
|
1295
|
+
* a new volume and doesn't consume disk throughput. However, the origin snapshot
|
|
1296
|
+
* can't be deleted if there is a volume using its copied data. </p>
|
|
1297
|
+
* </li>
|
|
1298
|
+
* <li>
|
|
1299
|
+
* <p>
|
|
1300
|
+
* <code>FULL_COPY</code> - Copies all data from the snapshot to the new volume.
|
|
1301
|
+
* </p>
|
|
1302
|
+
* </li>
|
|
1303
|
+
* </ul>
|
|
1087
1304
|
*/
|
|
1088
|
-
|
|
1305
|
+
CopyStrategy?: OpenZFSCopyStrategy | string;
|
|
1306
|
+
}
|
|
1307
|
+
export declare namespace OpenZFSOriginSnapshotConfiguration {
|
|
1089
1308
|
/**
|
|
1090
|
-
*
|
|
1309
|
+
* @internal
|
|
1091
1310
|
*/
|
|
1092
|
-
|
|
1311
|
+
const filterSensitiveLog: (obj: OpenZFSOriginSnapshotConfiguration) => any;
|
|
1312
|
+
}
|
|
1313
|
+
export declare enum OpenZFSQuotaType {
|
|
1314
|
+
GROUP = "GROUP",
|
|
1315
|
+
USER = "USER"
|
|
1316
|
+
}
|
|
1317
|
+
/**
|
|
1318
|
+
* <p>The configuration for how much storage a user or group can use on the volume. </p>
|
|
1319
|
+
*/
|
|
1320
|
+
export interface OpenZFSUserOrGroupQuota {
|
|
1093
1321
|
/**
|
|
1094
|
-
* <p>
|
|
1322
|
+
* <p>A value that specifies whether the quota applies to a user or group.</p>
|
|
1095
1323
|
*/
|
|
1096
|
-
|
|
1324
|
+
Type: OpenZFSQuotaType | string | undefined;
|
|
1097
1325
|
/**
|
|
1098
|
-
* <p>
|
|
1326
|
+
* <p>The ID of the user or group.</p>
|
|
1099
1327
|
*/
|
|
1100
|
-
|
|
1328
|
+
Id: number | undefined;
|
|
1329
|
+
/**
|
|
1330
|
+
* <p>The amount of storage that the user or group can use in gibibytes (GiB).</p>
|
|
1331
|
+
*/
|
|
1332
|
+
StorageCapacityQuotaGiB: number | undefined;
|
|
1101
1333
|
}
|
|
1102
|
-
export declare namespace
|
|
1334
|
+
export declare namespace OpenZFSUserOrGroupQuota {
|
|
1103
1335
|
/**
|
|
1104
1336
|
* @internal
|
|
1105
1337
|
*/
|
|
1106
|
-
const filterSensitiveLog: (obj:
|
|
1338
|
+
const filterSensitiveLog: (obj: OpenZFSUserOrGroupQuota) => any;
|
|
1339
|
+
}
|
|
1340
|
+
/**
|
|
1341
|
+
* <p>The configuration of an Amazon FSx for OpenZFS volume.</p>
|
|
1342
|
+
*/
|
|
1343
|
+
export interface OpenZFSVolumeConfiguration {
|
|
1344
|
+
/**
|
|
1345
|
+
* <p>The ID of the parent volume.</p>
|
|
1346
|
+
*/
|
|
1347
|
+
ParentVolumeId?: string;
|
|
1348
|
+
/**
|
|
1349
|
+
* <p>The path to the volume from the root volume. For example,
|
|
1350
|
+
* <code>fsx/parentVolume/volume1</code>.</p>
|
|
1351
|
+
*/
|
|
1352
|
+
VolumePath?: string;
|
|
1353
|
+
/**
|
|
1354
|
+
* <p>The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't
|
|
1355
|
+
* reserve more storage than the parent volume has reserved.</p>
|
|
1356
|
+
*/
|
|
1357
|
+
StorageCapacityReservationGiB?: number;
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>The maximum amount of storage in gibibtyes (GiB) that the volume can use from its
|
|
1360
|
+
* parent. You can specify a quota larger than the storage on the parent volume.</p>
|
|
1361
|
+
*/
|
|
1362
|
+
StorageCapacityQuotaGiB?: number;
|
|
1363
|
+
/**
|
|
1364
|
+
* <p>The method used to compress the data on the volume. Unless a compression type is
|
|
1365
|
+
* specified, volumes inherit the <code>DataCompressionType</code> value of their parent
|
|
1366
|
+
* volume.</p>
|
|
1367
|
+
* <ul>
|
|
1368
|
+
* <li>
|
|
1369
|
+
* <p>
|
|
1370
|
+
* <code>NONE</code> - Doesn't compress the data on the volume.</p>
|
|
1371
|
+
* </li>
|
|
1372
|
+
* <li>
|
|
1373
|
+
* <p>
|
|
1374
|
+
* <code>ZSTD</code> - Compresses the data in the volume using the Zstandard
|
|
1375
|
+
* (ZSTD) compression algorithm. This algorithm reduces the amount of space used on
|
|
1376
|
+
* your volume and has very little impact on compute resources.</p>
|
|
1377
|
+
* </li>
|
|
1378
|
+
* </ul>
|
|
1379
|
+
*/
|
|
1380
|
+
DataCompressionType?: OpenZFSDataCompressionType | string;
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
|
1383
|
+
* This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags
|
|
1384
|
+
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
1385
|
+
* value is <code>true</code> and you specify one or more tags, only the specified tags are
|
|
1386
|
+
* copied to snapshots. If you specify one or more tags when creating the snapshot, no tags
|
|
1387
|
+
* are copied from the volume, regardless of this value. </p>
|
|
1388
|
+
*/
|
|
1389
|
+
CopyTagsToSnapshots?: boolean;
|
|
1390
|
+
/**
|
|
1391
|
+
* <p>The configuration object that specifies the snapshot to use as the origin of the data
|
|
1392
|
+
* for the volume.</p>
|
|
1393
|
+
*/
|
|
1394
|
+
OriginSnapshot?: OpenZFSOriginSnapshotConfiguration;
|
|
1395
|
+
/**
|
|
1396
|
+
* <p>A Boolean value indicating whether the volume is read-only.</p>
|
|
1397
|
+
*/
|
|
1398
|
+
ReadOnly?: boolean;
|
|
1399
|
+
/**
|
|
1400
|
+
* <p>The configuration object for mounting a Network File System (NFS) file
|
|
1401
|
+
* system.</p>
|
|
1402
|
+
*/
|
|
1403
|
+
NfsExports?: OpenZFSNfsExport[];
|
|
1404
|
+
/**
|
|
1405
|
+
* <p>An object specifying how much storage users or groups can use on the volume. </p>
|
|
1406
|
+
*/
|
|
1407
|
+
UserAndGroupQuotas?: OpenZFSUserOrGroupQuota[];
|
|
1408
|
+
}
|
|
1409
|
+
export declare namespace OpenZFSVolumeConfiguration {
|
|
1410
|
+
/**
|
|
1411
|
+
* @internal
|
|
1412
|
+
*/
|
|
1413
|
+
const filterSensitiveLog: (obj: OpenZFSVolumeConfiguration) => any;
|
|
1414
|
+
}
|
|
1415
|
+
export declare enum VolumeType {
|
|
1416
|
+
ONTAP = "ONTAP",
|
|
1417
|
+
OPENZFS = "OPENZFS"
|
|
1107
1418
|
}
|
|
1108
1419
|
/**
|
|
1109
1420
|
* <p>The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.</p>
|
|
@@ -1221,6 +1532,91 @@ export declare namespace InternalServerError {
|
|
|
1221
1532
|
*/
|
|
1222
1533
|
const filterSensitiveLog: (obj: InternalServerError) => any;
|
|
1223
1534
|
}
|
|
1535
|
+
export declare enum EventType {
|
|
1536
|
+
CHANGED = "CHANGED",
|
|
1537
|
+
DELETED = "DELETED",
|
|
1538
|
+
NEW = "NEW"
|
|
1539
|
+
}
|
|
1540
|
+
/**
|
|
1541
|
+
* <p>Describes a data repository association's automatic export policy. The
|
|
1542
|
+
* <code>AutoExportPolicy</code> defines the types of updated objects on the
|
|
1543
|
+
* file system that will be automatically exported to the data repository.
|
|
1544
|
+
* As you create, modify, or delete files, Amazon FSx automatically
|
|
1545
|
+
* exports the defined changes asynchronously once your application finishes
|
|
1546
|
+
* modifying the file.</p>
|
|
1547
|
+
* <p>This <code>AutoExportPolicy</code> is supported only for file systems with the
|
|
1548
|
+
* <code>Persistent_2</code> deployment type.</p>
|
|
1549
|
+
*/
|
|
1550
|
+
export interface AutoExportPolicy {
|
|
1551
|
+
/**
|
|
1552
|
+
* <p>The <code>AutoExportPolicy</code> can have the following event values:</p>
|
|
1553
|
+
* <ul>
|
|
1554
|
+
* <li>
|
|
1555
|
+
* <p>
|
|
1556
|
+
* <code>NEW</code> - Amazon FSx automatically exports new files and
|
|
1557
|
+
* directories to the data repository as they are added to the file system.</p>
|
|
1558
|
+
* </li>
|
|
1559
|
+
* <li>
|
|
1560
|
+
* <p>
|
|
1561
|
+
* <code>CHANGED</code> - Amazon FSx automatically exports changes to
|
|
1562
|
+
* files and directories on the file system to the data repository.</p>
|
|
1563
|
+
* </li>
|
|
1564
|
+
* <li>
|
|
1565
|
+
* <p>
|
|
1566
|
+
* <code>DELETED</code> - Files and directories are automatically deleted
|
|
1567
|
+
* on the data repository when they are deleted on the file system.</p>
|
|
1568
|
+
* </li>
|
|
1569
|
+
* </ul>
|
|
1570
|
+
* <p>You can define any combination of event types for your <code>AutoExportPolicy</code>.</p>
|
|
1571
|
+
*/
|
|
1572
|
+
Events?: (EventType | string)[];
|
|
1573
|
+
}
|
|
1574
|
+
export declare namespace AutoExportPolicy {
|
|
1575
|
+
/**
|
|
1576
|
+
* @internal
|
|
1577
|
+
*/
|
|
1578
|
+
const filterSensitiveLog: (obj: AutoExportPolicy) => any;
|
|
1579
|
+
}
|
|
1580
|
+
/**
|
|
1581
|
+
* <p>Describes the data repository association's automatic import policy.
|
|
1582
|
+
* The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory
|
|
1583
|
+
* listings up to date by importing changes to your file system as you modify
|
|
1584
|
+
* objects in a linked S3 bucket.</p>
|
|
1585
|
+
* <p>This <code>AutoImportPolicy</code> is supported only for file systems
|
|
1586
|
+
* with the <code>Persistent_2</code> deployment type.</p>
|
|
1587
|
+
*/
|
|
1588
|
+
export interface AutoImportPolicy {
|
|
1589
|
+
/**
|
|
1590
|
+
* <p>The <code>AutoImportPolicy</code> can have the following event values:</p>
|
|
1591
|
+
* <ul>
|
|
1592
|
+
* <li>
|
|
1593
|
+
* <p>
|
|
1594
|
+
* <code>NEW</code> - Amazon FSx automatically imports metadata of
|
|
1595
|
+
* files added to the linked S3 bucket that do not currently exist in the FSx
|
|
1596
|
+
* file system.</p>
|
|
1597
|
+
* </li>
|
|
1598
|
+
* <li>
|
|
1599
|
+
* <p>
|
|
1600
|
+
* <code>CHANGED</code> - Amazon FSx automatically updates file
|
|
1601
|
+
* metadata and invalidates existing file content on the file system as files
|
|
1602
|
+
* change in the data repository.</p>
|
|
1603
|
+
* </li>
|
|
1604
|
+
* <li>
|
|
1605
|
+
* <p>
|
|
1606
|
+
* <code>DELETED</code> - Amazon FSx automatically deletes files
|
|
1607
|
+
* on the file system as corresponding files are deleted in the data repository.</p>
|
|
1608
|
+
* </li>
|
|
1609
|
+
* </ul>
|
|
1610
|
+
* <p>You can define any combination of event types for your <code>AutoImportPolicy</code>.</p>
|
|
1611
|
+
*/
|
|
1612
|
+
Events?: (EventType | string)[];
|
|
1613
|
+
}
|
|
1614
|
+
export declare namespace AutoImportPolicy {
|
|
1615
|
+
/**
|
|
1616
|
+
* @internal
|
|
1617
|
+
*/
|
|
1618
|
+
const filterSensitiveLog: (obj: AutoImportPolicy) => any;
|
|
1619
|
+
}
|
|
1224
1620
|
/**
|
|
1225
1621
|
* <p>Cancels a data repository task.</p>
|
|
1226
1622
|
*/
|
|
@@ -1363,35 +1759,34 @@ export interface CopyBackupRequest {
|
|
|
1363
1759
|
*/
|
|
1364
1760
|
ClientRequestToken?: string;
|
|
1365
1761
|
/**
|
|
1366
|
-
* <p>The ID of the source backup. Specifies the ID of the backup that
|
|
1367
|
-
* being copied.</p>
|
|
1762
|
+
* <p>The ID of the source backup. Specifies the ID of the backup that's being copied.</p>
|
|
1368
1763
|
*/
|
|
1369
1764
|
SourceBackupId: string | undefined;
|
|
1370
1765
|
/**
|
|
1371
|
-
* <p>The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which
|
|
1372
|
-
*
|
|
1373
|
-
*
|
|
1374
|
-
*
|
|
1766
|
+
* <p>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
|
|
1767
|
+
* Regions must be in the same Amazon Web Services partition. If you don't specify a
|
|
1768
|
+
* Region, <code>SourceRegion</code> defaults to the Region where the request is sent from
|
|
1769
|
+
* (in-Region copy).</p>
|
|
1375
1770
|
*/
|
|
1376
1771
|
SourceRegion?: string;
|
|
1377
1772
|
/**
|
|
1378
|
-
* <p>The ID of the Key Management Service (KMS) key used to encrypt the file
|
|
1379
|
-
* for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and
|
|
1380
|
-
*
|
|
1381
|
-
*
|
|
1382
|
-
*
|
|
1773
|
+
* <p>The ID of the Key Management Service (KMS) key used to encrypt the file
|
|
1774
|
+
* system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for Lustre
|
|
1775
|
+
* <code>PERSISTENT_1</code> and <code>PERSISTENT_2</code> file systems at rest. If this ID
|
|
1776
|
+
* isn't specified, the key managed by Amazon FSx is used. The Amazon FSx for Lustre
|
|
1777
|
+
* <code>SCRATCH_1</code> and <code>SCRATCH_2</code> file systems are always encrypted at
|
|
1778
|
+
* rest using Amazon FSx-managed keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html">Encrypt</a>
|
|
1383
1779
|
* in the <i>Key Management Service API Reference</i>.</p>
|
|
1384
1780
|
*/
|
|
1385
1781
|
KmsKeyId?: string;
|
|
1386
1782
|
/**
|
|
1387
|
-
* <p>A
|
|
1388
|
-
*
|
|
1389
|
-
* <p>If you set <code>CopyTags</code> to true and the source backup has
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1392
|
-
*
|
|
1393
|
-
*
|
|
1394
|
-
* the tags created with the <code>Tags</code> parameter take precedence.</p>
|
|
1783
|
+
* <p>A Boolean flag indicating whether tags from the source backup should be copied to the
|
|
1784
|
+
* backup copy. This value defaults to <code>false</code>.</p>
|
|
1785
|
+
* <p>If you set <code>CopyTags</code> to <code>true</code> and the source backup has existing
|
|
1786
|
+
* tags, you can use the <code>Tags</code> parameter to create new tags, provided that the sum
|
|
1787
|
+
* of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are
|
|
1788
|
+
* merged. If there are tag conflicts (for example, two tags with the same key but different
|
|
1789
|
+
* values), the tags created with the <code>Tags</code> parameter take precedence.</p>
|
|
1395
1790
|
*/
|
|
1396
1791
|
CopyTags?: boolean;
|
|
1397
1792
|
/**
|
|
@@ -1411,7 +1806,7 @@ export declare namespace CopyBackupRequest {
|
|
|
1411
1806
|
*/
|
|
1412
1807
|
export interface BackupFailureDetails {
|
|
1413
1808
|
/**
|
|
1414
|
-
* <p>A message describing the backup
|
|
1809
|
+
* <p>A message describing the backup-creation failure.</p>
|
|
1415
1810
|
*/
|
|
1416
1811
|
Message?: string;
|
|
1417
1812
|
}
|
|
@@ -1463,9 +1858,8 @@ export declare namespace IncompatibleParameterError {
|
|
|
1463
1858
|
const filterSensitiveLog: (obj: IncompatibleParameterError) => any;
|
|
1464
1859
|
}
|
|
1465
1860
|
/**
|
|
1466
|
-
* <p>Amazon FSx doesn't support Multi-AZ Windows File Server
|
|
1467
|
-
*
|
|
1468
|
-
* can't be restored.</p>
|
|
1861
|
+
* <p>Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the
|
|
1862
|
+
* destination Region, so the copied backup can't be restored.</p>
|
|
1469
1863
|
*/
|
|
1470
1864
|
export interface IncompatibleRegionForMultiAZ extends __SmithyException, $MetadataBearer {
|
|
1471
1865
|
name: "IncompatibleRegionForMultiAZ";
|
|
@@ -1482,8 +1876,8 @@ export declare namespace IncompatibleRegionForMultiAZ {
|
|
|
1482
1876
|
const filterSensitiveLog: (obj: IncompatibleRegionForMultiAZ) => any;
|
|
1483
1877
|
}
|
|
1484
1878
|
/**
|
|
1485
|
-
* <p>The Key Management Service (KMS) key of the destination
|
|
1486
|
-
*
|
|
1879
|
+
* <p>The Key Management Service (KMS) key of the destination backup is not
|
|
1880
|
+
* valid.</p>
|
|
1487
1881
|
*/
|
|
1488
1882
|
export interface InvalidDestinationKmsKey extends __SmithyException, $MetadataBearer {
|
|
1489
1883
|
name: "InvalidDestinationKmsKey";
|
|
@@ -1500,8 +1894,8 @@ export declare namespace InvalidDestinationKmsKey {
|
|
|
1500
1894
|
const filterSensitiveLog: (obj: InvalidDestinationKmsKey) => any;
|
|
1501
1895
|
}
|
|
1502
1896
|
/**
|
|
1503
|
-
* <p>The Region provided for <code>
|
|
1504
|
-
*
|
|
1897
|
+
* <p>The Region provided for <code>SourceRegion</code> is not valid or is in a different
|
|
1898
|
+
* Amazon Web Services partition.</p>
|
|
1505
1899
|
*/
|
|
1506
1900
|
export interface InvalidRegion extends __SmithyException, $MetadataBearer {
|
|
1507
1901
|
name: "InvalidRegion";
|
|
@@ -1518,8 +1912,8 @@ export declare namespace InvalidRegion {
|
|
|
1518
1912
|
const filterSensitiveLog: (obj: InvalidRegion) => any;
|
|
1519
1913
|
}
|
|
1520
1914
|
/**
|
|
1521
|
-
* <p>The Key Management Service (KMS) key of the source backup
|
|
1522
|
-
*
|
|
1915
|
+
* <p>The Key Management Service (KMS) key of the source backup is not
|
|
1916
|
+
* valid.</p>
|
|
1523
1917
|
*/
|
|
1524
1918
|
export interface InvalidSourceKmsKey extends __SmithyException, $MetadataBearer {
|
|
1525
1919
|
name: "InvalidSourceKmsKey";
|
|
@@ -1569,8 +1963,8 @@ export declare namespace ServiceLimitExceeded {
|
|
|
1569
1963
|
const filterSensitiveLog: (obj: ServiceLimitExceeded) => any;
|
|
1570
1964
|
}
|
|
1571
1965
|
/**
|
|
1572
|
-
* <p>The request was rejected because the lifecycle status of the
|
|
1573
|
-
*
|
|
1966
|
+
* <p>The request was rejected because the lifecycle status of the source backup isn't
|
|
1967
|
+
* <code>AVAILABLE</code>.</p>
|
|
1574
1968
|
*/
|
|
1575
1969
|
export interface SourceBackupUnavailable extends __SmithyException, $MetadataBearer {
|
|
1576
1970
|
name: "SourceBackupUnavailable";
|
|
@@ -1580,7 +1974,7 @@ export interface SourceBackupUnavailable extends __SmithyException, $MetadataBea
|
|
|
1580
1974
|
*/
|
|
1581
1975
|
Message?: string;
|
|
1582
1976
|
/**
|
|
1583
|
-
* <p>The ID of the source backup. Specifies the backup you are copying.</p>
|
|
1977
|
+
* <p>The ID of the source backup. Specifies the backup that you are copying.</p>
|
|
1584
1978
|
*/
|
|
1585
1979
|
BackupId?: string;
|
|
1586
1980
|
}
|
|
@@ -1617,19 +2011,21 @@ export interface CreateBackupRequest {
|
|
|
1617
2011
|
*/
|
|
1618
2012
|
FileSystemId?: string;
|
|
1619
2013
|
/**
|
|
1620
|
-
* <p>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
|
|
1621
|
-
* idempotent creation. This string is automatically filled on your behalf when you
|
|
1622
|
-
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
2014
|
+
* <p>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to
|
|
2015
|
+
* ensure idempotent creation. This string is automatically filled on your behalf when you
|
|
2016
|
+
* use the Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
1623
2017
|
*/
|
|
1624
2018
|
ClientRequestToken?: string;
|
|
1625
2019
|
/**
|
|
1626
2020
|
* <p>(Optional) The tags to apply to the backup at backup creation. The key value of the
|
|
1627
|
-
*
|
|
1628
|
-
*
|
|
2021
|
+
* <code>Name</code> tag appears in the console as the backup name. If you have set
|
|
2022
|
+
* <code>CopyTagsToBackups</code> to <code>true</code>, and you specify one or more
|
|
2023
|
+
* tags using the <code>CreateBackup</code> operation, no existing file system tags are
|
|
2024
|
+
* copied from the file system to the backup.</p>
|
|
1629
2025
|
*/
|
|
1630
2026
|
Tags?: Tag[];
|
|
1631
2027
|
/**
|
|
1632
|
-
* <p>The ID of
|
|
2028
|
+
* <p>(Optional) The ID of the FSx for ONTAP volume to back up.</p>
|
|
1633
2029
|
*/
|
|
1634
2030
|
VolumeId?: string;
|
|
1635
2031
|
}
|
|
@@ -1656,7 +2052,265 @@ export declare namespace VolumeNotFound {
|
|
|
1656
2052
|
*/
|
|
1657
2053
|
const filterSensitiveLog: (obj: VolumeNotFound) => any;
|
|
1658
2054
|
}
|
|
1659
|
-
|
|
2055
|
+
/**
|
|
2056
|
+
* <p>The configuration for an Amazon S3 data repository linked to an
|
|
2057
|
+
* Amazon FSx Lustre file system with a data repository association.
|
|
2058
|
+
* The configuration consists of an <code>AutoImportPolicy</code> that
|
|
2059
|
+
* defines file events on the data repository are automatically
|
|
2060
|
+
* imported to the file system and an <code>AutoExportPolicy</code>
|
|
2061
|
+
* that defines which file events on the file system are automatically
|
|
2062
|
+
* exported to the data repository. File events are when files or
|
|
2063
|
+
* directories are added, changed, or deleted on the file system or
|
|
2064
|
+
* the data repository.</p>
|
|
2065
|
+
*/
|
|
2066
|
+
export interface S3DataRepositoryConfiguration {
|
|
2067
|
+
/**
|
|
2068
|
+
* <p>Specifies the type of updated objects (new, changed, deleted)
|
|
2069
|
+
* that will be automatically imported from the linked S3 bucket
|
|
2070
|
+
* to your file system.</p>
|
|
2071
|
+
*/
|
|
2072
|
+
AutoImportPolicy?: AutoImportPolicy;
|
|
2073
|
+
/**
|
|
2074
|
+
* <p>Specifies the type of updated objects (new, changed, deleted)
|
|
2075
|
+
* that will be automatically exported from your file system to
|
|
2076
|
+
* the linked S3 bucket.</p>
|
|
2077
|
+
*/
|
|
2078
|
+
AutoExportPolicy?: AutoExportPolicy;
|
|
2079
|
+
}
|
|
2080
|
+
export declare namespace S3DataRepositoryConfiguration {
|
|
2081
|
+
/**
|
|
2082
|
+
* @internal
|
|
2083
|
+
*/
|
|
2084
|
+
const filterSensitiveLog: (obj: S3DataRepositoryConfiguration) => any;
|
|
2085
|
+
}
|
|
2086
|
+
export interface CreateDataRepositoryAssociationRequest {
|
|
2087
|
+
/**
|
|
2088
|
+
* <p>The globally unique ID of the file system, assigned by Amazon FSx.</p>
|
|
2089
|
+
*/
|
|
2090
|
+
FileSystemId: string | undefined;
|
|
2091
|
+
/**
|
|
2092
|
+
* <p>A path on the file system that points to a high-level directory (such
|
|
2093
|
+
* as <code>/ns1/</code>) or subdirectory (such as <code>/ns1/subdir/</code>)
|
|
2094
|
+
* that will be mapped 1-1 with <code>DataRepositoryPath</code>.
|
|
2095
|
+
* The leading forward slash in the name is required. Two data repository
|
|
2096
|
+
* associations cannot have overlapping file system paths. For example, if
|
|
2097
|
+
* a data repository is associated with file system path <code>/ns1/</code>,
|
|
2098
|
+
* then you cannot link another data repository with file system
|
|
2099
|
+
* path <code>/ns1/ns2</code>.</p>
|
|
2100
|
+
* <p>This path specifies where in your file system files will be exported
|
|
2101
|
+
* from or imported to. This file system directory can be linked to only one
|
|
2102
|
+
* Amazon S3 bucket, and no other S3 bucket can be linked to the directory.</p>
|
|
2103
|
+
*/
|
|
2104
|
+
FileSystemPath: string | undefined;
|
|
2105
|
+
/**
|
|
2106
|
+
* <p>The path to the Amazon S3 data repository that will be linked to the file
|
|
2107
|
+
* system. The path can be an S3 bucket or prefix in the format
|
|
2108
|
+
* <code>s3://myBucket/myPrefix/</code>. This path specifies where in the S3
|
|
2109
|
+
* data repository files will be imported from or exported to.</p>
|
|
2110
|
+
*/
|
|
2111
|
+
DataRepositoryPath: string | undefined;
|
|
2112
|
+
/**
|
|
2113
|
+
* <p>Set to <code>true</code> to run an import data repository task to import
|
|
2114
|
+
* metadata from the data repository to the file system after the data repository
|
|
2115
|
+
* association is created. Default is <code>false</code>.</p>
|
|
2116
|
+
*/
|
|
2117
|
+
BatchImportMetaDataOnCreate?: boolean;
|
|
2118
|
+
/**
|
|
2119
|
+
* <p>For files imported from a data repository, this value determines the stripe count and
|
|
2120
|
+
* maximum amount of data per file (in MiB) stored on a single physical disk. The maximum
|
|
2121
|
+
* number of disks that a single file can be striped across is limited by the total number
|
|
2122
|
+
* of disks that make up the file system.</p>
|
|
2123
|
+
*
|
|
2124
|
+
* <p>The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500
|
|
2125
|
+
* GiB). Amazon S3 objects have a maximum size of 5 TB.</p>
|
|
2126
|
+
*/
|
|
2127
|
+
ImportedFileChunkSize?: number;
|
|
2128
|
+
/**
|
|
2129
|
+
* <p>The configuration for an Amazon S3 data repository linked to an
|
|
2130
|
+
* Amazon FSx Lustre file system with a data repository association.
|
|
2131
|
+
* The configuration defines which file events (new, changed, or
|
|
2132
|
+
* deleted files or directories) are automatically imported from
|
|
2133
|
+
* the linked data repository to the file system or automatically
|
|
2134
|
+
* exported from the file system to the data repository.</p>
|
|
2135
|
+
*/
|
|
2136
|
+
S3?: S3DataRepositoryConfiguration;
|
|
2137
|
+
/**
|
|
2138
|
+
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
2139
|
+
* ASCII characters. This token is automatically filled on your behalf when you use the
|
|
2140
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
2141
|
+
*/
|
|
2142
|
+
ClientRequestToken?: string;
|
|
2143
|
+
/**
|
|
2144
|
+
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
2145
|
+
*/
|
|
2146
|
+
Tags?: Tag[];
|
|
2147
|
+
}
|
|
2148
|
+
export declare namespace CreateDataRepositoryAssociationRequest {
|
|
2149
|
+
/**
|
|
2150
|
+
* @internal
|
|
2151
|
+
*/
|
|
2152
|
+
const filterSensitiveLog: (obj: CreateDataRepositoryAssociationRequest) => any;
|
|
2153
|
+
}
|
|
2154
|
+
/**
|
|
2155
|
+
* <p>The configuration of a data repository association that links
|
|
2156
|
+
* an Amazon FSx for Lustre file system to an Amazon S3 bucket.
|
|
2157
|
+
* The data repository association configuration object is returned
|
|
2158
|
+
* in the response of the following operations:</p>
|
|
2159
|
+
* <ul>
|
|
2160
|
+
* <li>
|
|
2161
|
+
* <p>
|
|
2162
|
+
* <code>CreateDataRepositoryAssociation</code>
|
|
2163
|
+
* </p>
|
|
2164
|
+
* </li>
|
|
2165
|
+
* <li>
|
|
2166
|
+
* <p>
|
|
2167
|
+
* <code>UpdateDataRepositoryAssociation</code>
|
|
2168
|
+
* </p>
|
|
2169
|
+
* </li>
|
|
2170
|
+
* <li>
|
|
2171
|
+
* <p>
|
|
2172
|
+
* <code>DescribeDataRepositoryAssociations</code>
|
|
2173
|
+
* </p>
|
|
2174
|
+
* </li>
|
|
2175
|
+
* </ul>
|
|
2176
|
+
* <p>Data repository associations are supported only for file systems
|
|
2177
|
+
* with the <code>Persistent_2</code> deployment type.</p>
|
|
2178
|
+
*/
|
|
2179
|
+
export interface DataRepositoryAssociation {
|
|
2180
|
+
/**
|
|
2181
|
+
* <p>The system-generated, unique ID of the data repository association.</p>
|
|
2182
|
+
*/
|
|
2183
|
+
AssociationId?: string;
|
|
2184
|
+
/**
|
|
2185
|
+
* <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services
|
|
2186
|
+
* resources. We require an ARN when you need to specify a resource unambiguously across
|
|
2187
|
+
* all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in
|
|
2188
|
+
* the <i>Amazon Web Services General Reference</i>.</p>
|
|
2189
|
+
*/
|
|
2190
|
+
ResourceARN?: string;
|
|
2191
|
+
/**
|
|
2192
|
+
* <p>The globally unique ID of the file system, assigned by Amazon FSx.</p>
|
|
2193
|
+
*/
|
|
2194
|
+
FileSystemId?: string;
|
|
2195
|
+
/**
|
|
2196
|
+
* <p>Describes the state of a data repository association. The lifecycle can have
|
|
2197
|
+
* the following values:</p>
|
|
2198
|
+
* <ul>
|
|
2199
|
+
* <li>
|
|
2200
|
+
* <p>
|
|
2201
|
+
* <code>CREATING</code> - The data repository association between
|
|
2202
|
+
* the FSx file system and the S3 data repository is being created.
|
|
2203
|
+
* The data repository is unavailable.</p>
|
|
2204
|
+
* </li>
|
|
2205
|
+
* <li>
|
|
2206
|
+
* <p>
|
|
2207
|
+
* <code>AVAILABLE</code> - The data repository association is
|
|
2208
|
+
* available for use.</p>
|
|
2209
|
+
* </li>
|
|
2210
|
+
* <li>
|
|
2211
|
+
* <p>
|
|
2212
|
+
* <code>MISCONFIGURED</code> - Amazon FSx cannot automatically import updates
|
|
2213
|
+
* from the S3 bucket or automatically export updates to the S3 bucket until the data
|
|
2214
|
+
* repository association configuration is corrected.</p>
|
|
2215
|
+
* </li>
|
|
2216
|
+
* <li>
|
|
2217
|
+
* <p>
|
|
2218
|
+
* <code>UPDATING</code> - The data repository association is undergoing
|
|
2219
|
+
* a customer initiated update that might affect its availability.</p>
|
|
2220
|
+
* </li>
|
|
2221
|
+
* <li>
|
|
2222
|
+
* <p>
|
|
2223
|
+
* <code>DELETING</code> - The data repository association is undergoing
|
|
2224
|
+
* a customer initiated deletion.</p>
|
|
2225
|
+
* </li>
|
|
2226
|
+
* <li>
|
|
2227
|
+
* <p>
|
|
2228
|
+
* <code>FAILED</code> - The data repository association is in a terminal
|
|
2229
|
+
* state that cannot be recovered.</p>
|
|
2230
|
+
* </li>
|
|
2231
|
+
* </ul>
|
|
2232
|
+
*/
|
|
2233
|
+
Lifecycle?: DataRepositoryLifecycle | string;
|
|
2234
|
+
/**
|
|
2235
|
+
* <p>Provides detailed information about the data respository if its <code>Lifecycle</code> is
|
|
2236
|
+
* set to <code>MISCONFIGURED</code> or <code>FAILED</code>.</p>
|
|
2237
|
+
*/
|
|
2238
|
+
FailureDetails?: DataRepositoryFailureDetails;
|
|
2239
|
+
/**
|
|
2240
|
+
* <p>A path on the file system that points to a high-level directory (such
|
|
2241
|
+
* as <code>/ns1/</code>) or subdirectory (such as <code>/ns1/subdir/</code>)
|
|
2242
|
+
* that will be mapped 1-1 with <code>DataRepositoryPath</code>.
|
|
2243
|
+
* The leading forward slash in the name is required. Two data repository
|
|
2244
|
+
* associations cannot have overlapping file system paths. For example, if
|
|
2245
|
+
* a data repository is associated with file system path <code>/ns1/</code>,
|
|
2246
|
+
* then you cannot link another data repository with file system
|
|
2247
|
+
* path <code>/ns1/ns2</code>.</p>
|
|
2248
|
+
* <p>This path specifies where in your file system files will be exported
|
|
2249
|
+
* from or imported to. This file system directory can be linked to only one
|
|
2250
|
+
* Amazon S3 bucket, and no other S3 bucket can be linked to the directory. </p>
|
|
2251
|
+
*/
|
|
2252
|
+
FileSystemPath?: string;
|
|
2253
|
+
/**
|
|
2254
|
+
* <p>The path to the Amazon S3 data repository that will be linked to the file
|
|
2255
|
+
* system. The path can be an S3 bucket or prefix in the format
|
|
2256
|
+
* <code>s3://myBucket/myPrefix/</code>. This path specifies where in the S3
|
|
2257
|
+
* data repository files will be imported from or exported to.</p>
|
|
2258
|
+
*/
|
|
2259
|
+
DataRepositoryPath?: string;
|
|
2260
|
+
/**
|
|
2261
|
+
* <p>A boolean flag indicating whether an import data repository task to import
|
|
2262
|
+
* metadata should run after the data repository association is created. The
|
|
2263
|
+
* task runs if this flag is set to <code>true</code>.</p>
|
|
2264
|
+
*/
|
|
2265
|
+
BatchImportMetaDataOnCreate?: boolean;
|
|
2266
|
+
/**
|
|
2267
|
+
* <p>For files imported from a data repository, this value determines the stripe count and
|
|
2268
|
+
* maximum amount of data per file (in MiB) stored on a single physical disk. The maximum
|
|
2269
|
+
* number of disks that a single file can be striped across is limited by the total number
|
|
2270
|
+
* of disks that make up the file system.</p>
|
|
2271
|
+
*
|
|
2272
|
+
* <p>The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500
|
|
2273
|
+
* GiB). Amazon S3 objects have a maximum size of 5 TB.</p>
|
|
2274
|
+
*/
|
|
2275
|
+
ImportedFileChunkSize?: number;
|
|
2276
|
+
/**
|
|
2277
|
+
* <p>The configuration for an Amazon S3 data repository linked to an
|
|
2278
|
+
* Amazon FSx Lustre file system with a data repository association.
|
|
2279
|
+
* The configuration defines which file events (new, changed, or
|
|
2280
|
+
* deleted files or directories) are automatically imported from
|
|
2281
|
+
* the linked data repository to the file system or automatically
|
|
2282
|
+
* exported from the file system to the data repository.</p>
|
|
2283
|
+
*/
|
|
2284
|
+
S3?: S3DataRepositoryConfiguration;
|
|
2285
|
+
/**
|
|
2286
|
+
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
2287
|
+
*/
|
|
2288
|
+
Tags?: Tag[];
|
|
2289
|
+
/**
|
|
2290
|
+
* <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z),
|
|
2291
|
+
* also known as Unix time.</p>
|
|
2292
|
+
*/
|
|
2293
|
+
CreationTime?: Date;
|
|
2294
|
+
}
|
|
2295
|
+
export declare namespace DataRepositoryAssociation {
|
|
2296
|
+
/**
|
|
2297
|
+
* @internal
|
|
2298
|
+
*/
|
|
2299
|
+
const filterSensitiveLog: (obj: DataRepositoryAssociation) => any;
|
|
2300
|
+
}
|
|
2301
|
+
export interface CreateDataRepositoryAssociationResponse {
|
|
2302
|
+
/**
|
|
2303
|
+
* <p>The response object returned after the data repository association is created.</p>
|
|
2304
|
+
*/
|
|
2305
|
+
Association?: DataRepositoryAssociation;
|
|
2306
|
+
}
|
|
2307
|
+
export declare namespace CreateDataRepositoryAssociationResponse {
|
|
2308
|
+
/**
|
|
2309
|
+
* @internal
|
|
2310
|
+
*/
|
|
2311
|
+
const filterSensitiveLog: (obj: CreateDataRepositoryAssociationResponse) => any;
|
|
2312
|
+
}
|
|
2313
|
+
export declare enum ReportFormat {
|
|
1660
2314
|
REPORT_CSV_20191124 = "REPORT_CSV_20191124"
|
|
1661
2315
|
}
|
|
1662
2316
|
export declare enum ReportScope {
|
|
@@ -1703,7 +2357,8 @@ export declare namespace CompletionReport {
|
|
|
1703
2357
|
const filterSensitiveLog: (obj: CompletionReport) => any;
|
|
1704
2358
|
}
|
|
1705
2359
|
export declare enum DataRepositoryTaskType {
|
|
1706
|
-
EXPORT = "EXPORT_TO_REPOSITORY"
|
|
2360
|
+
EXPORT = "EXPORT_TO_REPOSITORY",
|
|
2361
|
+
IMPORT = "IMPORT_METADATA_FROM_REPOSITORY"
|
|
1707
2362
|
}
|
|
1708
2363
|
export interface CreateDataRepositoryTaskRequest {
|
|
1709
2364
|
/**
|
|
@@ -1793,7 +2448,7 @@ export declare namespace DataRepositoryTaskStatus {
|
|
|
1793
2448
|
}
|
|
1794
2449
|
/**
|
|
1795
2450
|
* <p>A description of the data repository task. You use data repository tasks
|
|
1796
|
-
* to perform bulk transfer operations between your Amazon FSx file system and
|
|
2451
|
+
* to perform bulk transfer operations between your Amazon FSx file system and a linked data
|
|
1797
2452
|
* repository.</p>
|
|
1798
2453
|
*/
|
|
1799
2454
|
export interface DataRepositoryTask {
|
|
@@ -1839,7 +2494,17 @@ export interface DataRepositoryTask {
|
|
|
1839
2494
|
*/
|
|
1840
2495
|
Lifecycle: DataRepositoryTaskLifecycle | string | undefined;
|
|
1841
2496
|
/**
|
|
1842
|
-
* <p>The type of data repository task
|
|
2497
|
+
* <p>The type of data repository task.</p>
|
|
2498
|
+
* <ul>
|
|
2499
|
+
* <li>
|
|
2500
|
+
* <p>The <code>EXPORT_TO_REPOSITORY</code> data repository task exports
|
|
2501
|
+
* from your Lustre file system from to a linked S3 bucket.</p>
|
|
2502
|
+
* </li>
|
|
2503
|
+
* <li>
|
|
2504
|
+
* <p>The <code>IMPORT_METADATA_FROM_REPOSITORY</code> data repository task
|
|
2505
|
+
* imports metadata changes from a linked S3 bucket to your Lustre file system.</p>
|
|
2506
|
+
* </li>
|
|
2507
|
+
* </ul>
|
|
1843
2508
|
*/
|
|
1844
2509
|
Type: DataRepositoryTaskType | string | undefined;
|
|
1845
2510
|
/**
|
|
@@ -1929,8 +2594,111 @@ export declare namespace DataRepositoryTaskExecuting {
|
|
|
1929
2594
|
const filterSensitiveLog: (obj: DataRepositoryTaskExecuting) => any;
|
|
1930
2595
|
}
|
|
1931
2596
|
/**
|
|
1932
|
-
* <p>The Lustre configuration
|
|
1933
|
-
*
|
|
2597
|
+
* <p>The Lustre logging configuration used when creating or updating an
|
|
2598
|
+
* Amazon FSx for Lustre file system. Lustre logging writes the enabled
|
|
2599
|
+
* logging events for your file system to Amazon CloudWatch Logs.</p>
|
|
2600
|
+
* <p>Error and warning events can be logged from the following data
|
|
2601
|
+
* repository operations:</p>
|
|
2602
|
+
* <ul>
|
|
2603
|
+
* <li>
|
|
2604
|
+
* <p>Automatic export</p>
|
|
2605
|
+
* </li>
|
|
2606
|
+
* <li>
|
|
2607
|
+
* <p>Data repository tasks</p>
|
|
2608
|
+
* </li>
|
|
2609
|
+
* </ul>
|
|
2610
|
+
* <p>To learn more about Lustre logging, see
|
|
2611
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/cw-event-logging.html">Logging to Amazon CloudWatch Logs</a>.</p>
|
|
2612
|
+
*/
|
|
2613
|
+
export interface LustreLogCreateConfiguration {
|
|
2614
|
+
/**
|
|
2615
|
+
* <p>Sets which data repository events are logged by Amazon FSx.</p>
|
|
2616
|
+
* <ul>
|
|
2617
|
+
* <li>
|
|
2618
|
+
* <p>
|
|
2619
|
+
* <code>WARN_ONLY</code> - only warning events are logged.</p>
|
|
2620
|
+
* </li>
|
|
2621
|
+
* <li>
|
|
2622
|
+
* <p>
|
|
2623
|
+
* <code>ERROR_ONLY</code> - only error events are logged.</p>
|
|
2624
|
+
* </li>
|
|
2625
|
+
* <li>
|
|
2626
|
+
* <p>
|
|
2627
|
+
* <code>WARN_ERROR</code> - both warning events and error events
|
|
2628
|
+
* are logged.</p>
|
|
2629
|
+
* </li>
|
|
2630
|
+
* <li>
|
|
2631
|
+
* <p>
|
|
2632
|
+
* <code>DISABLED</code> - logging of data repository events
|
|
2633
|
+
* is turned off.</p>
|
|
2634
|
+
* </li>
|
|
2635
|
+
* </ul>
|
|
2636
|
+
*/
|
|
2637
|
+
Level: LustreAccessAuditLogLevel | string | undefined;
|
|
2638
|
+
/**
|
|
2639
|
+
* <p>The Amazon Resource Name (ARN) that specifies the destination of the logs.</p>
|
|
2640
|
+
* <p>The destination can be any Amazon CloudWatch Logs log group ARN, with the following
|
|
2641
|
+
* requirements:</p>
|
|
2642
|
+
* <ul>
|
|
2643
|
+
* <li>
|
|
2644
|
+
* <p>The destination ARN that you provide must be in the same Amazon Web Services partition,
|
|
2645
|
+
* Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.</p>
|
|
2646
|
+
* </li>
|
|
2647
|
+
* <li>
|
|
2648
|
+
* <p>The name of the Amazon CloudWatch Logs log group must begin with
|
|
2649
|
+
* the <code>/aws/fsx</code> prefix.</p>
|
|
2650
|
+
* </li>
|
|
2651
|
+
* <li>
|
|
2652
|
+
* <p>If you do not provide a destination, Amazon FSx will create and use a
|
|
2653
|
+
* log stream in the CloudWatch Logs <code>/aws/fsx/lustre</code> log group.</p>
|
|
2654
|
+
* </li>
|
|
2655
|
+
* <li>
|
|
2656
|
+
* <p>If <code>Destination</code> is provided and the resource does not
|
|
2657
|
+
* exist, the request will fail with a <code>BadRequest</code> error.</p>
|
|
2658
|
+
* </li>
|
|
2659
|
+
* <li>
|
|
2660
|
+
* <p>If <code>Level</code> is set to <code>DISABLED</code>, you cannot specify
|
|
2661
|
+
* a destination in <code>Destination</code>.</p>
|
|
2662
|
+
* </li>
|
|
2663
|
+
* </ul>
|
|
2664
|
+
*/
|
|
2665
|
+
Destination?: string;
|
|
2666
|
+
}
|
|
2667
|
+
export declare namespace LustreLogCreateConfiguration {
|
|
2668
|
+
/**
|
|
2669
|
+
* @internal
|
|
2670
|
+
*/
|
|
2671
|
+
const filterSensitiveLog: (obj: LustreLogCreateConfiguration) => any;
|
|
2672
|
+
}
|
|
2673
|
+
/**
|
|
2674
|
+
* <p>The Lustre configuration for the file system being created.</p>
|
|
2675
|
+
* <note>
|
|
2676
|
+
* <p>The following parameters are not supported for file systems with the <code>Persistent_2</code>
|
|
2677
|
+
* deployment type. Instead, use <code>CreateDataRepositoryAssociation</code>
|
|
2678
|
+
* to create a data repository association to link your Lustre file system to a data repository.</p>
|
|
2679
|
+
* <ul>
|
|
2680
|
+
* <li>
|
|
2681
|
+
* <p>
|
|
2682
|
+
* <code>AutoImportPolicy</code>
|
|
2683
|
+
* </p>
|
|
2684
|
+
* </li>
|
|
2685
|
+
* <li>
|
|
2686
|
+
* <p>
|
|
2687
|
+
* <code>ExportPath</code>
|
|
2688
|
+
* </p>
|
|
2689
|
+
* </li>
|
|
2690
|
+
* <li>
|
|
2691
|
+
* <p>
|
|
2692
|
+
* <code>ImportedChunkSize</code>
|
|
2693
|
+
* </p>
|
|
2694
|
+
* </li>
|
|
2695
|
+
* <li>
|
|
2696
|
+
* <p>
|
|
2697
|
+
* <code>ImportPath</code>
|
|
2698
|
+
* </p>
|
|
2699
|
+
* </li>
|
|
2700
|
+
* </ul>
|
|
2701
|
+
* </note>
|
|
1934
2702
|
*/
|
|
1935
2703
|
export interface CreateFileSystemLustreConfiguration {
|
|
1936
2704
|
/**
|
|
@@ -1946,24 +2714,35 @@ export interface CreateFileSystemLustreConfiguration {
|
|
|
1946
2714
|
* example is <code>s3://import-bucket/optional-prefix</code>. If you specify a prefix
|
|
1947
2715
|
* after the Amazon S3 bucket name, only object keys with that prefix are loaded into the
|
|
1948
2716
|
* file system.</p>
|
|
2717
|
+
* <note>
|
|
2718
|
+
* <p>This parameter is not supported for file systems with the <code>Persistent_2</code> deployment type.
|
|
2719
|
+
* Instead, use <code>CreateDataRepositoryAssociation</code> to create
|
|
2720
|
+
* a data repository association to link your Lustre file system to a data repository.</p>
|
|
2721
|
+
* </note>
|
|
1949
2722
|
*/
|
|
1950
2723
|
ImportPath?: string;
|
|
1951
2724
|
/**
|
|
1952
|
-
* <p>(Optional)
|
|
2725
|
+
* <p>(Optional) Available with <code>Scratch</code> and <code>Persistent_1</code> deployment types.
|
|
2726
|
+
* Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported.
|
|
1953
2727
|
* The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which
|
|
1954
2728
|
* new and changed data is to be exported from your Amazon FSx for Lustre file system. If
|
|
1955
2729
|
* an <code>ExportPath</code> value is not provided, Amazon FSx sets a default export path,
|
|
1956
2730
|
* <code>s3://import-bucket/FSxLustre[creation-timestamp]</code>. The timestamp is in
|
|
1957
2731
|
* UTC format, for example
|
|
1958
2732
|
* <code>s3://import-bucket/FSxLustre20181105T222312Z</code>.</p>
|
|
1959
|
-
*
|
|
1960
2733
|
* <p>The Amazon S3 export bucket must be the same as the import bucket specified by
|
|
1961
|
-
*
|
|
1962
|
-
*
|
|
2734
|
+
* <code>ImportPath</code>. If you specify only a bucket name, such as
|
|
2735
|
+
* <code>s3://import-bucket</code>, you get a 1:1 mapping of file system objects to S3
|
|
1963
2736
|
* bucket objects. This mapping means that the input data in S3 is overwritten on export.
|
|
1964
2737
|
* If you provide a custom prefix in the export path, such as
|
|
1965
2738
|
* <code>s3://import-bucket/[custom-optional-prefix]</code>, Amazon FSx exports the contents of your file
|
|
1966
2739
|
* system to that export prefix in the Amazon S3 bucket.</p>
|
|
2740
|
+
*
|
|
2741
|
+
* <note>
|
|
2742
|
+
* <p>This parameter is not supported for file systems with the <code>Persistent_2</code> deployment type.
|
|
2743
|
+
* Instead, use <code>CreateDataRepositoryAssociation</code> to create
|
|
2744
|
+
* a data repository association to link your Lustre file system to a data repository.</p>
|
|
2745
|
+
* </note>
|
|
1967
2746
|
*/
|
|
1968
2747
|
ExportPath?: string;
|
|
1969
2748
|
/**
|
|
@@ -1973,36 +2752,50 @@ export interface CreateFileSystemLustreConfiguration {
|
|
|
1973
2752
|
* number of disks that make up the file system.</p>
|
|
1974
2753
|
*
|
|
1975
2754
|
* <p>The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500
|
|
1976
|
-
* GiB). Amazon S3
|
|
2755
|
+
* GiB). Amazon S3 objects have a maximum size of 5 TB.</p>
|
|
2756
|
+
* <p>This parameter is not supported for file systems with the <code>Persistent_2</code> deployment type.
|
|
2757
|
+
* Instead, use <code>CreateDataRepositoryAssociation</code> to create
|
|
2758
|
+
* a data repository association to link your Lustre file system to a data repository.</p>
|
|
1977
2759
|
*/
|
|
1978
2760
|
ImportedFileChunkSize?: number;
|
|
1979
2761
|
/**
|
|
1980
|
-
* <p>
|
|
1981
|
-
* Choose <code>SCRATCH_1</code> and <code>SCRATCH_2</code> deployment
|
|
2762
|
+
* <p>(Optional) Choose <code>SCRATCH_1</code> and <code>SCRATCH_2</code> deployment
|
|
1982
2763
|
* types when you need temporary storage and shorter-term processing of data.
|
|
1983
2764
|
* The <code>SCRATCH_2</code> deployment type provides in-transit encryption of data and higher burst
|
|
1984
2765
|
* throughput capacity than <code>SCRATCH_1</code>.</p>
|
|
2766
|
+
* <p>Choose <code>PERSISTENT_1</code> for longer-term storage and for throughput-focused
|
|
2767
|
+
* workloads that aren’t latency-sensitive. a.
|
|
2768
|
+
* <code>PERSISTENT_1</code> supports encryption of data in transit, and is available in all
|
|
2769
|
+
* Amazon Web Services Regions in which FSx for Lustre is available.</p>
|
|
2770
|
+
* <p>Choose <code>PERSISTENT_2</code> for longer-term storage and for latency-sensitive workloads
|
|
2771
|
+
* that require the highest levels of IOPS/throughput. <code>PERSISTENT_2</code> supports
|
|
2772
|
+
* SSD storage, and offers higher <code>PerUnitStorageThroughput</code> (up to 1000 MB/s/TiB). <code>PERSISTENT_2</code>
|
|
2773
|
+
* is available in a limited number of Amazon Web Services Regions.
|
|
2774
|
+
* For more information, and an up-to-date list of Amazon Web Services Regions in which
|
|
2775
|
+
* <code>PERSISTENT_2</code> is available, see
|
|
2776
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-fsx-lustre.html#lustre-deployment-types">File
|
|
2777
|
+
* system deployment options for FSx for Lustre</a> in the <i>Amazon FSx for Lustre User Guide</i>.</p>
|
|
2778
|
+
* <note>
|
|
2779
|
+
* <p>If you choose <code>PERSISTENT_2</code>, and you set <code>FileSystemTypeVersion</code> to
|
|
2780
|
+
* <code>2.10</code>, the <code>CreateFileSystem</code> operation fails.</p>
|
|
2781
|
+
* </note>
|
|
1985
2782
|
*
|
|
1986
|
-
* <p>
|
|
1987
|
-
*
|
|
1988
|
-
*
|
|
1989
|
-
*
|
|
1990
|
-
*
|
|
1991
|
-
*
|
|
1992
|
-
*
|
|
1993
|
-
* (Default = <code>SCRATCH_1</code>)
|
|
1994
|
-
* </p>
|
|
1995
|
-
* <p>Encryption of data in-transit for <code>SCRATCH_2</code> and <code>PERSISTENT_1</code>
|
|
1996
|
-
* deployment types is supported when accessed from supported instance types in supported Amazon Web Services Regions. To learn more,
|
|
1997
|
-
* <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html">Encrypting Data in Transit</a>.</p>
|
|
2783
|
+
* <p>Encryption of data in transit is automatically turned on when you access
|
|
2784
|
+
* <code>SCRATCH_2</code>, <code>PERSISTENT_1</code> and <code>PERSISTENT_2</code> file
|
|
2785
|
+
* systems from Amazon EC2 instances that <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html">support
|
|
2786
|
+
* automatic encryption</a> in the Amazon Web Services Regions where they are
|
|
2787
|
+
* available. For more information about encryption in transit for FSx for Lustre
|
|
2788
|
+
* file systems, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html">Encrypting data in
|
|
2789
|
+
* transit</a> in the <i>Amazon FSx for Lustre User Guide</i>. </p>
|
|
2790
|
+
* <p>(Default = <code>SCRATCH_1</code>)</p>
|
|
1998
2791
|
*/
|
|
1999
2792
|
DeploymentType?: LustreDeploymentType | string;
|
|
2000
2793
|
/**
|
|
2001
|
-
* <p> (Optional)
|
|
2794
|
+
* <p> (Optional) Available with <code>Scratch</code> and <code>Persistent_1</code> deployment types. When you
|
|
2795
|
+
* create your file system, your existing S3 objects appear as file and directory listings.
|
|
2002
2796
|
* Use this property to choose how Amazon FSx keeps your file and directory listings up to date
|
|
2003
2797
|
* as you add or modify objects in your linked S3 bucket. <code>AutoImportPolicy</code> can
|
|
2004
2798
|
* have the following values:</p>
|
|
2005
|
-
*
|
|
2006
2799
|
* <ul>
|
|
2007
2800
|
* <li>
|
|
2008
2801
|
* <p>
|
|
@@ -2021,23 +2814,45 @@ export interface CreateFileSystemLustreConfiguration {
|
|
|
2021
2814
|
* <p>
|
|
2022
2815
|
* <code>NEW_CHANGED</code> - AutoImport is on. Amazon FSx automatically imports
|
|
2023
2816
|
* file and directory listings of any new objects added to the S3 bucket and any
|
|
2024
|
-
* existing objects that are changed in the S3 bucket after you choose this option
|
|
2025
|
-
* </
|
|
2817
|
+
* existing objects that are changed in the S3 bucket after you choose this option.</p>
|
|
2818
|
+
* </li>
|
|
2819
|
+
* <li>
|
|
2820
|
+
* <p>
|
|
2821
|
+
* <code>NEW_CHANGED_DELETED</code> - AutoImport is on. Amazon FSx automatically
|
|
2822
|
+
* imports file and directory listings of any new objects added to the S3 bucket, any
|
|
2823
|
+
* existing objects that are changed in the S3 bucket, and any objects that were deleted
|
|
2824
|
+
* in the S3 bucket.</p>
|
|
2026
2825
|
* </li>
|
|
2027
2826
|
* </ul>
|
|
2028
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html">
|
|
2827
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html">
|
|
2828
|
+
* Automatically import updates from your S3 bucket</a>.</p>
|
|
2829
|
+
* <note>
|
|
2830
|
+
* <p>This parameter is not supported for file systems with the <code>Persistent_2</code> deployment type.
|
|
2831
|
+
* Instead, use <code>CreateDataRepositoryAssociation"</code> to create
|
|
2832
|
+
* a data repository association to link your Lustre file system to a data repository.</p>
|
|
2833
|
+
* </note>
|
|
2029
2834
|
*/
|
|
2030
2835
|
AutoImportPolicy?: AutoImportPolicyType | string;
|
|
2031
2836
|
/**
|
|
2032
|
-
* <p>
|
|
2033
|
-
*
|
|
2034
|
-
*
|
|
2035
|
-
*
|
|
2036
|
-
*
|
|
2037
|
-
*
|
|
2038
|
-
* provision.
|
|
2039
|
-
*
|
|
2040
|
-
* <
|
|
2837
|
+
* <p>Required with <code>PERSISTENT_1</code> and <code>PERSISTENT_2</code> deployment
|
|
2838
|
+
* types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of
|
|
2839
|
+
* file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated
|
|
2840
|
+
* by multiplying file system storage capacity (TiB) by the
|
|
2841
|
+
* <code>PerUnitStorageThroughput</code> (MB/s/TiB). For a 2.4-TiB file system,
|
|
2842
|
+
* provisioning 50 MB/s/TiB of <code>PerUnitStorageThroughput</code> yields 120 MB/s of file
|
|
2843
|
+
* system throughput. You pay for the amount of throughput that you provision. </p>
|
|
2844
|
+
* <p>Valid values:</p>
|
|
2845
|
+
* <ul>
|
|
2846
|
+
* <li>
|
|
2847
|
+
* <p>For <code>PERSISTENT_1</code> SSD storage: 50, 100, 200 MB/s/TiB.</p>
|
|
2848
|
+
* </li>
|
|
2849
|
+
* <li>
|
|
2850
|
+
* <p>For <code>PERSISTENT_1</code> HDD storage: 12, 40 MB/s/TiB.</p>
|
|
2851
|
+
* </li>
|
|
2852
|
+
* <li>
|
|
2853
|
+
* <p>For <code>PERSISTENT_2</code> SSD storage: 125, 250, 500, 1000 MB/s/TiB.</p>
|
|
2854
|
+
* </li>
|
|
2855
|
+
* </ul>
|
|
2041
2856
|
*/
|
|
2042
2857
|
PerUnitStorageThroughput?: number;
|
|
2043
2858
|
/**
|
|
@@ -2047,27 +2862,32 @@ export interface CreateFileSystemLustreConfiguration {
|
|
|
2047
2862
|
*/
|
|
2048
2863
|
DailyAutomaticBackupStartTime?: string;
|
|
2049
2864
|
/**
|
|
2050
|
-
* <p>The number of days to retain automatic backups. Setting this to
|
|
2051
|
-
*
|
|
2865
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
2866
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
2867
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
2052
2868
|
*/
|
|
2053
2869
|
AutomaticBackupRetentionDays?: number;
|
|
2054
2870
|
/**
|
|
2055
|
-
* <p>(Optional) Not available
|
|
2056
|
-
* A boolean flag indicating whether tags for the file system should be copied
|
|
2057
|
-
* backups. The default value is false. If
|
|
2058
|
-
* tags are copied to all automatic and user-initiated backups when
|
|
2059
|
-
* doesn't specify any backup-specific tags. If
|
|
2060
|
-
*
|
|
2061
|
-
*
|
|
2062
|
-
*
|
|
2871
|
+
* <p>(Optional) Not available for use with file systems that are linked to a data
|
|
2872
|
+
* repository. A boolean flag indicating whether tags for the file system should be copied
|
|
2873
|
+
* to backups. The default value is false. If <code>CopyTagsToBackups</code> is set to
|
|
2874
|
+
* true, all file system tags are copied to all automatic and user-initiated backups when
|
|
2875
|
+
* the user doesn't specify any backup-specific tags. If
|
|
2876
|
+
* <code>CopyTagsToBackups</code> is set to true and you specify one or more backup
|
|
2877
|
+
* tags, only the specified tags are copied to backups. If you specify one or more tags
|
|
2878
|
+
* when creating a user-initiated backup, no tags are copied from the file system,
|
|
2879
|
+
* regardless of this value.</p>
|
|
2880
|
+
* <p>(Default = <code>false</code>)</p>
|
|
2881
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html">
|
|
2882
|
+
* Working with backups</a> in the <i>Amazon FSx for Lustre User Guide</i>.</p>
|
|
2063
2883
|
*/
|
|
2064
2884
|
CopyTagsToBackups?: boolean;
|
|
2065
2885
|
/**
|
|
2066
|
-
* <p>The type of drive cache used by PERSISTENT_1 file systems that are provisioned with
|
|
2067
|
-
* HDD storage devices. This parameter is required when storage type is HDD. Set to
|
|
2068
|
-
* <code>READ</code
|
|
2069
|
-
* of the total storage capacity of the file system
|
|
2070
|
-
* <p>This parameter is required when <code>StorageType</code> is set to HDD
|
|
2886
|
+
* <p>The type of drive cache used by <code>PERSISTENT_1</code> file systems that are provisioned with
|
|
2887
|
+
* HDD storage devices. This parameter is required when storage type is HDD. Set this property to
|
|
2888
|
+
* <code>READ</code> to improve the performance for frequently accessed files by caching up to 20%
|
|
2889
|
+
* of the total storage capacity of the file system.</p>
|
|
2890
|
+
* <p>This parameter is required when <code>StorageType</code> is set to <code>HDD</code>.</p>
|
|
2071
2891
|
*/
|
|
2072
2892
|
DriveCacheType?: DriveCacheType | string;
|
|
2073
2893
|
/**
|
|
@@ -2085,9 +2905,16 @@ export interface CreateFileSystemLustreConfiguration {
|
|
|
2085
2905
|
* algorithm.</p>
|
|
2086
2906
|
* </li>
|
|
2087
2907
|
* </ul>
|
|
2088
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html">Lustre data compression</a
|
|
2908
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html">Lustre data compression</a>
|
|
2909
|
+
* in the <i>Amazon FSx for Lustre User Guide</i>.</p>
|
|
2089
2910
|
*/
|
|
2090
2911
|
DataCompressionType?: DataCompressionType | string;
|
|
2912
|
+
/**
|
|
2913
|
+
* <p>The Lustre logging configuration used when creating an Amazon FSx for Lustre
|
|
2914
|
+
* file system. When logging is enabled, Lustre logs error and warning events for data repositories
|
|
2915
|
+
* associated with your file system to Amazon CloudWatch Logs.</p>
|
|
2916
|
+
*/
|
|
2917
|
+
LogConfiguration?: LustreLogCreateConfiguration;
|
|
2091
2918
|
}
|
|
2092
2919
|
export declare namespace CreateFileSystemLustreConfiguration {
|
|
2093
2920
|
/**
|
|
@@ -2096,12 +2923,13 @@ export declare namespace CreateFileSystemLustreConfiguration {
|
|
|
2096
2923
|
const filterSensitiveLog: (obj: CreateFileSystemLustreConfiguration) => any;
|
|
2097
2924
|
}
|
|
2098
2925
|
/**
|
|
2099
|
-
* <p>The ONTAP configuration properties of the FSx for
|
|
2926
|
+
* <p>The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.</p>
|
|
2100
2927
|
*/
|
|
2101
2928
|
export interface CreateFileSystemOntapConfiguration {
|
|
2102
2929
|
/**
|
|
2103
|
-
* <p>The number of days to retain automatic backups. Setting this to
|
|
2104
|
-
*
|
|
2930
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
2931
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
2932
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
2105
2933
|
*/
|
|
2106
2934
|
AutomaticBackupRetentionDays?: number;
|
|
2107
2935
|
/**
|
|
@@ -2111,7 +2939,8 @@ export interface CreateFileSystemOntapConfiguration {
|
|
|
2111
2939
|
*/
|
|
2112
2940
|
DailyAutomaticBackupStartTime?: string;
|
|
2113
2941
|
/**
|
|
2114
|
-
* <p>Specifies the ONTAP file system deployment type to use in creating the file system
|
|
2942
|
+
* <p>Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
|
|
2943
|
+
* <code>MULTI_AZ_1</code> is the supported ONTAP deployment type.</p>
|
|
2115
2944
|
*/
|
|
2116
2945
|
DeploymentType: OntapDeploymentType | string | undefined;
|
|
2117
2946
|
/**
|
|
@@ -2121,30 +2950,29 @@ export interface CreateFileSystemOntapConfiguration {
|
|
|
2121
2950
|
*/
|
|
2122
2951
|
EndpointIpAddressRange?: string;
|
|
2123
2952
|
/**
|
|
2124
|
-
* <p>The ONTAP administrative password for the <code>fsxadmin</code> user
|
|
2125
|
-
*
|
|
2953
|
+
* <p>The ONTAP administrative password for the <code>fsxadmin</code> user with which you
|
|
2954
|
+
* administer your file system using the NetApp ONTAP CLI and REST API.</p>
|
|
2126
2955
|
*/
|
|
2127
2956
|
FsxAdminPassword?: string;
|
|
2128
2957
|
/**
|
|
2129
|
-
* <p>The SSD IOPS configuration for the
|
|
2958
|
+
* <p>The SSD IOPS configuration for the FSx for ONTAP file system.</p>
|
|
2130
2959
|
*/
|
|
2131
2960
|
DiskIopsConfiguration?: DiskIopsConfiguration;
|
|
2132
2961
|
/**
|
|
2133
|
-
* <p>
|
|
2134
|
-
*
|
|
2135
|
-
* <i>Amazon VPC User Guide.</i>
|
|
2136
|
-
* </p>
|
|
2962
|
+
* <p>Required when <code>DeploymentType</code> is set to <code>MULTI_AZ_1</code>. This specifies the subnet
|
|
2963
|
+
* in which you want the preferred file server to be located.</p>
|
|
2137
2964
|
*/
|
|
2138
2965
|
PreferredSubnetId?: string;
|
|
2139
2966
|
/**
|
|
2140
|
-
* <p>Specifies the VPC route tables in which your file system's
|
|
2141
|
-
* created. You should specify all VPC route tables associated with the
|
|
2142
|
-
* in which your clients are located. By default, Amazon FSx selects your VPC's
|
|
2967
|
+
* <p>Specifies the virtual private cloud (VPC) route tables in which your file system's
|
|
2968
|
+
* endpoints will be created. You should specify all VPC route tables associated with the
|
|
2969
|
+
* subnets in which your clients are located. By default, Amazon FSx selects your VPC's
|
|
2143
2970
|
* default route table.</p>
|
|
2144
2971
|
*/
|
|
2145
2972
|
RouteTableIds?: string[];
|
|
2146
2973
|
/**
|
|
2147
|
-
* <p>
|
|
2974
|
+
* <p>Sets the throughput capacity for the file system that you're creating.
|
|
2975
|
+
* Valid values are 512, 1024, and 2048 MBps.</p>
|
|
2148
2976
|
*/
|
|
2149
2977
|
ThroughputCapacity: number | undefined;
|
|
2150
2978
|
/**
|
|
@@ -2166,60 +2994,189 @@ export declare namespace CreateFileSystemOntapConfiguration {
|
|
|
2166
2994
|
const filterSensitiveLog: (obj: CreateFileSystemOntapConfiguration) => any;
|
|
2167
2995
|
}
|
|
2168
2996
|
/**
|
|
2169
|
-
* <p>The
|
|
2170
|
-
* or updating an Amazon FSx for Windows File Server file system.</p>
|
|
2997
|
+
* <p>The configuration of an Amazon FSx for OpenZFS root volume.</p>
|
|
2171
2998
|
*/
|
|
2172
|
-
export interface
|
|
2999
|
+
export interface OpenZFSCreateRootVolumeConfiguration {
|
|
2173
3000
|
/**
|
|
2174
|
-
* <p>
|
|
3001
|
+
* <p>Specifies the method used to compress the data on the volume. Unless the compression
|
|
3002
|
+
* type is specified, volumes inherit the <code>DataCompressionType</code> value of their
|
|
3003
|
+
* parent volume.</p>
|
|
2175
3004
|
* <ul>
|
|
2176
3005
|
* <li>
|
|
2177
3006
|
* <p>
|
|
2178
|
-
* <code>
|
|
2179
|
-
* or folders are logged.</p>
|
|
2180
|
-
* </li>
|
|
2181
|
-
* <li>
|
|
2182
|
-
* <p>
|
|
2183
|
-
* <code>FAILURE_ONLY</code> - only failed attempts to access files
|
|
2184
|
-
* or folders are logged.</p>
|
|
2185
|
-
* </li>
|
|
2186
|
-
* <li>
|
|
2187
|
-
* <p>
|
|
2188
|
-
* <code>SUCCESS_AND_FAILURE</code> - both successful attempts and
|
|
2189
|
-
* failed attempts to access files or folders are logged.</p>
|
|
3007
|
+
* <code>NONE</code> - Doesn't compress the data on the volume.</p>
|
|
2190
3008
|
* </li>
|
|
2191
3009
|
* <li>
|
|
2192
3010
|
* <p>
|
|
2193
|
-
* <code>
|
|
3011
|
+
* <code>ZSTD</code> - Compresses the data in the volume using the ZStandard
|
|
3012
|
+
* (ZSTD) compression algorithm. This algorithm reduces the amount of space used on
|
|
3013
|
+
* your volume and has very little impact on compute resources.</p>
|
|
2194
3014
|
* </li>
|
|
2195
3015
|
* </ul>
|
|
2196
3016
|
*/
|
|
2197
|
-
|
|
3017
|
+
DataCompressionType?: OpenZFSDataCompressionType | string;
|
|
2198
3018
|
/**
|
|
2199
|
-
* <p>
|
|
2200
|
-
* <ul>
|
|
2201
|
-
* <li>
|
|
2202
|
-
* <p>
|
|
2203
|
-
* <code>SUCCESS_ONLY</code> - only successful attempts to access file
|
|
2204
|
-
* shares are logged.</p>
|
|
2205
|
-
* </li>
|
|
2206
|
-
* <li>
|
|
2207
|
-
* <p>
|
|
2208
|
-
* <code>FAILURE_ONLY</code> - only failed attempts to access file
|
|
2209
|
-
* shares are logged.</p>
|
|
2210
|
-
* </li>
|
|
2211
|
-
* <li>
|
|
2212
|
-
* <p>
|
|
2213
|
-
* <code>SUCCESS_AND_FAILURE</code> - both successful attempts and
|
|
2214
|
-
* failed attempts to access file shares are logged.</p>
|
|
2215
|
-
* </li>
|
|
2216
|
-
* <li>
|
|
2217
|
-
* <p>
|
|
2218
|
-
* <code>DISABLED</code> - access auditing of file shares is turned off.</p>
|
|
2219
|
-
* </li>
|
|
2220
|
-
* </ul>
|
|
3019
|
+
* <p>The configuration object for mounting a file system.</p>
|
|
2221
3020
|
*/
|
|
2222
|
-
|
|
3021
|
+
NfsExports?: OpenZFSNfsExport[];
|
|
3022
|
+
/**
|
|
3023
|
+
* <p>An object specifying how much storage users or groups can use on the volume.</p>
|
|
3024
|
+
*/
|
|
3025
|
+
UserAndGroupQuotas?: OpenZFSUserOrGroupQuota[];
|
|
3026
|
+
/**
|
|
3027
|
+
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
|
3028
|
+
* This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags
|
|
3029
|
+
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
3030
|
+
* value is <code>true</code> and you specify one or more tags, only the specified tags are
|
|
3031
|
+
* copied to snapshots. If you specify one or more tags when creating the snapshot, no tags
|
|
3032
|
+
* are copied from the volume, regardless of this value. </p>
|
|
3033
|
+
*/
|
|
3034
|
+
CopyTagsToSnapshots?: boolean;
|
|
3035
|
+
/**
|
|
3036
|
+
* <p>A Boolean value indicating whether the volume is read-only. Setting this value to
|
|
3037
|
+
* <code>true</code> can be useful after you have completed changes to a volume and no
|
|
3038
|
+
* longer want changes to occur. </p>
|
|
3039
|
+
*/
|
|
3040
|
+
ReadOnly?: boolean;
|
|
3041
|
+
}
|
|
3042
|
+
export declare namespace OpenZFSCreateRootVolumeConfiguration {
|
|
3043
|
+
/**
|
|
3044
|
+
* @internal
|
|
3045
|
+
*/
|
|
3046
|
+
const filterSensitiveLog: (obj: OpenZFSCreateRootVolumeConfiguration) => any;
|
|
3047
|
+
}
|
|
3048
|
+
/**
|
|
3049
|
+
* <p>The OpenZFS configuration properties for the file system that you are creating.</p>
|
|
3050
|
+
*/
|
|
3051
|
+
export interface CreateFileSystemOpenZFSConfiguration {
|
|
3052
|
+
/**
|
|
3053
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
3054
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
3055
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
3056
|
+
*/
|
|
3057
|
+
AutomaticBackupRetentionDays?: number;
|
|
3058
|
+
/**
|
|
3059
|
+
* <p>A Boolean value indicating whether tags for the file system should be copied to
|
|
3060
|
+
* backups. This value defaults to <code>false</code>. If it's set to <code>true</code>,
|
|
3061
|
+
* all tags for the file system are copied to all automatic and user-initiated backups
|
|
3062
|
+
* where the user doesn't specify tags. If this value is <code>true</code>, and you specify
|
|
3063
|
+
* one or more tags, only the specified tags are copied to backups. If you specify one or
|
|
3064
|
+
* more tags when creating a user-initiated backup, no tags are copied from the file
|
|
3065
|
+
* system, regardless of this value.</p>
|
|
3066
|
+
*/
|
|
3067
|
+
CopyTagsToBackups?: boolean;
|
|
3068
|
+
/**
|
|
3069
|
+
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
|
3070
|
+
* This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags
|
|
3071
|
+
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
3072
|
+
* value is <code>true</code>, and you specify one or more tags, only the specified tags
|
|
3073
|
+
* are copied to snapshots. If you specify one or more tags when creating the snapshot, no
|
|
3074
|
+
* tags are copied from the volume, regardless of this value. </p>
|
|
3075
|
+
*/
|
|
3076
|
+
CopyTagsToVolumes?: boolean;
|
|
3077
|
+
/**
|
|
3078
|
+
* <p>A recurring daily time, in the format <code>HH:MM</code>. <code>HH</code> is the
|
|
3079
|
+
* zero-padded hour of the day (0-23), and <code>MM</code> is the zero-padded minute of the
|
|
3080
|
+
* hour. For example, <code>05:00</code> specifies 5 AM daily. </p>
|
|
3081
|
+
*/
|
|
3082
|
+
DailyAutomaticBackupStartTime?: string;
|
|
3083
|
+
/**
|
|
3084
|
+
* <p>Specifies the file system deployment type. Amazon FSx for OpenZFS supports
|
|
3085
|
+
* <code>SINGLE_AZ_1</code>. <code>SINGLE_AZ_1</code> is a file system configured for a
|
|
3086
|
+
* single Availability Zone (AZ) of redundancy.</p>
|
|
3087
|
+
*/
|
|
3088
|
+
DeploymentType: OpenZFSDeploymentType | string | undefined;
|
|
3089
|
+
/**
|
|
3090
|
+
* <p>Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second
|
|
3091
|
+
* (MB/s). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
|
|
3092
|
+
* You pay for additional throughput capacity that you provision.</p>
|
|
3093
|
+
*/
|
|
3094
|
+
ThroughputCapacity: number | undefined;
|
|
3095
|
+
/**
|
|
3096
|
+
* <p>A recurring weekly time, in the format <code>D:HH:MM</code>. </p>
|
|
3097
|
+
* <p>
|
|
3098
|
+
* <code>D</code> is the day of the week, for which 1 represents Monday and 7
|
|
3099
|
+
* represents Sunday. For further details, see <a href="https://en.wikipedia.org/wiki/ISO_week_date">the ISO-8601 spec as described on Wikipedia</a>.</p>
|
|
3100
|
+
* <p>
|
|
3101
|
+
* <code>HH</code> is the zero-padded hour of the day (0-23), and <code>MM</code> is
|
|
3102
|
+
* the zero-padded minute of the hour. </p>
|
|
3103
|
+
* <p>For example, <code>1:05:00</code> specifies maintenance at 5 AM Monday.</p>
|
|
3104
|
+
*/
|
|
3105
|
+
WeeklyMaintenanceStartTime?: string;
|
|
3106
|
+
/**
|
|
3107
|
+
* <p>The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The
|
|
3108
|
+
* default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per
|
|
3109
|
+
* GB of storage. The configuration consists of the total number of provisioned SSD IOPS
|
|
3110
|
+
* and how the amount was provisioned (by the customer or by the system).</p>
|
|
3111
|
+
*/
|
|
3112
|
+
DiskIopsConfiguration?: DiskIopsConfiguration;
|
|
3113
|
+
/**
|
|
3114
|
+
* <p>The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS
|
|
3115
|
+
* file system. All volumes are children of the root volume. </p>
|
|
3116
|
+
*/
|
|
3117
|
+
RootVolumeConfiguration?: OpenZFSCreateRootVolumeConfiguration;
|
|
3118
|
+
}
|
|
3119
|
+
export declare namespace CreateFileSystemOpenZFSConfiguration {
|
|
3120
|
+
/**
|
|
3121
|
+
* @internal
|
|
3122
|
+
*/
|
|
3123
|
+
const filterSensitiveLog: (obj: CreateFileSystemOpenZFSConfiguration) => any;
|
|
3124
|
+
}
|
|
3125
|
+
/**
|
|
3126
|
+
* <p>The Windows file access auditing configuration used when creating
|
|
3127
|
+
* or updating an Amazon FSx for Windows File Server file system.</p>
|
|
3128
|
+
*/
|
|
3129
|
+
export interface WindowsAuditLogCreateConfiguration {
|
|
3130
|
+
/**
|
|
3131
|
+
* <p>Sets which attempt type is logged by Amazon FSx for file and folder accesses.</p>
|
|
3132
|
+
* <ul>
|
|
3133
|
+
* <li>
|
|
3134
|
+
* <p>
|
|
3135
|
+
* <code>SUCCESS_ONLY</code> - only successful attempts to access files
|
|
3136
|
+
* or folders are logged.</p>
|
|
3137
|
+
* </li>
|
|
3138
|
+
* <li>
|
|
3139
|
+
* <p>
|
|
3140
|
+
* <code>FAILURE_ONLY</code> - only failed attempts to access files
|
|
3141
|
+
* or folders are logged.</p>
|
|
3142
|
+
* </li>
|
|
3143
|
+
* <li>
|
|
3144
|
+
* <p>
|
|
3145
|
+
* <code>SUCCESS_AND_FAILURE</code> - both successful attempts and
|
|
3146
|
+
* failed attempts to access files or folders are logged.</p>
|
|
3147
|
+
* </li>
|
|
3148
|
+
* <li>
|
|
3149
|
+
* <p>
|
|
3150
|
+
* <code>DISABLED</code> - access auditing of files and folders is turned off.</p>
|
|
3151
|
+
* </li>
|
|
3152
|
+
* </ul>
|
|
3153
|
+
*/
|
|
3154
|
+
FileAccessAuditLogLevel: WindowsAccessAuditLogLevel | string | undefined;
|
|
3155
|
+
/**
|
|
3156
|
+
* <p>Sets which attempt type is logged by Amazon FSx for file share accesses.</p>
|
|
3157
|
+
* <ul>
|
|
3158
|
+
* <li>
|
|
3159
|
+
* <p>
|
|
3160
|
+
* <code>SUCCESS_ONLY</code> - only successful attempts to access file
|
|
3161
|
+
* shares are logged.</p>
|
|
3162
|
+
* </li>
|
|
3163
|
+
* <li>
|
|
3164
|
+
* <p>
|
|
3165
|
+
* <code>FAILURE_ONLY</code> - only failed attempts to access file
|
|
3166
|
+
* shares are logged.</p>
|
|
3167
|
+
* </li>
|
|
3168
|
+
* <li>
|
|
3169
|
+
* <p>
|
|
3170
|
+
* <code>SUCCESS_AND_FAILURE</code> - both successful attempts and
|
|
3171
|
+
* failed attempts to access file shares are logged.</p>
|
|
3172
|
+
* </li>
|
|
3173
|
+
* <li>
|
|
3174
|
+
* <p>
|
|
3175
|
+
* <code>DISABLED</code> - access auditing of file shares is turned off.</p>
|
|
3176
|
+
* </li>
|
|
3177
|
+
* </ul>
|
|
3178
|
+
*/
|
|
3179
|
+
FileShareAccessAuditLogLevel: WindowsAccessAuditLogLevel | string | undefined;
|
|
2223
3180
|
/**
|
|
2224
3181
|
* <p>The Amazon Resource Name (ARN) that specifies the destination of the audit logs.</p>
|
|
2225
3182
|
* <p>The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis
|
|
@@ -2372,7 +3329,7 @@ export interface CreateFileSystemWindowsConfiguration {
|
|
|
2372
3329
|
*/
|
|
2373
3330
|
PreferredSubnetId?: string;
|
|
2374
3331
|
/**
|
|
2375
|
-
* <p>
|
|
3332
|
+
* <p>Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to
|
|
2376
3333
|
* the <i>n</i>th increments, between 2^3 (8) and 2^11 (2048).</p>
|
|
2377
3334
|
*/
|
|
2378
3335
|
ThroughputCapacity: number | undefined;
|
|
@@ -2450,24 +3407,29 @@ export interface CreateFileSystemRequest {
|
|
|
2450
3407
|
/**
|
|
2451
3408
|
* <p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
|
2452
3409
|
* idempotent creation. This string is automatically filled on your behalf when you use the
|
|
2453
|
-
*
|
|
3410
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
2454
3411
|
*/
|
|
2455
3412
|
ClientRequestToken?: string;
|
|
2456
3413
|
/**
|
|
2457
|
-
* <p>The type of Amazon FSx file system to create. Valid values are
|
|
2458
|
-
*
|
|
3414
|
+
* <p>The type of Amazon FSx file system to create. Valid values are
|
|
3415
|
+
* <code>WINDOWS</code>, <code>LUSTRE</code>, <code>ONTAP</code>, and
|
|
3416
|
+
* <code>OPENZFS</code>.</p>
|
|
2459
3417
|
*/
|
|
2460
3418
|
FileSystemType: FileSystemType | string | undefined;
|
|
2461
3419
|
/**
|
|
2462
|
-
* <p>Sets the storage capacity of the file system that you're creating.</p>
|
|
2463
|
-
* <p>
|
|
3420
|
+
* <p>Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).</p>
|
|
3421
|
+
* <p>
|
|
3422
|
+
* <b>FSx for Lustre file systems</b> - The amount of
|
|
3423
|
+
* storage capacity that you can configure depends on the value that you set for
|
|
3424
|
+
* <code>StorageType</code> and the Lustre <code>DeploymentType</code>, as
|
|
3425
|
+
* follows:</p>
|
|
2464
3426
|
* <ul>
|
|
2465
3427
|
* <li>
|
|
2466
|
-
* <p>For <code>SCRATCH_2</code> and <code>PERSISTENT_1
|
|
2467
|
-
* 1200 GiB, 2400 GiB, and increments of 2400 GiB.</p>
|
|
3428
|
+
* <p>For <code>SCRATCH_2</code>, <code>PERSISTENT_2</code> and <code>PERSISTENT_1</code> deployment types
|
|
3429
|
+
* using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.</p>
|
|
2468
3430
|
* </li>
|
|
2469
3431
|
* <li>
|
|
2470
|
-
* <p>For <code>
|
|
3432
|
+
* <p>For <code>PERSISTENT_1</code> HDD file systems, valid values are increments of 6000 GiB for
|
|
2471
3433
|
* 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.</p>
|
|
2472
3434
|
* </li>
|
|
2473
3435
|
* <li>
|
|
@@ -2475,30 +3437,33 @@ export interface CreateFileSystemRequest {
|
|
|
2475
3437
|
* 1200 GiB, 2400 GiB, and increments of 3600 GiB.</p>
|
|
2476
3438
|
* </li>
|
|
2477
3439
|
* </ul>
|
|
2478
|
-
* <p>
|
|
3440
|
+
* <p>
|
|
3441
|
+
* <b>FSx for ONTAP file systems</b> - The amount of storage capacity
|
|
3442
|
+
* that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).</p>
|
|
3443
|
+
* <p>
|
|
3444
|
+
* <b>FSx for OpenZFS file systems</b> - The amount of storage capacity that
|
|
3445
|
+
* you can configure is from 64 GiB up to 524,288 GiB (512 TiB).</p>
|
|
3446
|
+
* <p>
|
|
3447
|
+
* <b>FSx for Windows File Server file systems</b> - The amount
|
|
3448
|
+
* of storage capacity that you can configure depends on the value that you set for
|
|
3449
|
+
* <code>StorageType</code> as follows:</p>
|
|
2479
3450
|
* <ul>
|
|
2480
3451
|
* <li>
|
|
2481
|
-
* <p>
|
|
2482
|
-
* </li>
|
|
2483
|
-
* <li>
|
|
2484
|
-
* <p>If <code>StorageType=HDD</code>, valid values are 2000 GiB - 65,536 GiB (64 TiB).</p>
|
|
3452
|
+
* <p>For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).</p>
|
|
2485
3453
|
* </li>
|
|
2486
|
-
* </ul>
|
|
2487
|
-
* <p>For ONTAP file systems:</p>
|
|
2488
|
-
* <ul>
|
|
2489
3454
|
* <li>
|
|
2490
|
-
* <p>
|
|
3455
|
+
* <p>For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).</p>
|
|
2491
3456
|
* </li>
|
|
2492
3457
|
* </ul>
|
|
2493
3458
|
*/
|
|
2494
3459
|
StorageCapacity: number | undefined;
|
|
2495
3460
|
/**
|
|
2496
|
-
* <p>Sets the storage type for the file system you're creating.
|
|
2497
|
-
*
|
|
3461
|
+
* <p>Sets the storage type for the file system that you're creating. Valid values are
|
|
3462
|
+
* <code>SSD</code> and <code>HDD</code>.</p>
|
|
2498
3463
|
* <ul>
|
|
2499
3464
|
* <li>
|
|
2500
|
-
* <p>Set to <code>SSD</code> to use solid state drive storage.
|
|
2501
|
-
*
|
|
3465
|
+
* <p>Set to <code>SSD</code> to use solid state drive storage. SSD is supported on all Windows,
|
|
3466
|
+
* Lustre, ONTAP, and OpenZFS deployment types.</p>
|
|
2502
3467
|
* </li>
|
|
2503
3468
|
* <li>
|
|
2504
3469
|
* <p>Set to <code>HDD</code> to use hard disk drive storage.
|
|
@@ -2507,28 +3472,26 @@ export interface CreateFileSystemRequest {
|
|
|
2507
3472
|
* </p>
|
|
2508
3473
|
* </li>
|
|
2509
3474
|
* </ul>
|
|
2510
|
-
* <p>
|
|
2511
|
-
*
|
|
2512
|
-
*
|
|
2513
|
-
*
|
|
2514
|
-
*
|
|
2515
|
-
* in the <i>Amazon FSx for Lustre User Guide</i>.
|
|
2516
|
-
* </p>
|
|
3475
|
+
* <p>Default value is <code>SSD</code>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options"> Storage
|
|
3476
|
+
* type options</a> in the <i>FSx for Windows File Server User
|
|
3477
|
+
* Guide</i> and <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options">Multiple storage
|
|
3478
|
+
* options</a> in the <i>FSx for Lustre User
|
|
3479
|
+
* Guide</i>. </p>
|
|
2517
3480
|
*/
|
|
2518
3481
|
StorageType?: StorageType | string;
|
|
2519
3482
|
/**
|
|
2520
|
-
* <p>Specifies the IDs of the subnets that the file system will be accessible from. For
|
|
2521
|
-
* and ONTAP <code>MULTI_AZ_1</code>
|
|
2522
|
-
* one for the preferred file server and one for the standby file server. You specify
|
|
2523
|
-
* subnets as the preferred subnet using the <code>WindowsConfiguration >
|
|
2524
|
-
*
|
|
2525
|
-
* see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html">
|
|
3483
|
+
* <p>Specifies the IDs of the subnets that the file system will be accessible from. For
|
|
3484
|
+
* Windows and ONTAP <code>MULTI_AZ_1</code> deployment types,provide exactly two subnet
|
|
3485
|
+
* IDs, one for the preferred file server and one for the standby file server. You specify
|
|
3486
|
+
* one of these subnets as the preferred subnet using the <code>WindowsConfiguration >
|
|
3487
|
+
* PreferredSubnetID</code> or <code>OntapConfiguration > PreferredSubnetID</code>
|
|
3488
|
+
* properties. For more information about Multi-AZ file system configuration, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html">
|
|
2526
3489
|
* Availability and durability: Single-AZ and Multi-AZ file systems</a> in the
|
|
2527
|
-
*
|
|
2528
|
-
*
|
|
2529
|
-
*
|
|
2530
|
-
*
|
|
2531
|
-
*
|
|
3490
|
+
* <i>Amazon FSx for Windows User Guide</i> and <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html">
|
|
3491
|
+
* Availability and durability</a> in the <i>Amazon FSx for ONTAP User
|
|
3492
|
+
* Guide</i>.</p>
|
|
3493
|
+
* <p>For Windows <code>SINGLE_AZ_1</code> and <code>SINGLE_AZ_2</code> and all Lustre
|
|
3494
|
+
* deployment types, provide exactly one subnet ID.
|
|
2532
3495
|
* The file server is launched in that subnet's Availability Zone.</p>
|
|
2533
3496
|
*/
|
|
2534
3497
|
SubnetIds: string[] | undefined;
|
|
@@ -2539,49 +3502,87 @@ export interface CreateFileSystemRequest {
|
|
|
2539
3502
|
*/
|
|
2540
3503
|
SecurityGroupIds?: string[];
|
|
2541
3504
|
/**
|
|
2542
|
-
* <p>The tags to apply to the file system being created. The key value of
|
|
2543
|
-
*
|
|
3505
|
+
* <p>The tags to apply to the file system that's being created. The key value of the
|
|
3506
|
+
* <code>Name</code> tag appears in the console as the file system name.</p>
|
|
2544
3507
|
*/
|
|
2545
3508
|
Tags?: Tag[];
|
|
2546
3509
|
/**
|
|
2547
|
-
* <p>The ID of the Key Management Service (KMS) key used to encrypt the file
|
|
2548
|
-
* for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and
|
|
2549
|
-
*
|
|
2550
|
-
*
|
|
2551
|
-
*
|
|
3510
|
+
* <p>The ID of the Key Management Service (KMS) key used to encrypt the file
|
|
3511
|
+
* system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for Lustre
|
|
3512
|
+
* <code>PERSISTENT_1</code> and <code>PERSISTENT_2</code> file systems at rest. If this ID
|
|
3513
|
+
* isn't specified, the key managed by Amazon FSx is used. The Amazon FSx for Lustre
|
|
3514
|
+
* <code>SCRATCH_1</code> and <code>SCRATCH_2</code> file systems are always encrypted at
|
|
3515
|
+
* rest using Amazon FSx-managed keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html">Encrypt</a>
|
|
2552
3516
|
* in the <i>Key Management Service API Reference</i>.</p>
|
|
2553
3517
|
*/
|
|
2554
3518
|
KmsKeyId?: string;
|
|
2555
3519
|
/**
|
|
2556
|
-
* <p>The Microsoft Windows configuration for the file system being created.
|
|
2557
|
-
* </p>
|
|
3520
|
+
* <p>The Microsoft Windows configuration for the file system that's being created. </p>
|
|
2558
3521
|
*/
|
|
2559
3522
|
WindowsConfiguration?: CreateFileSystemWindowsConfiguration;
|
|
2560
3523
|
/**
|
|
2561
|
-
* <p>The Lustre configuration for the file system being created
|
|
2562
|
-
*
|
|
3524
|
+
* <p>The Lustre configuration for the file system being created.</p>
|
|
3525
|
+
* <note>
|
|
3526
|
+
* <p>The following parameters are not supported for file systems with the <code>Persistent_2</code>
|
|
3527
|
+
* deployment type. Instead, use <code>CreateDataRepositoryAssociation</code>
|
|
3528
|
+
* to create a data repository association to link your Lustre file system to a data repository.</p>
|
|
3529
|
+
* <ul>
|
|
3530
|
+
* <li>
|
|
3531
|
+
* <p>
|
|
3532
|
+
* <code>AutoImportPolicy</code>
|
|
3533
|
+
* </p>
|
|
3534
|
+
* </li>
|
|
3535
|
+
* <li>
|
|
3536
|
+
* <p>
|
|
3537
|
+
* <code>ExportPath</code>
|
|
3538
|
+
* </p>
|
|
3539
|
+
* </li>
|
|
3540
|
+
* <li>
|
|
3541
|
+
* <p>
|
|
3542
|
+
* <code>ImportedChunkSize</code>
|
|
3543
|
+
* </p>
|
|
3544
|
+
* </li>
|
|
3545
|
+
* <li>
|
|
3546
|
+
* <p>
|
|
3547
|
+
* <code>ImportPath</code>
|
|
3548
|
+
* </p>
|
|
3549
|
+
* </li>
|
|
3550
|
+
* </ul>
|
|
3551
|
+
* </note>
|
|
2563
3552
|
*/
|
|
2564
3553
|
LustreConfiguration?: CreateFileSystemLustreConfiguration;
|
|
2565
3554
|
/**
|
|
2566
|
-
* <p>The ONTAP configuration properties of the FSx for
|
|
3555
|
+
* <p>The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.</p>
|
|
2567
3556
|
*/
|
|
2568
3557
|
OntapConfiguration?: CreateFileSystemOntapConfiguration;
|
|
2569
3558
|
/**
|
|
2570
|
-
* <p>
|
|
2571
|
-
* Valid values are <code>2.10</code> and
|
|
3559
|
+
* <p>(Optional) For FSx for Lustre file systems, sets the Lustre version for the
|
|
3560
|
+
* file system that you're creating. Valid values are <code>2.10</code> and
|
|
3561
|
+
* <code>2.12</code>:</p>
|
|
3562
|
+
*
|
|
2572
3563
|
* <ul>
|
|
2573
3564
|
* <li>
|
|
2574
|
-
* <p>
|
|
2575
|
-
* file system.</p>
|
|
3565
|
+
* <p>2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.</p>
|
|
2576
3566
|
* </li>
|
|
2577
3567
|
* <li>
|
|
2578
|
-
* <p>
|
|
2579
|
-
*
|
|
3568
|
+
* <p>2.12 is supported by all Lustre deployment types. <code>2.12</code> is
|
|
3569
|
+
* required when setting FSx for Lustre <code>DeploymentType</code> to
|
|
3570
|
+
* <code>PERSISTENT_2</code>.</p>
|
|
2580
3571
|
* </li>
|
|
2581
3572
|
* </ul>
|
|
2582
|
-
* <p>Default value
|
|
3573
|
+
* <p>Default value = <code>2.10</code>, except when <code>DeploymentType</code> is set to
|
|
3574
|
+
* <code>PERSISTENT_2</code>, then the default is <code>2.12</code>.</p>
|
|
3575
|
+
* <note>
|
|
3576
|
+
* <p>If you set <code>FileSystemTypeVersion</code> to <code>2.10</code> for a
|
|
3577
|
+
* <code>PERSISTENT_2</code> Lustre deployment type, the <code>CreateFileSystem</code>
|
|
3578
|
+
* operation fails.</p>
|
|
3579
|
+
* </note>
|
|
2583
3580
|
*/
|
|
2584
3581
|
FileSystemTypeVersion?: string;
|
|
3582
|
+
/**
|
|
3583
|
+
* <p>The OpenZFS configuration for the file system that's being created.</p>
|
|
3584
|
+
*/
|
|
3585
|
+
OpenZFSConfiguration?: CreateFileSystemOpenZFSConfiguration;
|
|
2585
3586
|
}
|
|
2586
3587
|
export declare namespace CreateFileSystemRequest {
|
|
2587
3588
|
/**
|
|
@@ -2692,13 +3693,13 @@ export declare namespace MissingFileSystemConfiguration {
|
|
|
2692
3693
|
*/
|
|
2693
3694
|
export interface CreateFileSystemFromBackupRequest {
|
|
2694
3695
|
/**
|
|
2695
|
-
* <p>The ID of the source backup. Specifies the backup you are copying.</p>
|
|
3696
|
+
* <p>The ID of the source backup. Specifies the backup that you are copying.</p>
|
|
2696
3697
|
*/
|
|
2697
3698
|
BackupId: string | undefined;
|
|
2698
3699
|
/**
|
|
2699
3700
|
* <p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
|
2700
3701
|
* idempotent creation. This string is automatically filled on your behalf when you use the
|
|
2701
|
-
*
|
|
3702
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
2702
3703
|
*/
|
|
2703
3704
|
ClientRequestToken?: string;
|
|
2704
3705
|
/**
|
|
@@ -2706,15 +3707,15 @@ export interface CreateFileSystemFromBackupRequest {
|
|
|
2706
3707
|
* file system deployment types, provide exactly two subnet IDs, one for the preferred file server
|
|
2707
3708
|
* and one for the standby file server. You specify one of these subnets as the preferred subnet
|
|
2708
3709
|
* using the <code>WindowsConfiguration > PreferredSubnetID</code> property.</p>
|
|
2709
|
-
* <p>
|
|
2710
|
-
* types
|
|
2711
|
-
*
|
|
3710
|
+
* <p>Windows <code>SINGLE_AZ_1</code> and <code>SINGLE_AZ_2</code> file system deployment
|
|
3711
|
+
* types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The
|
|
3712
|
+
* file server is launched in that subnet's Availability Zone.</p>
|
|
2712
3713
|
*/
|
|
2713
3714
|
SubnetIds: string[] | undefined;
|
|
2714
3715
|
/**
|
|
2715
|
-
* <p>A list of IDs for the security groups that apply to the specified network
|
|
2716
|
-
*
|
|
2717
|
-
*
|
|
3716
|
+
* <p>A list of IDs for the security groups that apply to the specified network interfaces
|
|
3717
|
+
* created for file system access. These security groups apply to all network interfaces.
|
|
3718
|
+
* This value isn't returned in later <code>DescribeFileSystem</code> requests.</p>
|
|
2718
3719
|
*/
|
|
2719
3720
|
SecurityGroupIds?: string[];
|
|
2720
3721
|
/**
|
|
@@ -2728,54 +3729,81 @@ export interface CreateFileSystemFromBackupRequest {
|
|
|
2728
3729
|
*/
|
|
2729
3730
|
WindowsConfiguration?: CreateFileSystemWindowsConfiguration;
|
|
2730
3731
|
/**
|
|
2731
|
-
* <p>The Lustre configuration for the file system being created
|
|
2732
|
-
*
|
|
3732
|
+
* <p>The Lustre configuration for the file system being created.</p>
|
|
3733
|
+
* <note>
|
|
3734
|
+
* <p>The following parameters are not supported for file systems with the <code>Persistent_2</code>
|
|
3735
|
+
* deployment type. Instead, use <code>CreateDataRepositoryAssociation</code>
|
|
3736
|
+
* to create a data repository association to link your Lustre file system to a data repository.</p>
|
|
3737
|
+
* <ul>
|
|
3738
|
+
* <li>
|
|
3739
|
+
* <p>
|
|
3740
|
+
* <code>AutoImportPolicy</code>
|
|
3741
|
+
* </p>
|
|
3742
|
+
* </li>
|
|
3743
|
+
* <li>
|
|
3744
|
+
* <p>
|
|
3745
|
+
* <code>ExportPath</code>
|
|
3746
|
+
* </p>
|
|
3747
|
+
* </li>
|
|
3748
|
+
* <li>
|
|
3749
|
+
* <p>
|
|
3750
|
+
* <code>ImportedChunkSize</code>
|
|
3751
|
+
* </p>
|
|
3752
|
+
* </li>
|
|
3753
|
+
* <li>
|
|
3754
|
+
* <p>
|
|
3755
|
+
* <code>ImportPath</code>
|
|
3756
|
+
* </p>
|
|
3757
|
+
* </li>
|
|
3758
|
+
* </ul>
|
|
3759
|
+
* </note>
|
|
2733
3760
|
*/
|
|
2734
3761
|
LustreConfiguration?: CreateFileSystemLustreConfiguration;
|
|
2735
3762
|
/**
|
|
2736
|
-
* <p>Sets the storage type for the Windows file system you're creating from
|
|
2737
|
-
* Valid values are <code>SSD</code> and <code>HDD</code>.</p>
|
|
3763
|
+
* <p>Sets the storage type for the Windows or OpenZFS file system that you're creating from
|
|
3764
|
+
* a backup. Valid values are <code>SSD</code> and <code>HDD</code>.</p>
|
|
2738
3765
|
* <ul>
|
|
2739
3766
|
* <li>
|
|
2740
|
-
* <p>Set to <code>SSD</code> to use solid state drive storage.
|
|
2741
|
-
*
|
|
3767
|
+
* <p>Set to <code>SSD</code> to use solid state drive storage. SSD is supported on all Windows and OpenZFS
|
|
3768
|
+
* deployment types.</p>
|
|
2742
3769
|
* </li>
|
|
2743
3770
|
* <li>
|
|
2744
3771
|
* <p>Set to <code>HDD</code> to use hard disk drive storage.
|
|
2745
|
-
*
|
|
2746
|
-
* </p>
|
|
3772
|
+
* HDD is supported on <code>SINGLE_AZ_2</code> and <code>MULTI_AZ_1</code> FSx for Windows File Server file system deployment types.</p>
|
|
2747
3773
|
* </li>
|
|
2748
3774
|
* </ul>
|
|
2749
|
-
* <p>
|
|
2750
|
-
* Default value is <code>SSD</code>.
|
|
2751
|
-
* </p>
|
|
3775
|
+
* <p> The default value is <code>SSD</code>. </p>
|
|
2752
3776
|
* <note>
|
|
2753
3777
|
* <p>HDD and SSD storage types have different minimum storage capacity requirements.
|
|
2754
3778
|
* A restored file system's storage capacity is tied to the file system that was backed up.
|
|
2755
3779
|
* You can create a file system that uses HDD storage from a backup of a file system that
|
|
2756
|
-
* used SSD storage
|
|
2757
|
-
* </p>
|
|
3780
|
+
* used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.</p>
|
|
2758
3781
|
* </note>
|
|
2759
3782
|
*/
|
|
2760
3783
|
StorageType?: StorageType | string;
|
|
2761
3784
|
/**
|
|
2762
|
-
* <p>The ID of the Key Management Service (KMS) key used to encrypt the file
|
|
2763
|
-
* for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and
|
|
2764
|
-
*
|
|
2765
|
-
*
|
|
2766
|
-
*
|
|
3785
|
+
* <p>The ID of the Key Management Service (KMS) key used to encrypt the file
|
|
3786
|
+
* system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for Lustre
|
|
3787
|
+
* <code>PERSISTENT_1</code> and <code>PERSISTENT_2</code> file systems at rest. If this ID
|
|
3788
|
+
* isn't specified, the key managed by Amazon FSx is used. The Amazon FSx for Lustre
|
|
3789
|
+
* <code>SCRATCH_1</code> and <code>SCRATCH_2</code> file systems are always encrypted at
|
|
3790
|
+
* rest using Amazon FSx-managed keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html">Encrypt</a>
|
|
2767
3791
|
* in the <i>Key Management Service API Reference</i>.</p>
|
|
2768
3792
|
*/
|
|
2769
3793
|
KmsKeyId?: string;
|
|
2770
3794
|
/**
|
|
2771
|
-
* <p>Sets the version for the Amazon FSx for Lustre file system you're
|
|
2772
|
-
* Valid values are <code>2.10</code> and <code>2.12</code>.</p>
|
|
3795
|
+
* <p>Sets the version for the Amazon FSx for Lustre file system that you're
|
|
3796
|
+
* creating from a backup. Valid values are <code>2.10</code> and <code>2.12</code>.</p>
|
|
2773
3797
|
* <p>You don't need to specify <code>FileSystemTypeVersion</code> because it will
|
|
2774
3798
|
* be applied using the backup's <code>FileSystemTypeVersion</code> setting.
|
|
2775
3799
|
* If you choose to specify <code>FileSystemTypeVersion</code> when creating from backup, the
|
|
2776
3800
|
* value must match the backup's <code>FileSystemTypeVersion</code> setting.</p>
|
|
2777
3801
|
*/
|
|
2778
3802
|
FileSystemTypeVersion?: string;
|
|
3803
|
+
/**
|
|
3804
|
+
* <p>The OpenZFS configuration for the file system that's being created. </p>
|
|
3805
|
+
*/
|
|
3806
|
+
OpenZFSConfiguration?: CreateFileSystemOpenZFSConfiguration;
|
|
2779
3807
|
}
|
|
2780
3808
|
export declare namespace CreateFileSystemFromBackupRequest {
|
|
2781
3809
|
/**
|
|
@@ -2783,6 +3811,32 @@ export declare namespace CreateFileSystemFromBackupRequest {
|
|
|
2783
3811
|
*/
|
|
2784
3812
|
const filterSensitiveLog: (obj: CreateFileSystemFromBackupRequest) => any;
|
|
2785
3813
|
}
|
|
3814
|
+
export interface CreateSnapshotRequest {
|
|
3815
|
+
/**
|
|
3816
|
+
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
3817
|
+
* ASCII characters. This token is automatically filled on your behalf when you use the
|
|
3818
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
3819
|
+
*/
|
|
3820
|
+
ClientRequestToken?: string;
|
|
3821
|
+
/**
|
|
3822
|
+
* <p>The name of the snapshot. </p>
|
|
3823
|
+
*/
|
|
3824
|
+
Name: string | undefined;
|
|
3825
|
+
/**
|
|
3826
|
+
* <p>The ID of the volume that you are taking a snapshot of.</p>
|
|
3827
|
+
*/
|
|
3828
|
+
VolumeId: string | undefined;
|
|
3829
|
+
/**
|
|
3830
|
+
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
3831
|
+
*/
|
|
3832
|
+
Tags?: Tag[];
|
|
3833
|
+
}
|
|
3834
|
+
export declare namespace CreateSnapshotRequest {
|
|
3835
|
+
/**
|
|
3836
|
+
* @internal
|
|
3837
|
+
*/
|
|
3838
|
+
const filterSensitiveLog: (obj: CreateSnapshotRequest) => any;
|
|
3839
|
+
}
|
|
2786
3840
|
/**
|
|
2787
3841
|
* <p>The configuration that Amazon FSx uses to join the ONTAP storage virtual machine
|
|
2788
3842
|
* (SVM) to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.</p>
|
|
@@ -3130,6 +4184,111 @@ export declare namespace CreateOntapVolumeConfiguration {
|
|
|
3130
4184
|
*/
|
|
3131
4185
|
const filterSensitiveLog: (obj: CreateOntapVolumeConfiguration) => any;
|
|
3132
4186
|
}
|
|
4187
|
+
/**
|
|
4188
|
+
* <p>The snapshot configuration to use when creating an OpenZFS volume from a snapshot. </p>
|
|
4189
|
+
*/
|
|
4190
|
+
export interface CreateOpenZFSOriginSnapshotConfiguration {
|
|
4191
|
+
/**
|
|
4192
|
+
* <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services
|
|
4193
|
+
* resources. We require an ARN when you need to specify a resource unambiguously across
|
|
4194
|
+
* all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in
|
|
4195
|
+
* the <i>Amazon Web Services General Reference</i>.</p>
|
|
4196
|
+
*/
|
|
4197
|
+
SnapshotARN: string | undefined;
|
|
4198
|
+
/**
|
|
4199
|
+
* <p>The strategy used when copying data from the snapshot to the new volume. </p>
|
|
4200
|
+
* <ul>
|
|
4201
|
+
* <li>
|
|
4202
|
+
* <p>
|
|
4203
|
+
* <code>CLONE</code> - The new volume references the data in the origin
|
|
4204
|
+
* snapshot. Cloning a snapshot is faster than copying data from the snapshot to a
|
|
4205
|
+
* new volume and doesn't consume disk throughput. However, the origin snapshot
|
|
4206
|
+
* can't be deleted if there is a volume using its copied data. </p>
|
|
4207
|
+
* </li>
|
|
4208
|
+
* <li>
|
|
4209
|
+
* <p>
|
|
4210
|
+
* <code>FULL_COPY</code> - Copies all data from the snapshot to the new volume.
|
|
4211
|
+
* </p>
|
|
4212
|
+
* </li>
|
|
4213
|
+
* </ul>
|
|
4214
|
+
*/
|
|
4215
|
+
CopyStrategy: OpenZFSCopyStrategy | string | undefined;
|
|
4216
|
+
}
|
|
4217
|
+
export declare namespace CreateOpenZFSOriginSnapshotConfiguration {
|
|
4218
|
+
/**
|
|
4219
|
+
* @internal
|
|
4220
|
+
*/
|
|
4221
|
+
const filterSensitiveLog: (obj: CreateOpenZFSOriginSnapshotConfiguration) => any;
|
|
4222
|
+
}
|
|
4223
|
+
/**
|
|
4224
|
+
* <p>Specifies the configuration of the OpenZFS volume that you are creating.</p>
|
|
4225
|
+
*/
|
|
4226
|
+
export interface CreateOpenZFSVolumeConfiguration {
|
|
4227
|
+
/**
|
|
4228
|
+
* <p>The ID of the volume to use as the parent volume. </p>
|
|
4229
|
+
*/
|
|
4230
|
+
ParentVolumeId: string | undefined;
|
|
4231
|
+
/**
|
|
4232
|
+
* <p>The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't
|
|
4233
|
+
* reserve more storage than the parent volume has reserved.</p>
|
|
4234
|
+
*/
|
|
4235
|
+
StorageCapacityReservationGiB?: number;
|
|
4236
|
+
/**
|
|
4237
|
+
* <p>The maximum amount of storage in gibibytes (GiB) that the volume can use from its
|
|
4238
|
+
* parent. You can specify a quota larger than the storage on the parent volume.</p>
|
|
4239
|
+
*/
|
|
4240
|
+
StorageCapacityQuotaGiB?: number;
|
|
4241
|
+
/**
|
|
4242
|
+
* <p>Specifies the method used to compress the data on the volume. Unless the compression
|
|
4243
|
+
* type is specified, volumes inherit the <code>DataCompressionType</code> value of their
|
|
4244
|
+
* parent volume.</p>
|
|
4245
|
+
* <ul>
|
|
4246
|
+
* <li>
|
|
4247
|
+
* <p>
|
|
4248
|
+
* <code>NONE</code> - Doesn't compress the data on the volume.</p>
|
|
4249
|
+
* </li>
|
|
4250
|
+
* <li>
|
|
4251
|
+
* <p>
|
|
4252
|
+
* <code>ZSTD</code> - Compresses the data in the volume using the Zstandard
|
|
4253
|
+
* (ZSTD) compression algorithm. This algorithm reduces the amount of space used on
|
|
4254
|
+
* your volume and has very little impact on compute resources.</p>
|
|
4255
|
+
* </li>
|
|
4256
|
+
* </ul>
|
|
4257
|
+
*/
|
|
4258
|
+
DataCompressionType?: OpenZFSDataCompressionType | string;
|
|
4259
|
+
/**
|
|
4260
|
+
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
|
4261
|
+
* This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags
|
|
4262
|
+
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
4263
|
+
* value is <code>true</code>, and you specify one or more tags, only the specified tags
|
|
4264
|
+
* are copied to snapshots. If you specify one or more tags when creating the snapshot, no
|
|
4265
|
+
* tags are copied from the volume, regardless of this value. </p>
|
|
4266
|
+
*/
|
|
4267
|
+
CopyTagsToSnapshots?: boolean;
|
|
4268
|
+
/**
|
|
4269
|
+
* <p>The configuration object that specifies the snapshot to use as the origin of the data
|
|
4270
|
+
* for the volume.</p>
|
|
4271
|
+
*/
|
|
4272
|
+
OriginSnapshot?: CreateOpenZFSOriginSnapshotConfiguration;
|
|
4273
|
+
/**
|
|
4274
|
+
* <p>A Boolean value indicating whether the volume is read-only. </p>
|
|
4275
|
+
*/
|
|
4276
|
+
ReadOnly?: boolean;
|
|
4277
|
+
/**
|
|
4278
|
+
* <p>The configuration object for mounting a Network File System (NFS) file system. </p>
|
|
4279
|
+
*/
|
|
4280
|
+
NfsExports?: OpenZFSNfsExport[];
|
|
4281
|
+
/**
|
|
4282
|
+
* <p>An object specifying how much storage users or groups can use on the volume. </p>
|
|
4283
|
+
*/
|
|
4284
|
+
UserAndGroupQuotas?: OpenZFSUserOrGroupQuota[];
|
|
4285
|
+
}
|
|
4286
|
+
export declare namespace CreateOpenZFSVolumeConfiguration {
|
|
4287
|
+
/**
|
|
4288
|
+
* @internal
|
|
4289
|
+
*/
|
|
4290
|
+
const filterSensitiveLog: (obj: CreateOpenZFSVolumeConfiguration) => any;
|
|
4291
|
+
}
|
|
3133
4292
|
export interface CreateVolumeRequest {
|
|
3134
4293
|
/**
|
|
3135
4294
|
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
@@ -3138,39 +4297,32 @@ export interface CreateVolumeRequest {
|
|
|
3138
4297
|
*/
|
|
3139
4298
|
ClientRequestToken?: string;
|
|
3140
4299
|
/**
|
|
3141
|
-
* <p>Specifies the type of volume to create; <code>ONTAP</code>
|
|
4300
|
+
* <p>Specifies the type of volume to create; <code>ONTAP</code> and <code>OPENZFS</code> are
|
|
4301
|
+
* the only valid volume types.</p>
|
|
3142
4302
|
*/
|
|
3143
4303
|
VolumeType: VolumeType | string | undefined;
|
|
3144
4304
|
/**
|
|
3145
|
-
* <p>Specifies the name of the volume you're creating.</p>
|
|
4305
|
+
* <p>Specifies the name of the volume that you're creating.</p>
|
|
3146
4306
|
*/
|
|
3147
4307
|
Name: string | undefined;
|
|
3148
4308
|
/**
|
|
3149
|
-
* <p>Specifies the
|
|
4309
|
+
* <p>Specifies the configuration to use when creating the ONTAP volume.</p>
|
|
3150
4310
|
*/
|
|
3151
4311
|
OntapConfiguration?: CreateOntapVolumeConfiguration;
|
|
3152
4312
|
/**
|
|
3153
4313
|
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
3154
4314
|
*/
|
|
3155
4315
|
Tags?: Tag[];
|
|
3156
|
-
}
|
|
3157
|
-
export declare namespace CreateVolumeRequest {
|
|
3158
|
-
/**
|
|
3159
|
-
* @internal
|
|
3160
|
-
*/
|
|
3161
|
-
const filterSensitiveLog: (obj: CreateVolumeRequest) => any;
|
|
3162
|
-
}
|
|
3163
|
-
export interface CreateVolumeResponse {
|
|
3164
4316
|
/**
|
|
3165
|
-
* <p>
|
|
4317
|
+
* <p>Specifies the configuration to use when creating the OpenZFS volume.</p>
|
|
3166
4318
|
*/
|
|
3167
|
-
|
|
4319
|
+
OpenZFSConfiguration?: CreateOpenZFSVolumeConfiguration;
|
|
3168
4320
|
}
|
|
3169
|
-
export declare namespace
|
|
4321
|
+
export declare namespace CreateVolumeRequest {
|
|
3170
4322
|
/**
|
|
3171
4323
|
* @internal
|
|
3172
4324
|
*/
|
|
3173
|
-
const filterSensitiveLog: (obj:
|
|
4325
|
+
const filterSensitiveLog: (obj: CreateVolumeRequest) => any;
|
|
3174
4326
|
}
|
|
3175
4327
|
/**
|
|
3176
4328
|
* <p>A volume configuration is required for this operation.</p>
|
|
@@ -3208,7 +4360,7 @@ export declare namespace StorageVirtualMachineNotFound {
|
|
|
3208
4360
|
}
|
|
3209
4361
|
export interface CreateVolumeFromBackupRequest {
|
|
3210
4362
|
/**
|
|
3211
|
-
* <p>The ID of the source backup. Specifies the backup you are copying.</p>
|
|
4363
|
+
* <p>The ID of the source backup. Specifies the backup that you are copying.</p>
|
|
3212
4364
|
*/
|
|
3213
4365
|
BackupId: string | undefined;
|
|
3214
4366
|
/**
|
|
@@ -3236,19 +4388,6 @@ export declare namespace CreateVolumeFromBackupRequest {
|
|
|
3236
4388
|
*/
|
|
3237
4389
|
const filterSensitiveLog: (obj: CreateVolumeFromBackupRequest) => any;
|
|
3238
4390
|
}
|
|
3239
|
-
export interface CreateVolumeFromBackupResponse {
|
|
3240
|
-
/**
|
|
3241
|
-
* <p>Returned after a successful <code>CreateVolumeFromBackup</code> API operation,
|
|
3242
|
-
* describing the volume just created.</p>
|
|
3243
|
-
*/
|
|
3244
|
-
Volume?: Volume;
|
|
3245
|
-
}
|
|
3246
|
-
export declare namespace CreateVolumeFromBackupResponse {
|
|
3247
|
-
/**
|
|
3248
|
-
* @internal
|
|
3249
|
-
*/
|
|
3250
|
-
const filterSensitiveLog: (obj: CreateVolumeFromBackupResponse) => any;
|
|
3251
|
-
}
|
|
3252
4391
|
/**
|
|
3253
4392
|
* <p>You can't delete a backup while it's being copied.</p>
|
|
3254
4393
|
*/
|
|
@@ -3260,7 +4399,7 @@ export interface BackupBeingCopied extends __SmithyException, $MetadataBearer {
|
|
|
3260
4399
|
*/
|
|
3261
4400
|
Message?: string;
|
|
3262
4401
|
/**
|
|
3263
|
-
* <p>The ID of the source backup. Specifies the backup you are copying.</p>
|
|
4402
|
+
* <p>The ID of the source backup. Specifies the backup that you are copying.</p>
|
|
3264
4403
|
*/
|
|
3265
4404
|
BackupId?: string;
|
|
3266
4405
|
}
|
|
@@ -3293,16 +4432,16 @@ export declare namespace BackupRestoring {
|
|
|
3293
4432
|
const filterSensitiveLog: (obj: BackupRestoring) => any;
|
|
3294
4433
|
}
|
|
3295
4434
|
/**
|
|
3296
|
-
* <p>The request object for <code>DeleteBackup</code> operation.</p>
|
|
4435
|
+
* <p>The request object for the <code>DeleteBackup</code> operation.</p>
|
|
3297
4436
|
*/
|
|
3298
4437
|
export interface DeleteBackupRequest {
|
|
3299
4438
|
/**
|
|
3300
|
-
* <p>The ID of the backup you want to delete.</p>
|
|
4439
|
+
* <p>The ID of the backup that you want to delete.</p>
|
|
3301
4440
|
*/
|
|
3302
4441
|
BackupId: string | undefined;
|
|
3303
4442
|
/**
|
|
3304
4443
|
* <p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
|
3305
|
-
* idempotent deletion. This is automatically filled on your behalf when using
|
|
4444
|
+
* idempotent deletion. This parameter is automatically filled on your behalf when using
|
|
3306
4445
|
* the CLI or SDK.</p>
|
|
3307
4446
|
*/
|
|
3308
4447
|
ClientRequestToken?: string;
|
|
@@ -3314,15 +4453,16 @@ export declare namespace DeleteBackupRequest {
|
|
|
3314
4453
|
const filterSensitiveLog: (obj: DeleteBackupRequest) => any;
|
|
3315
4454
|
}
|
|
3316
4455
|
/**
|
|
3317
|
-
* <p>The response object for <code>DeleteBackup</code> operation.</p>
|
|
4456
|
+
* <p>The response object for the <code>DeleteBackup</code> operation.</p>
|
|
3318
4457
|
*/
|
|
3319
4458
|
export interface DeleteBackupResponse {
|
|
3320
4459
|
/**
|
|
3321
|
-
* <p>The ID of the backup deleted.</p>
|
|
4460
|
+
* <p>The ID of the backup that was deleted.</p>
|
|
3322
4461
|
*/
|
|
3323
4462
|
BackupId?: string;
|
|
3324
4463
|
/**
|
|
3325
|
-
* <p>The lifecycle of the backup.
|
|
4464
|
+
* <p>The lifecycle status of the backup. If the <code>DeleteBackup</code> operation is
|
|
4465
|
+
* successful, the status is <code>DELETED</code>.</p>
|
|
3326
4466
|
*/
|
|
3327
4467
|
Lifecycle?: BackupLifecycle | string;
|
|
3328
4468
|
}
|
|
@@ -3333,16 +4473,80 @@ export declare namespace DeleteBackupResponse {
|
|
|
3333
4473
|
const filterSensitiveLog: (obj: DeleteBackupResponse) => any;
|
|
3334
4474
|
}
|
|
3335
4475
|
/**
|
|
3336
|
-
* <p>
|
|
3337
|
-
* <code>DeleteFileSystem</code> operation.</p>
|
|
4476
|
+
* <p>No data repository associations were found based upon the supplied parameters.</p>
|
|
3338
4477
|
*/
|
|
3339
|
-
export interface
|
|
4478
|
+
export interface DataRepositoryAssociationNotFound extends __SmithyException, $MetadataBearer {
|
|
4479
|
+
name: "DataRepositoryAssociationNotFound";
|
|
4480
|
+
$fault: "client";
|
|
3340
4481
|
/**
|
|
3341
|
-
* <p>
|
|
3342
|
-
* system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the
|
|
3343
|
-
* <code>DeleteFileSystem</code> operation is invoked. (Default = true)</p>
|
|
4482
|
+
* <p>A detailed error message.</p>
|
|
3344
4483
|
*/
|
|
3345
|
-
|
|
4484
|
+
Message?: string;
|
|
4485
|
+
}
|
|
4486
|
+
export declare namespace DataRepositoryAssociationNotFound {
|
|
4487
|
+
/**
|
|
4488
|
+
* @internal
|
|
4489
|
+
*/
|
|
4490
|
+
const filterSensitiveLog: (obj: DataRepositoryAssociationNotFound) => any;
|
|
4491
|
+
}
|
|
4492
|
+
export interface DeleteDataRepositoryAssociationRequest {
|
|
4493
|
+
/**
|
|
4494
|
+
* <p>The ID of the data repository association that you want to delete.</p>
|
|
4495
|
+
*/
|
|
4496
|
+
AssociationId: string | undefined;
|
|
4497
|
+
/**
|
|
4498
|
+
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
4499
|
+
* ASCII characters. This token is automatically filled on your behalf when you use the
|
|
4500
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
4501
|
+
*/
|
|
4502
|
+
ClientRequestToken?: string;
|
|
4503
|
+
/**
|
|
4504
|
+
* <p>Set to <code>true</code> to delete the data in the file system that corresponds
|
|
4505
|
+
* to the data repository association.</p>
|
|
4506
|
+
*/
|
|
4507
|
+
DeleteDataInFileSystem: boolean | undefined;
|
|
4508
|
+
}
|
|
4509
|
+
export declare namespace DeleteDataRepositoryAssociationRequest {
|
|
4510
|
+
/**
|
|
4511
|
+
* @internal
|
|
4512
|
+
*/
|
|
4513
|
+
const filterSensitiveLog: (obj: DeleteDataRepositoryAssociationRequest) => any;
|
|
4514
|
+
}
|
|
4515
|
+
export interface DeleteDataRepositoryAssociationResponse {
|
|
4516
|
+
/**
|
|
4517
|
+
* <p>The ID of the data repository association being deleted.</p>
|
|
4518
|
+
*/
|
|
4519
|
+
AssociationId?: string;
|
|
4520
|
+
/**
|
|
4521
|
+
* <p>Describes the lifecycle state of the data repository association being deleted.</p>
|
|
4522
|
+
*/
|
|
4523
|
+
Lifecycle?: DataRepositoryLifecycle | string;
|
|
4524
|
+
/**
|
|
4525
|
+
* <p>Indicates whether data in the file system that corresponds to the data
|
|
4526
|
+
* repository association is being deleted. Default is <code>false</code>.</p>
|
|
4527
|
+
*/
|
|
4528
|
+
DeleteDataInFileSystem?: boolean;
|
|
4529
|
+
}
|
|
4530
|
+
export declare namespace DeleteDataRepositoryAssociationResponse {
|
|
4531
|
+
/**
|
|
4532
|
+
* @internal
|
|
4533
|
+
*/
|
|
4534
|
+
const filterSensitiveLog: (obj: DeleteDataRepositoryAssociationResponse) => any;
|
|
4535
|
+
}
|
|
4536
|
+
/**
|
|
4537
|
+
* <p>The configuration object for the Amazon FSx for Lustre file system being deleted in the
|
|
4538
|
+
* <code>DeleteFileSystem</code> operation.</p>
|
|
4539
|
+
*/
|
|
4540
|
+
export interface DeleteFileSystemLustreConfiguration {
|
|
4541
|
+
/**
|
|
4542
|
+
* <p>Set <code>SkipFinalBackup</code> to false if you want to take a final backup of the file
|
|
4543
|
+
* system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the
|
|
4544
|
+
* <code>DeleteFileSystem</code> operation is invoked. (Default = true)</p>
|
|
4545
|
+
* <note>
|
|
4546
|
+
* <p>The <code>fsx:CreateBackup</code> permission is required if you set <code>SkipFinalBackup</code> to <code>false</code> in order to delete the file system and take a final backup.</p>
|
|
4547
|
+
* </note>
|
|
4548
|
+
*/
|
|
4549
|
+
SkipFinalBackup?: boolean;
|
|
3346
4550
|
/**
|
|
3347
4551
|
* <p>Use if <code>SkipFinalBackup</code> is set to <code>false</code>,
|
|
3348
4552
|
* and you want to apply an array of tags to the final backup. If you have set the file system property
|
|
@@ -3357,6 +4561,31 @@ export declare namespace DeleteFileSystemLustreConfiguration {
|
|
|
3357
4561
|
*/
|
|
3358
4562
|
const filterSensitiveLog: (obj: DeleteFileSystemLustreConfiguration) => any;
|
|
3359
4563
|
}
|
|
4564
|
+
/**
|
|
4565
|
+
* <p>The configuration object for the OpenZFS file system used in the
|
|
4566
|
+
* <code>DeleteFileSystem</code> operation.</p>
|
|
4567
|
+
*/
|
|
4568
|
+
export interface DeleteFileSystemOpenZFSConfiguration {
|
|
4569
|
+
/**
|
|
4570
|
+
* <p>By default, Amazon FSx for OpenZFS takes a final backup on your behalf when
|
|
4571
|
+
* the <code>DeleteFileSystem</code> operation is invoked. Doing this helps protect you
|
|
4572
|
+
* from data loss, and we highly recommend taking the final backup. If you want to skip
|
|
4573
|
+
* this backup, use this
|
|
4574
|
+
* value
|
|
4575
|
+
* to do so. </p>
|
|
4576
|
+
*/
|
|
4577
|
+
SkipFinalBackup?: boolean;
|
|
4578
|
+
/**
|
|
4579
|
+
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
4580
|
+
*/
|
|
4581
|
+
FinalBackupTags?: Tag[];
|
|
4582
|
+
}
|
|
4583
|
+
export declare namespace DeleteFileSystemOpenZFSConfiguration {
|
|
4584
|
+
/**
|
|
4585
|
+
* @internal
|
|
4586
|
+
*/
|
|
4587
|
+
const filterSensitiveLog: (obj: DeleteFileSystemOpenZFSConfiguration) => any;
|
|
4588
|
+
}
|
|
3360
4589
|
/**
|
|
3361
4590
|
* <p>The configuration object for the Microsoft Windows file system used in the
|
|
3362
4591
|
* <code>DeleteFileSystem</code> operation.</p>
|
|
@@ -3385,13 +4614,13 @@ export declare namespace DeleteFileSystemWindowsConfiguration {
|
|
|
3385
4614
|
*/
|
|
3386
4615
|
export interface DeleteFileSystemRequest {
|
|
3387
4616
|
/**
|
|
3388
|
-
* <p>The ID of the file system you want to delete.</p>
|
|
4617
|
+
* <p>The ID of the file system that you want to delete.</p>
|
|
3389
4618
|
*/
|
|
3390
4619
|
FileSystemId: string | undefined;
|
|
3391
4620
|
/**
|
|
3392
4621
|
* <p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
|
3393
|
-
* idempotent deletion. This is automatically filled on your behalf when using the
|
|
3394
|
-
*
|
|
4622
|
+
* idempotent deletion. This token is automatically filled on your behalf when using the
|
|
4623
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
3395
4624
|
*/
|
|
3396
4625
|
ClientRequestToken?: string;
|
|
3397
4626
|
/**
|
|
@@ -3404,6 +4633,11 @@ export interface DeleteFileSystemRequest {
|
|
|
3404
4633
|
* <code>DeleteFileSystem</code> operation.</p>
|
|
3405
4634
|
*/
|
|
3406
4635
|
LustreConfiguration?: DeleteFileSystemLustreConfiguration;
|
|
4636
|
+
/**
|
|
4637
|
+
* <p>The configuration object for the OpenZFS file system used in the
|
|
4638
|
+
* <code>DeleteFileSystem</code> operation.</p>
|
|
4639
|
+
*/
|
|
4640
|
+
OpenZFSConfiguration?: DeleteFileSystemOpenZFSConfiguration;
|
|
3407
4641
|
}
|
|
3408
4642
|
export declare namespace DeleteFileSystemRequest {
|
|
3409
4643
|
/**
|
|
@@ -3431,6 +4665,26 @@ export declare namespace DeleteFileSystemLustreResponse {
|
|
|
3431
4665
|
*/
|
|
3432
4666
|
const filterSensitiveLog: (obj: DeleteFileSystemLustreResponse) => any;
|
|
3433
4667
|
}
|
|
4668
|
+
/**
|
|
4669
|
+
* <p>The response object for the Amazon FSx for OpenZFS file system that's being
|
|
4670
|
+
* deleted in the <code>DeleteFileSystem</code> operation.</p>
|
|
4671
|
+
*/
|
|
4672
|
+
export interface DeleteFileSystemOpenZFSResponse {
|
|
4673
|
+
/**
|
|
4674
|
+
* <p>The ID of the source backup. Specifies the backup that you are copying.</p>
|
|
4675
|
+
*/
|
|
4676
|
+
FinalBackupId?: string;
|
|
4677
|
+
/**
|
|
4678
|
+
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
4679
|
+
*/
|
|
4680
|
+
FinalBackupTags?: Tag[];
|
|
4681
|
+
}
|
|
4682
|
+
export declare namespace DeleteFileSystemOpenZFSResponse {
|
|
4683
|
+
/**
|
|
4684
|
+
* @internal
|
|
4685
|
+
*/
|
|
4686
|
+
const filterSensitiveLog: (obj: DeleteFileSystemOpenZFSResponse) => any;
|
|
4687
|
+
}
|
|
3434
4688
|
/**
|
|
3435
4689
|
* <p>The response object for the Microsoft Windows file system used in the
|
|
3436
4690
|
* <code>DeleteFileSystem</code> operation.</p>
|
|
@@ -3456,12 +4710,13 @@ export declare namespace DeleteFileSystemWindowsResponse {
|
|
|
3456
4710
|
*/
|
|
3457
4711
|
export interface DeleteFileSystemResponse {
|
|
3458
4712
|
/**
|
|
3459
|
-
* <p>The ID of the file system being deleted.</p>
|
|
4713
|
+
* <p>The ID of the file system that's being deleted.</p>
|
|
3460
4714
|
*/
|
|
3461
4715
|
FileSystemId?: string;
|
|
3462
4716
|
/**
|
|
3463
|
-
* <p>The file system lifecycle for the deletion request.
|
|
3464
|
-
*
|
|
4717
|
+
* <p>The file system lifecycle for the deletion request. If the
|
|
4718
|
+
* <code>DeleteFileSystem</code> operation is successful, this status is
|
|
4719
|
+
* <code>DELETING</code>.</p>
|
|
3465
4720
|
*/
|
|
3466
4721
|
Lifecycle?: FileSystemLifecycle | string;
|
|
3467
4722
|
/**
|
|
@@ -3474,6 +4729,11 @@ export interface DeleteFileSystemResponse {
|
|
|
3474
4729
|
* <code>DeleteFileSystem</code> operation.</p>
|
|
3475
4730
|
*/
|
|
3476
4731
|
LustreResponse?: DeleteFileSystemLustreResponse;
|
|
4732
|
+
/**
|
|
4733
|
+
* <p>The response object for the OpenZFS file system that's being deleted in the
|
|
4734
|
+
* <code>DeleteFileSystem</code> operation.</p>
|
|
4735
|
+
*/
|
|
4736
|
+
OpenZFSResponse?: DeleteFileSystemOpenZFSResponse;
|
|
3477
4737
|
}
|
|
3478
4738
|
export declare namespace DeleteFileSystemResponse {
|
|
3479
4739
|
/**
|
|
@@ -3481,6 +4741,58 @@ export declare namespace DeleteFileSystemResponse {
|
|
|
3481
4741
|
*/
|
|
3482
4742
|
const filterSensitiveLog: (obj: DeleteFileSystemResponse) => any;
|
|
3483
4743
|
}
|
|
4744
|
+
export interface DeleteSnapshotRequest {
|
|
4745
|
+
/**
|
|
4746
|
+
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
4747
|
+
* ASCII characters. This token is automatically filled on your behalf when you use the
|
|
4748
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
4749
|
+
*/
|
|
4750
|
+
ClientRequestToken?: string;
|
|
4751
|
+
/**
|
|
4752
|
+
* <p>The ID of the snapshot that you want to delete.</p>
|
|
4753
|
+
*/
|
|
4754
|
+
SnapshotId: string | undefined;
|
|
4755
|
+
}
|
|
4756
|
+
export declare namespace DeleteSnapshotRequest {
|
|
4757
|
+
/**
|
|
4758
|
+
* @internal
|
|
4759
|
+
*/
|
|
4760
|
+
const filterSensitiveLog: (obj: DeleteSnapshotRequest) => any;
|
|
4761
|
+
}
|
|
4762
|
+
export interface DeleteSnapshotResponse {
|
|
4763
|
+
/**
|
|
4764
|
+
* <p>The ID of the deleted snapshot.</p>
|
|
4765
|
+
*/
|
|
4766
|
+
SnapshotId?: string;
|
|
4767
|
+
/**
|
|
4768
|
+
* <p>The lifecycle status of the snapshot. If the <code>DeleteSnapshot</code> operation is
|
|
4769
|
+
* successful, this status is <code>DELETING</code>.</p>
|
|
4770
|
+
*/
|
|
4771
|
+
Lifecycle?: SnapshotLifecycle | string;
|
|
4772
|
+
}
|
|
4773
|
+
export declare namespace DeleteSnapshotResponse {
|
|
4774
|
+
/**
|
|
4775
|
+
* @internal
|
|
4776
|
+
*/
|
|
4777
|
+
const filterSensitiveLog: (obj: DeleteSnapshotResponse) => any;
|
|
4778
|
+
}
|
|
4779
|
+
/**
|
|
4780
|
+
* <p>No Amazon FSx snapshots were found based on the supplied parameters.</p>
|
|
4781
|
+
*/
|
|
4782
|
+
export interface SnapshotNotFound extends __SmithyException, $MetadataBearer {
|
|
4783
|
+
name: "SnapshotNotFound";
|
|
4784
|
+
$fault: "client";
|
|
4785
|
+
/**
|
|
4786
|
+
* <p>A detailed error message.</p>
|
|
4787
|
+
*/
|
|
4788
|
+
Message?: string;
|
|
4789
|
+
}
|
|
4790
|
+
export declare namespace SnapshotNotFound {
|
|
4791
|
+
/**
|
|
4792
|
+
* @internal
|
|
4793
|
+
*/
|
|
4794
|
+
const filterSensitiveLog: (obj: SnapshotNotFound) => any;
|
|
4795
|
+
}
|
|
3484
4796
|
export interface DeleteStorageVirtualMachineRequest {
|
|
3485
4797
|
/**
|
|
3486
4798
|
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
@@ -3535,6 +4847,25 @@ export declare namespace DeleteVolumeOntapConfiguration {
|
|
|
3535
4847
|
*/
|
|
3536
4848
|
const filterSensitiveLog: (obj: DeleteVolumeOntapConfiguration) => any;
|
|
3537
4849
|
}
|
|
4850
|
+
export declare enum DeleteOpenZFSVolumeOption {
|
|
4851
|
+
DELETE_CHILD_VOLUMES_AND_SNAPSHOTS = "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"
|
|
4852
|
+
}
|
|
4853
|
+
/**
|
|
4854
|
+
* <p>A value that specifies whether to delete all child volumes and snapshots. </p>
|
|
4855
|
+
*/
|
|
4856
|
+
export interface DeleteVolumeOpenZFSConfiguration {
|
|
4857
|
+
/**
|
|
4858
|
+
* <p>To delete the volume's children and snapshots, use the string
|
|
4859
|
+
* <code>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</code>.</p>
|
|
4860
|
+
*/
|
|
4861
|
+
Options?: (DeleteOpenZFSVolumeOption | string)[];
|
|
4862
|
+
}
|
|
4863
|
+
export declare namespace DeleteVolumeOpenZFSConfiguration {
|
|
4864
|
+
/**
|
|
4865
|
+
* @internal
|
|
4866
|
+
*/
|
|
4867
|
+
const filterSensitiveLog: (obj: DeleteVolumeOpenZFSConfiguration) => any;
|
|
4868
|
+
}
|
|
3538
4869
|
export interface DeleteVolumeRequest {
|
|
3539
4870
|
/**
|
|
3540
4871
|
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
@@ -3543,14 +4874,20 @@ export interface DeleteVolumeRequest {
|
|
|
3543
4874
|
*/
|
|
3544
4875
|
ClientRequestToken?: string;
|
|
3545
4876
|
/**
|
|
3546
|
-
* <p>The ID of the volume you are deleting.</p>
|
|
4877
|
+
* <p>The ID of the volume that you are deleting.</p>
|
|
3547
4878
|
*/
|
|
3548
4879
|
VolumeId: string | undefined;
|
|
3549
4880
|
/**
|
|
3550
|
-
* <p>For Amazon FSx for ONTAP volumes, specify whether to take
|
|
3551
|
-
*
|
|
4881
|
+
* <p>For Amazon FSx for ONTAP volumes, specify whether to take a final backup of
|
|
4882
|
+
* the volume and apply tags to the backup. To apply tags to the backup, you must have the
|
|
4883
|
+
* <code>fsx:TagResource</code> permission.</p>
|
|
3552
4884
|
*/
|
|
3553
4885
|
OntapConfiguration?: DeleteVolumeOntapConfiguration;
|
|
4886
|
+
/**
|
|
4887
|
+
* <p>For Amazon FSx for OpenZFS volumes, specify whether to delete all child
|
|
4888
|
+
* volumes and snapshots.</p>
|
|
4889
|
+
*/
|
|
4890
|
+
OpenZFSConfiguration?: DeleteVolumeOpenZFSConfiguration;
|
|
3554
4891
|
}
|
|
3555
4892
|
export declare namespace DeleteVolumeRequest {
|
|
3556
4893
|
/**
|
|
@@ -3564,7 +4901,7 @@ export declare namespace DeleteVolumeRequest {
|
|
|
3564
4901
|
*/
|
|
3565
4902
|
export interface DeleteVolumeOntapResponse {
|
|
3566
4903
|
/**
|
|
3567
|
-
* <p>The ID of the source backup. Specifies the backup you are copying.</p>
|
|
4904
|
+
* <p>The ID of the source backup. Specifies the backup that you are copying.</p>
|
|
3568
4905
|
*/
|
|
3569
4906
|
FinalBackupId?: string;
|
|
3570
4907
|
/**
|
|
@@ -3580,16 +4917,17 @@ export declare namespace DeleteVolumeOntapResponse {
|
|
|
3580
4917
|
}
|
|
3581
4918
|
export interface DeleteVolumeResponse {
|
|
3582
4919
|
/**
|
|
3583
|
-
* <p>The ID of the volume being deleted.</p>
|
|
4920
|
+
* <p>The ID of the volume that's being deleted.</p>
|
|
3584
4921
|
*/
|
|
3585
4922
|
VolumeId?: string;
|
|
3586
4923
|
/**
|
|
3587
|
-
* <p>
|
|
4924
|
+
* <p>The lifecycle state of the volume being deleted. If the <code>DeleteVolume</code>
|
|
4925
|
+
* operation is successful, this value is <code>DELETING</code>.</p>
|
|
3588
4926
|
*/
|
|
3589
4927
|
Lifecycle?: VolumeLifecycle | string;
|
|
3590
4928
|
/**
|
|
3591
|
-
* <p>Returned after a <code>DeleteVolume request, showing the status of the delete
|
|
3592
|
-
*
|
|
4929
|
+
* <p>Returned after a <code>DeleteVolume</code> request, showing the status of the delete
|
|
4930
|
+
* request.</p>
|
|
3593
4931
|
*/
|
|
3594
4932
|
OntapResponse?: DeleteVolumeOntapResponse;
|
|
3595
4933
|
}
|
|
@@ -3601,6 +4939,7 @@ export declare namespace DeleteVolumeResponse {
|
|
|
3601
4939
|
}
|
|
3602
4940
|
export declare enum FilterName {
|
|
3603
4941
|
BACKUP_TYPE = "backup-type",
|
|
4942
|
+
DATA_REPOSITORY_TYPE = "data-repository-type",
|
|
3604
4943
|
FILE_SYSTEM_ID = "file-system-id",
|
|
3605
4944
|
FILE_SYSTEM_TYPE = "file-system-type",
|
|
3606
4945
|
VOLUME_ID = "volume-id"
|
|
@@ -3627,31 +4966,31 @@ export declare namespace Filter {
|
|
|
3627
4966
|
const filterSensitiveLog: (obj: Filter) => any;
|
|
3628
4967
|
}
|
|
3629
4968
|
/**
|
|
3630
|
-
* <p>The request object for <code>DescribeBackups</code> operation.</p>
|
|
4969
|
+
* <p>The request object for the <code>DescribeBackups</code> operation.</p>
|
|
3631
4970
|
*/
|
|
3632
4971
|
export interface DescribeBackupsRequest {
|
|
3633
4972
|
/**
|
|
3634
|
-
* <p>IDs of the backups you want to retrieve
|
|
3635
|
-
* filters. If any IDs
|
|
4973
|
+
* <p>The IDs of the backups that you want to retrieve. This parameter value overrides any
|
|
4974
|
+
* filters. If any IDs aren't found, a <code>BackupNotFound</code> error occurs.</p>
|
|
3636
4975
|
*/
|
|
3637
4976
|
BackupIds?: string[];
|
|
3638
4977
|
/**
|
|
3639
|
-
* <p>
|
|
3640
|
-
*
|
|
4978
|
+
* <p>The filters structure. The supported names are <code>file-system-id</code>,
|
|
4979
|
+
* <code>backup-type</code>, <code>file-system-type</code>, and
|
|
3641
4980
|
* <code>volume-id</code>.</p>
|
|
3642
4981
|
*/
|
|
3643
4982
|
Filters?: Filter[];
|
|
3644
4983
|
/**
|
|
3645
|
-
* <p>Maximum number of backups to return in the response
|
|
3646
|
-
*
|
|
3647
|
-
* the
|
|
3648
|
-
*
|
|
4984
|
+
* <p>Maximum number of backups to return in the response. This parameter value must be
|
|
4985
|
+
* greater than 0. The number of items that Amazon FSx returns is the minimum of
|
|
4986
|
+
* the <code>MaxResults</code> parameter specified in the request and the service's
|
|
4987
|
+
* internal maximum number of items per page.</p>
|
|
3649
4988
|
*/
|
|
3650
4989
|
MaxResults?: number;
|
|
3651
4990
|
/**
|
|
3652
|
-
* <p>
|
|
3653
|
-
*
|
|
3654
|
-
*
|
|
4991
|
+
* <p>An opaque pagination token returned from a previous <code>DescribeBackups</code>
|
|
4992
|
+
* operation. If a token is present, the operation continues the list from where the
|
|
4993
|
+
* returning call left off.</p>
|
|
3655
4994
|
*/
|
|
3656
4995
|
NextToken?: string;
|
|
3657
4996
|
}
|
|
@@ -3661,7 +5000,71 @@ export declare namespace DescribeBackupsRequest {
|
|
|
3661
5000
|
*/
|
|
3662
5001
|
const filterSensitiveLog: (obj: DescribeBackupsRequest) => any;
|
|
3663
5002
|
}
|
|
5003
|
+
export interface DescribeDataRepositoryAssociationsRequest {
|
|
5004
|
+
/**
|
|
5005
|
+
* <p>IDs of the data repository associations whose descriptions you want to retrieve
|
|
5006
|
+
* (String).</p>
|
|
5007
|
+
*/
|
|
5008
|
+
AssociationIds?: string[];
|
|
5009
|
+
/**
|
|
5010
|
+
* <p>A list of <code>Filter</code> elements.</p>
|
|
5011
|
+
*/
|
|
5012
|
+
Filters?: Filter[];
|
|
5013
|
+
/**
|
|
5014
|
+
* <p>The maximum number of resources to return in the response. This value must be
|
|
5015
|
+
* an integer greater than zero.</p>
|
|
5016
|
+
*/
|
|
5017
|
+
MaxResults?: number;
|
|
5018
|
+
/**
|
|
5019
|
+
* <p>(Optional) Opaque pagination token returned from a previous operation (String). If
|
|
5020
|
+
* present, this token indicates from what point you can continue processing the request, where
|
|
5021
|
+
* the previous <code>NextToken</code> value left off.</p>
|
|
5022
|
+
*/
|
|
5023
|
+
NextToken?: string;
|
|
5024
|
+
}
|
|
5025
|
+
export declare namespace DescribeDataRepositoryAssociationsRequest {
|
|
5026
|
+
/**
|
|
5027
|
+
* @internal
|
|
5028
|
+
*/
|
|
5029
|
+
const filterSensitiveLog: (obj: DescribeDataRepositoryAssociationsRequest) => any;
|
|
5030
|
+
}
|
|
5031
|
+
export interface DescribeDataRepositoryAssociationsResponse {
|
|
5032
|
+
/**
|
|
5033
|
+
* <p>An array of one ore more data repository association descriptions.</p>
|
|
5034
|
+
*/
|
|
5035
|
+
Associations?: DataRepositoryAssociation[];
|
|
5036
|
+
/**
|
|
5037
|
+
* <p>(Optional) Opaque pagination token returned from a previous operation (String). If
|
|
5038
|
+
* present, this token indicates from what point you can continue processing the request, where
|
|
5039
|
+
* the previous <code>NextToken</code> value left off.</p>
|
|
5040
|
+
*/
|
|
5041
|
+
NextToken?: string;
|
|
5042
|
+
}
|
|
5043
|
+
export declare namespace DescribeDataRepositoryAssociationsResponse {
|
|
5044
|
+
/**
|
|
5045
|
+
* @internal
|
|
5046
|
+
*/
|
|
5047
|
+
const filterSensitiveLog: (obj: DescribeDataRepositoryAssociationsResponse) => any;
|
|
5048
|
+
}
|
|
5049
|
+
/**
|
|
5050
|
+
* <p>You have filtered the response to a data repository type that is not supported.</p>
|
|
5051
|
+
*/
|
|
5052
|
+
export interface InvalidDataRepositoryType extends __SmithyException, $MetadataBearer {
|
|
5053
|
+
name: "InvalidDataRepositoryType";
|
|
5054
|
+
$fault: "client";
|
|
5055
|
+
/**
|
|
5056
|
+
* <p>A detailed error message.</p>
|
|
5057
|
+
*/
|
|
5058
|
+
Message?: string;
|
|
5059
|
+
}
|
|
5060
|
+
export declare namespace InvalidDataRepositoryType {
|
|
5061
|
+
/**
|
|
5062
|
+
* @internal
|
|
5063
|
+
*/
|
|
5064
|
+
const filterSensitiveLog: (obj: InvalidDataRepositoryType) => any;
|
|
5065
|
+
}
|
|
3664
5066
|
export declare enum DataRepositoryTaskFilterName {
|
|
5067
|
+
DATA_REPO_ASSOCIATION_ID = "data-repository-association-id",
|
|
3665
5068
|
FILE_SYSTEM_ID = "file-system-id",
|
|
3666
5069
|
TASK_LIFECYCLE = "task-lifecycle"
|
|
3667
5070
|
}
|
|
@@ -3816,9 +5219,9 @@ export interface DescribeFileSystemsRequest {
|
|
|
3816
5219
|
*/
|
|
3817
5220
|
MaxResults?: number;
|
|
3818
5221
|
/**
|
|
3819
|
-
* <p>Opaque pagination token returned from a previous
|
|
3820
|
-
*
|
|
3821
|
-
*
|
|
5222
|
+
* <p>Opaque pagination token returned from a previous <code>DescribeFileSystems</code>
|
|
5223
|
+
* operation (String). If a token present, the operation continues the list from where the
|
|
5224
|
+
* returning call left off.</p>
|
|
3822
5225
|
*/
|
|
3823
5226
|
NextToken?: string;
|
|
3824
5227
|
}
|
|
@@ -3828,6 +5231,61 @@ export declare namespace DescribeFileSystemsRequest {
|
|
|
3828
5231
|
*/
|
|
3829
5232
|
const filterSensitiveLog: (obj: DescribeFileSystemsRequest) => any;
|
|
3830
5233
|
}
|
|
5234
|
+
export declare enum SnapshotFilterName {
|
|
5235
|
+
FILE_SYSTEM_ID = "file-system-id",
|
|
5236
|
+
VOLUME_ID = "volume-id"
|
|
5237
|
+
}
|
|
5238
|
+
/**
|
|
5239
|
+
* <p>A filter used to restrict the results of <code>DescribeSnapshots</code> calls. You can
|
|
5240
|
+
* use multiple filters to return results that meet all applied filter requirements.</p>
|
|
5241
|
+
*/
|
|
5242
|
+
export interface SnapshotFilter {
|
|
5243
|
+
/**
|
|
5244
|
+
* <p>The name of the filter to use. You can filter by the <code>file-system-id</code> or by
|
|
5245
|
+
* <code>volume-id</code>.</p>
|
|
5246
|
+
*/
|
|
5247
|
+
Name?: SnapshotFilterName | string;
|
|
5248
|
+
/**
|
|
5249
|
+
* <p>The <code>file-system-id</code> or <code>volume-id</code> that you are filtering
|
|
5250
|
+
* for.</p>
|
|
5251
|
+
*/
|
|
5252
|
+
Values?: string[];
|
|
5253
|
+
}
|
|
5254
|
+
export declare namespace SnapshotFilter {
|
|
5255
|
+
/**
|
|
5256
|
+
* @internal
|
|
5257
|
+
*/
|
|
5258
|
+
const filterSensitiveLog: (obj: SnapshotFilter) => any;
|
|
5259
|
+
}
|
|
5260
|
+
export interface DescribeSnapshotsRequest {
|
|
5261
|
+
/**
|
|
5262
|
+
* <p>The IDs of the snapshots that you want to retrieve. This parameter value overrides any
|
|
5263
|
+
* filters. If any IDs aren't found, a <code>SnapshotNotFound</code> error occurs.</p>
|
|
5264
|
+
*/
|
|
5265
|
+
SnapshotIds?: string[];
|
|
5266
|
+
/**
|
|
5267
|
+
* <p>The filters structure. The supported names are <code>file-system-id</code> or
|
|
5268
|
+
* <code>volume-id</code>.</p>
|
|
5269
|
+
*/
|
|
5270
|
+
Filters?: SnapshotFilter[];
|
|
5271
|
+
/**
|
|
5272
|
+
* <p>The maximum number of resources to return in the response. This value must be an
|
|
5273
|
+
* integer greater than zero.</p>
|
|
5274
|
+
*/
|
|
5275
|
+
MaxResults?: number;
|
|
5276
|
+
/**
|
|
5277
|
+
* <p>(Optional) Opaque pagination token returned from a previous operation (String). If
|
|
5278
|
+
* present, this token indicates from what point you can continue processing the request, where
|
|
5279
|
+
* the previous <code>NextToken</code> value left off.</p>
|
|
5280
|
+
*/
|
|
5281
|
+
NextToken?: string;
|
|
5282
|
+
}
|
|
5283
|
+
export declare namespace DescribeSnapshotsRequest {
|
|
5284
|
+
/**
|
|
5285
|
+
* @internal
|
|
5286
|
+
*/
|
|
5287
|
+
const filterSensitiveLog: (obj: DescribeSnapshotsRequest) => any;
|
|
5288
|
+
}
|
|
3831
5289
|
export declare enum StorageVirtualMachineFilterName {
|
|
3832
5290
|
FILE_SYSTEM_ID = "file-system-id"
|
|
3833
5291
|
}
|
|
@@ -3903,9 +5361,9 @@ export declare enum VolumeFilterName {
|
|
|
3903
5361
|
STORAGE_VIRTUAL_MACHINE_ID = "storage-virtual-machine-id"
|
|
3904
5362
|
}
|
|
3905
5363
|
/**
|
|
3906
|
-
* <p>A filter used to restrict the results of describe calls for
|
|
3907
|
-
* Amazon FSx for
|
|
3908
|
-
*
|
|
5364
|
+
* <p>A filter used to restrict the results of describe calls for Amazon FSx for
|
|
5365
|
+
* NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use multiple filters to
|
|
5366
|
+
* return results that meet all applied filter requirements.</p>
|
|
3909
5367
|
*/
|
|
3910
5368
|
export interface VolumeFilter {
|
|
3911
5369
|
/**
|
|
@@ -3926,11 +5384,12 @@ export declare namespace VolumeFilter {
|
|
|
3926
5384
|
}
|
|
3927
5385
|
export interface DescribeVolumesRequest {
|
|
3928
5386
|
/**
|
|
3929
|
-
* <p>IDs of the volumes whose descriptions you want to retrieve.</p>
|
|
5387
|
+
* <p>The IDs of the volumes whose descriptions you want to retrieve.</p>
|
|
3930
5388
|
*/
|
|
3931
5389
|
VolumeIds?: string[];
|
|
3932
5390
|
/**
|
|
3933
|
-
* <p>Enter a filter
|
|
5391
|
+
* <p>Enter a filter <code>Name</code> and <code>Values</code> pair to view a select set of
|
|
5392
|
+
* volumes.</p>
|
|
3934
5393
|
*/
|
|
3935
5394
|
Filters?: VolumeFilter[];
|
|
3936
5395
|
/**
|
|
@@ -3951,24 +5410,6 @@ export declare namespace DescribeVolumesRequest {
|
|
|
3951
5410
|
*/
|
|
3952
5411
|
const filterSensitiveLog: (obj: DescribeVolumesRequest) => any;
|
|
3953
5412
|
}
|
|
3954
|
-
export interface DescribeVolumesResponse {
|
|
3955
|
-
/**
|
|
3956
|
-
* <p>Returned after a successful <code>DescribeVolumes</code> operation, describing each volume.</p>
|
|
3957
|
-
*/
|
|
3958
|
-
Volumes?: Volume[];
|
|
3959
|
-
/**
|
|
3960
|
-
* <p>(Optional) Opaque pagination token returned from a previous operation (String). If
|
|
3961
|
-
* present, this token indicates from what point you can continue processing the request, where
|
|
3962
|
-
* the previous <code>NextToken</code> value left off.</p>
|
|
3963
|
-
*/
|
|
3964
|
-
NextToken?: string;
|
|
3965
|
-
}
|
|
3966
|
-
export declare namespace DescribeVolumesResponse {
|
|
3967
|
-
/**
|
|
3968
|
-
* @internal
|
|
3969
|
-
*/
|
|
3970
|
-
const filterSensitiveLog: (obj: DescribeVolumesResponse) => any;
|
|
3971
|
-
}
|
|
3972
5413
|
/**
|
|
3973
5414
|
* <p>The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.</p>
|
|
3974
5415
|
*/
|
|
@@ -4124,28 +5565,107 @@ export declare namespace ResourceNotFound {
|
|
|
4124
5565
|
*/
|
|
4125
5566
|
const filterSensitiveLog: (obj: ResourceNotFound) => any;
|
|
4126
5567
|
}
|
|
4127
|
-
|
|
4128
|
-
* <p>The request object for the <code>TagResource</code> operation.</p>
|
|
4129
|
-
*/
|
|
4130
|
-
export interface TagResourceRequest {
|
|
5568
|
+
export interface ReleaseFileSystemNfsV3LocksRequest {
|
|
4131
5569
|
/**
|
|
4132
|
-
* <p>The
|
|
4133
|
-
* tag.</p>
|
|
5570
|
+
* <p>The globally unique ID of the file system, assigned by Amazon FSx.</p>
|
|
4134
5571
|
*/
|
|
4135
|
-
|
|
5572
|
+
FileSystemId: string | undefined;
|
|
4136
5573
|
/**
|
|
4137
|
-
* <p>
|
|
4138
|
-
*
|
|
5574
|
+
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
5575
|
+
* ASCII characters. This token is automatically filled on your behalf when you use the
|
|
5576
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
4139
5577
|
*/
|
|
4140
|
-
|
|
5578
|
+
ClientRequestToken?: string;
|
|
4141
5579
|
}
|
|
4142
|
-
export declare namespace
|
|
5580
|
+
export declare namespace ReleaseFileSystemNfsV3LocksRequest {
|
|
4143
5581
|
/**
|
|
4144
5582
|
* @internal
|
|
4145
5583
|
*/
|
|
4146
|
-
const filterSensitiveLog: (obj:
|
|
5584
|
+
const filterSensitiveLog: (obj: ReleaseFileSystemNfsV3LocksRequest) => any;
|
|
4147
5585
|
}
|
|
4148
|
-
|
|
5586
|
+
export declare enum RestoreOpenZFSVolumeOption {
|
|
5587
|
+
DELETE_CLONED_VOLUMES = "DELETE_CLONED_VOLUMES",
|
|
5588
|
+
DELETE_INTERMEDIATE_SNAPSHOTS = "DELETE_INTERMEDIATE_SNAPSHOTS"
|
|
5589
|
+
}
|
|
5590
|
+
export interface RestoreVolumeFromSnapshotRequest {
|
|
5591
|
+
/**
|
|
5592
|
+
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
5593
|
+
* ASCII characters. This token is automatically filled on your behalf when you use the
|
|
5594
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
5595
|
+
*/
|
|
5596
|
+
ClientRequestToken?: string;
|
|
5597
|
+
/**
|
|
5598
|
+
* <p>The ID of the volume that you are restoring.</p>
|
|
5599
|
+
*/
|
|
5600
|
+
VolumeId: string | undefined;
|
|
5601
|
+
/**
|
|
5602
|
+
* <p>The ID of the source snapshot. Specifies the snapshot that you are restoring
|
|
5603
|
+
* from.</p>
|
|
5604
|
+
*/
|
|
5605
|
+
SnapshotId: string | undefined;
|
|
5606
|
+
/**
|
|
5607
|
+
* <p>The settings used when restoring the specified volume from snapshot. </p>
|
|
5608
|
+
* <ul>
|
|
5609
|
+
* <li>
|
|
5610
|
+
* <p>
|
|
5611
|
+
* <code>DELETE_INTERMEDIATE_SNAPSHOTS</code> - Deletes snapshots between the
|
|
5612
|
+
* current state and the specified snapshot. If there are intermediate snapshots
|
|
5613
|
+
* and this option isn't used, <code>RestoreVolumeFromSnapshot</code> fails.</p>
|
|
5614
|
+
* </li>
|
|
5615
|
+
* <li>
|
|
5616
|
+
* <p>
|
|
5617
|
+
* <code>DELETE_CLONED_VOLUMES</code> - Deletes any volumes cloned from this
|
|
5618
|
+
* volume. If there are any cloned volumes and this option isn't used,
|
|
5619
|
+
* <code>RestoreVolumeFromSnapshot</code> fails.</p>
|
|
5620
|
+
* </li>
|
|
5621
|
+
* </ul>
|
|
5622
|
+
*/
|
|
5623
|
+
Options?: (RestoreOpenZFSVolumeOption | string)[];
|
|
5624
|
+
}
|
|
5625
|
+
export declare namespace RestoreVolumeFromSnapshotRequest {
|
|
5626
|
+
/**
|
|
5627
|
+
* @internal
|
|
5628
|
+
*/
|
|
5629
|
+
const filterSensitiveLog: (obj: RestoreVolumeFromSnapshotRequest) => any;
|
|
5630
|
+
}
|
|
5631
|
+
export interface RestoreVolumeFromSnapshotResponse {
|
|
5632
|
+
/**
|
|
5633
|
+
* <p>The ID of the volume that you restored.</p>
|
|
5634
|
+
*/
|
|
5635
|
+
VolumeId?: string;
|
|
5636
|
+
/**
|
|
5637
|
+
* <p>The lifecycle state of the volume being restored.</p>
|
|
5638
|
+
*/
|
|
5639
|
+
Lifecycle?: VolumeLifecycle | string;
|
|
5640
|
+
}
|
|
5641
|
+
export declare namespace RestoreVolumeFromSnapshotResponse {
|
|
5642
|
+
/**
|
|
5643
|
+
* @internal
|
|
5644
|
+
*/
|
|
5645
|
+
const filterSensitiveLog: (obj: RestoreVolumeFromSnapshotResponse) => any;
|
|
5646
|
+
}
|
|
5647
|
+
/**
|
|
5648
|
+
* <p>The request object for the <code>TagResource</code> operation.</p>
|
|
5649
|
+
*/
|
|
5650
|
+
export interface TagResourceRequest {
|
|
5651
|
+
/**
|
|
5652
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to
|
|
5653
|
+
* tag.</p>
|
|
5654
|
+
*/
|
|
5655
|
+
ResourceARN: string | undefined;
|
|
5656
|
+
/**
|
|
5657
|
+
* <p>A list of tags for the resource. If a tag with a given key already exists, the
|
|
5658
|
+
* value is replaced by the one specified in this parameter.</p>
|
|
5659
|
+
*/
|
|
5660
|
+
Tags: Tag[] | undefined;
|
|
5661
|
+
}
|
|
5662
|
+
export declare namespace TagResourceRequest {
|
|
5663
|
+
/**
|
|
5664
|
+
* @internal
|
|
5665
|
+
*/
|
|
5666
|
+
const filterSensitiveLog: (obj: TagResourceRequest) => any;
|
|
5667
|
+
}
|
|
5668
|
+
/**
|
|
4149
5669
|
* <p>The response object for the <code>TagResource</code> operation.</p>
|
|
4150
5670
|
*/
|
|
4151
5671
|
export interface TagResourceResponse {
|
|
@@ -4187,6 +5707,55 @@ export declare namespace UntagResourceResponse {
|
|
|
4187
5707
|
*/
|
|
4188
5708
|
const filterSensitiveLog: (obj: UntagResourceResponse) => any;
|
|
4189
5709
|
}
|
|
5710
|
+
export interface UpdateDataRepositoryAssociationRequest {
|
|
5711
|
+
/**
|
|
5712
|
+
* <p>The ID of the data repository association that you are updating.</p>
|
|
5713
|
+
*/
|
|
5714
|
+
AssociationId: string | undefined;
|
|
5715
|
+
/**
|
|
5716
|
+
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
5717
|
+
* ASCII characters. This token is automatically filled on your behalf when you use the
|
|
5718
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
5719
|
+
*/
|
|
5720
|
+
ClientRequestToken?: string;
|
|
5721
|
+
/**
|
|
5722
|
+
* <p>For files imported from a data repository, this value determines the stripe count and
|
|
5723
|
+
* maximum amount of data per file (in MiB) stored on a single physical disk. The maximum
|
|
5724
|
+
* number of disks that a single file can be striped across is limited by the total number
|
|
5725
|
+
* of disks that make up the file system.</p>
|
|
5726
|
+
*
|
|
5727
|
+
* <p>The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500
|
|
5728
|
+
* GiB). Amazon S3 objects have a maximum size of 5 TB.</p>
|
|
5729
|
+
*/
|
|
5730
|
+
ImportedFileChunkSize?: number;
|
|
5731
|
+
/**
|
|
5732
|
+
* <p>The configuration for an Amazon S3 data repository linked to an
|
|
5733
|
+
* Amazon FSx Lustre file system with a data repository association.
|
|
5734
|
+
* The configuration defines which file events (new, changed, or
|
|
5735
|
+
* deleted files or directories) are automatically imported from
|
|
5736
|
+
* the linked data repository to the file system or automatically
|
|
5737
|
+
* exported from the file system to the data repository.</p>
|
|
5738
|
+
*/
|
|
5739
|
+
S3?: S3DataRepositoryConfiguration;
|
|
5740
|
+
}
|
|
5741
|
+
export declare namespace UpdateDataRepositoryAssociationRequest {
|
|
5742
|
+
/**
|
|
5743
|
+
* @internal
|
|
5744
|
+
*/
|
|
5745
|
+
const filterSensitiveLog: (obj: UpdateDataRepositoryAssociationRequest) => any;
|
|
5746
|
+
}
|
|
5747
|
+
export interface UpdateDataRepositoryAssociationResponse {
|
|
5748
|
+
/**
|
|
5749
|
+
* <p>The response object returned after the data repository association is updated.</p>
|
|
5750
|
+
*/
|
|
5751
|
+
Association?: DataRepositoryAssociation;
|
|
5752
|
+
}
|
|
5753
|
+
export declare namespace UpdateDataRepositoryAssociationResponse {
|
|
5754
|
+
/**
|
|
5755
|
+
* @internal
|
|
5756
|
+
*/
|
|
5757
|
+
const filterSensitiveLog: (obj: UpdateDataRepositoryAssociationResponse) => any;
|
|
5758
|
+
}
|
|
4190
5759
|
/**
|
|
4191
5760
|
* <p>The configuration object for Amazon FSx for Lustre file systems used in the
|
|
4192
5761
|
* <code>UpdateFileSystem</code> operation.</p>
|
|
@@ -4204,8 +5773,9 @@ export interface UpdateFileSystemLustreConfiguration {
|
|
|
4204
5773
|
*/
|
|
4205
5774
|
DailyAutomaticBackupStartTime?: string;
|
|
4206
5775
|
/**
|
|
4207
|
-
* <p>The number of days to retain automatic backups. Setting this to
|
|
4208
|
-
*
|
|
5776
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
5777
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
5778
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
4209
5779
|
*/
|
|
4210
5780
|
AutomaticBackupRetentionDays?: number;
|
|
4211
5781
|
/**
|
|
@@ -4231,11 +5801,19 @@ export interface UpdateFileSystemLustreConfiguration {
|
|
|
4231
5801
|
* <p>
|
|
4232
5802
|
* <code>NEW_CHANGED</code> - AutoImport is on. Amazon FSx automatically imports
|
|
4233
5803
|
* file and directory listings of any new objects added to the S3 bucket and any
|
|
4234
|
-
* existing objects that are changed in the S3 bucket after you choose this option
|
|
4235
|
-
* </
|
|
5804
|
+
* existing objects that are changed in the S3 bucket after you choose this option.</p>
|
|
5805
|
+
* </li>
|
|
5806
|
+
* <li>
|
|
5807
|
+
* <p>
|
|
5808
|
+
* <code>NEW_CHANGED_DELETED</code> - AutoImport is on. Amazon FSx automatically
|
|
5809
|
+
* imports file and directory listings of any new objects added to the S3 bucket, any
|
|
5810
|
+
* existing objects that are changed in the S3 bucket, and any objects that were deleted
|
|
5811
|
+
* in the S3 bucket.</p>
|
|
4236
5812
|
* </li>
|
|
4237
5813
|
* </ul>
|
|
4238
|
-
* <p>
|
|
5814
|
+
* <p>The <code>AutoImportPolicy</code> parameter is not supported for Lustre file systems with
|
|
5815
|
+
* the <code>Persistent_2</code> deployment type. Instead, use
|
|
5816
|
+
* to update a data repository association on your <code>Persistent_2</code> file system.</p>
|
|
4239
5817
|
*/
|
|
4240
5818
|
AutoImportPolicy?: AutoImportPolicyType | string;
|
|
4241
5819
|
/**
|
|
@@ -4258,6 +5836,12 @@ export interface UpdateFileSystemLustreConfiguration {
|
|
|
4258
5836
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html">Lustre data compression</a>.</p>
|
|
4259
5837
|
*/
|
|
4260
5838
|
DataCompressionType?: DataCompressionType | string;
|
|
5839
|
+
/**
|
|
5840
|
+
* <p>The Lustre logging configuration used when updating an Amazon FSx for Lustre
|
|
5841
|
+
* file system. When logging is enabled, Lustre logs error and warning events for
|
|
5842
|
+
* data repositories associated with your file system to Amazon CloudWatch Logs.</p>
|
|
5843
|
+
*/
|
|
5844
|
+
LogConfiguration?: LustreLogCreateConfiguration;
|
|
4261
5845
|
}
|
|
4262
5846
|
export declare namespace UpdateFileSystemLustreConfiguration {
|
|
4263
5847
|
/**
|
|
@@ -4270,8 +5854,9 @@ export declare namespace UpdateFileSystemLustreConfiguration {
|
|
|
4270
5854
|
*/
|
|
4271
5855
|
export interface UpdateFileSystemOntapConfiguration {
|
|
4272
5856
|
/**
|
|
4273
|
-
* <p>The number of days to retain automatic backups. Setting this to
|
|
4274
|
-
*
|
|
5857
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
5858
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
5859
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
4275
5860
|
*/
|
|
4276
5861
|
AutomaticBackupRetentionDays?: number;
|
|
4277
5862
|
/**
|
|
@@ -4302,6 +5887,71 @@ export declare namespace UpdateFileSystemOntapConfiguration {
|
|
|
4302
5887
|
*/
|
|
4303
5888
|
const filterSensitiveLog: (obj: UpdateFileSystemOntapConfiguration) => any;
|
|
4304
5889
|
}
|
|
5890
|
+
/**
|
|
5891
|
+
* <p>The configuration updates for an Amazon FSx for OpenZFS file system.</p>
|
|
5892
|
+
*/
|
|
5893
|
+
export interface UpdateFileSystemOpenZFSConfiguration {
|
|
5894
|
+
/**
|
|
5895
|
+
* <p>The number of days to retain automatic backups. Setting this property to
|
|
5896
|
+
* <code>0</code> disables automatic backups. You can retain automatic backups for a
|
|
5897
|
+
* maximum of 90 days. The default is <code>0</code>.</p>
|
|
5898
|
+
*/
|
|
5899
|
+
AutomaticBackupRetentionDays?: number;
|
|
5900
|
+
/**
|
|
5901
|
+
* <p>A Boolean value indicating whether tags for the file system should be copied to
|
|
5902
|
+
* backups. This value defaults to <code>false</code>. If it's set to <code>true</code>,
|
|
5903
|
+
* all tags for the file system are copied to all automatic and user-initiated backups
|
|
5904
|
+
* where the user doesn't specify tags. If this value is <code>true</code> and you specify
|
|
5905
|
+
* one or more tags, only the specified tags are copied to backups. If you specify one or
|
|
5906
|
+
* more tags when creating a user-initiated backup, no tags are copied from the file
|
|
5907
|
+
* system, regardless of this value. </p>
|
|
5908
|
+
*/
|
|
5909
|
+
CopyTagsToBackups?: boolean;
|
|
5910
|
+
/**
|
|
5911
|
+
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
|
5912
|
+
* This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags
|
|
5913
|
+
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
5914
|
+
* value is <code>true</code> and you specify one or more tags, only the specified tags are
|
|
5915
|
+
* copied to snapshots. If you specify one or more tags when creating the snapshot, no tags
|
|
5916
|
+
* are copied from the volume, regardless of this value. </p>
|
|
5917
|
+
*/
|
|
5918
|
+
CopyTagsToVolumes?: boolean;
|
|
5919
|
+
/**
|
|
5920
|
+
* <p>A recurring daily time, in the format <code>HH:MM</code>. <code>HH</code> is the
|
|
5921
|
+
* zero-padded hour of the day (0-23), and <code>MM</code> is the zero-padded minute of the
|
|
5922
|
+
* hour. For example, <code>05:00</code> specifies 5 AM daily. </p>
|
|
5923
|
+
*/
|
|
5924
|
+
DailyAutomaticBackupStartTime?: string;
|
|
5925
|
+
/**
|
|
5926
|
+
* <p>The throughput of an Amazon FSx file system, measured in megabytes per second
|
|
5927
|
+
* (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048). </p>
|
|
5928
|
+
*/
|
|
5929
|
+
ThroughputCapacity?: number;
|
|
5930
|
+
/**
|
|
5931
|
+
* <p>A recurring weekly time, in the format <code>D:HH:MM</code>. </p>
|
|
5932
|
+
* <p>
|
|
5933
|
+
* <code>D</code> is the day of the week, for which 1 represents Monday and 7
|
|
5934
|
+
* represents Sunday. For further details, see <a href="https://en.wikipedia.org/wiki/ISO_week_date">the ISO-8601 spec as described on Wikipedia</a>.</p>
|
|
5935
|
+
* <p>
|
|
5936
|
+
* <code>HH</code> is the zero-padded hour of the day (0-23), and <code>MM</code> is
|
|
5937
|
+
* the zero-padded minute of the hour. </p>
|
|
5938
|
+
* <p>For example, <code>1:05:00</code> specifies maintenance at 5 AM Monday.</p>
|
|
5939
|
+
*/
|
|
5940
|
+
WeeklyMaintenanceStartTime?: string;
|
|
5941
|
+
/**
|
|
5942
|
+
* <p>The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The
|
|
5943
|
+
* default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per
|
|
5944
|
+
* GB of storage. The configuration consists of the total number of provisioned SSD IOPS
|
|
5945
|
+
* and how the amount was provisioned (by the customer or by the system).</p>
|
|
5946
|
+
*/
|
|
5947
|
+
DiskIopsConfiguration?: DiskIopsConfiguration;
|
|
5948
|
+
}
|
|
5949
|
+
export declare namespace UpdateFileSystemOpenZFSConfiguration {
|
|
5950
|
+
/**
|
|
5951
|
+
* @internal
|
|
5952
|
+
*/
|
|
5953
|
+
const filterSensitiveLog: (obj: UpdateFileSystemOpenZFSConfiguration) => any;
|
|
5954
|
+
}
|
|
4305
5955
|
/**
|
|
4306
5956
|
* <p>The configuration that Amazon FSx uses to join the Windows File Server instance to a
|
|
4307
5957
|
* self-managed Microsoft Active Directory (AD) directory.</p>
|
|
@@ -4382,24 +6032,27 @@ export declare namespace UpdateFileSystemWindowsConfiguration {
|
|
|
4382
6032
|
*/
|
|
4383
6033
|
export interface UpdateFileSystemRequest {
|
|
4384
6034
|
/**
|
|
4385
|
-
* <p>
|
|
6035
|
+
* <p>The ID of the file system that you are updating.</p>
|
|
4386
6036
|
*/
|
|
4387
6037
|
FileSystemId: string | undefined;
|
|
4388
6038
|
/**
|
|
4389
6039
|
* <p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
|
4390
|
-
*
|
|
4391
|
-
*
|
|
6040
|
+
* idempotent updates. This string is automatically filled on your behalf when you use the
|
|
6041
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
4392
6042
|
*/
|
|
4393
6043
|
ClientRequestToken?: string;
|
|
4394
6044
|
/**
|
|
4395
|
-
* <p>Use this parameter to increase the storage capacity of an Amazon FSx for Windows
|
|
4396
|
-
* or Amazon FSx for Lustre file system.
|
|
4397
|
-
*
|
|
4398
|
-
*
|
|
4399
|
-
*
|
|
6045
|
+
* <p>Use this parameter to increase the storage capacity of an Amazon FSx for Windows
|
|
6046
|
+
* File Server or Amazon FSx for Lustre file system. Specifies the storage capacity
|
|
6047
|
+
* target value, in GiB, to increase the storage capacity for the file system that you're
|
|
6048
|
+
* updating. </p>
|
|
6049
|
+
* <note>
|
|
6050
|
+
* <p>You can't make a storage capacity increase request if there is an existing storage
|
|
6051
|
+
* capacity increase request in progress.</p>
|
|
6052
|
+
* </note>
|
|
4400
6053
|
* <p>For Windows file systems, the storage capacity target value must be at least 10 percent
|
|
4401
|
-
*
|
|
4402
|
-
*
|
|
6054
|
+
* greater than the current storage capacity value. To increase storage capacity, the file system
|
|
6055
|
+
* must have at least 16 MBps of throughput capacity.</p>
|
|
4403
6056
|
* <p>For Lustre file systems, the storage capacity target value can be the following:</p>
|
|
4404
6057
|
* <ul>
|
|
4405
6058
|
* <li>
|
|
@@ -4408,21 +6061,28 @@ export interface UpdateFileSystemRequest {
|
|
|
4408
6061
|
* </li>
|
|
4409
6062
|
* <li>
|
|
4410
6063
|
* <p>For <code>PERSISTENT HDD</code> file systems, valid values are multiples of 6000 GiB for
|
|
4411
|
-
* 12
|
|
4412
|
-
* than the current storage capacity.</p>
|
|
6064
|
+
* 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput
|
|
6065
|
+
* per TiB file systems. The values must be greater than the current storage capacity.</p>
|
|
4413
6066
|
* </li>
|
|
4414
6067
|
* <li>
|
|
4415
|
-
* <p>For <code>SCRATCH_1</code> file systems, you
|
|
6068
|
+
* <p>For <code>SCRATCH_1</code> file systems, you can't increase the storage capacity.</p>
|
|
4416
6069
|
* </li>
|
|
4417
6070
|
* </ul>
|
|
6071
|
+
* <p>For OpenZFS file systems, the input/output operations per second (IOPS) automatically
|
|
6072
|
+
* scale with increases to the storage capacity if IOPS is configured for automatic scaling. If
|
|
6073
|
+
* the storage capacity increase would result in less than 3 IOPS per GiB of storage, this
|
|
6074
|
+
* operation returns an error. </p>
|
|
4418
6075
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html">Managing storage
|
|
4419
|
-
* capacity</a> in the <i>Amazon FSx for Windows File Server User
|
|
4420
|
-
*
|
|
4421
|
-
* User Guide</i
|
|
6076
|
+
* capacity</a> in the <i>Amazon FSx for Windows File Server User
|
|
6077
|
+
* Guide</i>, <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html">Managing storage and throughput
|
|
6078
|
+
* capacity</a> in the <i>Amazon FSx for Lustre User Guide</i>, and
|
|
6079
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html">Managing storage capacity</a> in the <i>Amazon FSx for OpenZFS User
|
|
6080
|
+
* Guide</i>.</p>
|
|
4422
6081
|
*/
|
|
4423
6082
|
StorageCapacity?: number;
|
|
4424
6083
|
/**
|
|
4425
|
-
* <p>The configuration updates for an Amazon FSx for Windows File Server file
|
|
6084
|
+
* <p>The configuration updates for an Amazon FSx for Windows File Server file
|
|
6085
|
+
* system.</p>
|
|
4426
6086
|
*/
|
|
4427
6087
|
WindowsConfiguration?: UpdateFileSystemWindowsConfiguration;
|
|
4428
6088
|
/**
|
|
@@ -4434,6 +6094,10 @@ export interface UpdateFileSystemRequest {
|
|
|
4434
6094
|
* <p>The configuration updates for an Amazon FSx for NetApp ONTAP file system.</p>
|
|
4435
6095
|
*/
|
|
4436
6096
|
OntapConfiguration?: UpdateFileSystemOntapConfiguration;
|
|
6097
|
+
/**
|
|
6098
|
+
* <p>The configuration updates for an Amazon FSx for OpenZFS file system.</p>
|
|
6099
|
+
*/
|
|
6100
|
+
OpenZFSConfiguration?: UpdateFileSystemOpenZFSConfiguration;
|
|
4437
6101
|
}
|
|
4438
6102
|
export declare namespace UpdateFileSystemRequest {
|
|
4439
6103
|
/**
|
|
@@ -4441,9 +6105,32 @@ export declare namespace UpdateFileSystemRequest {
|
|
|
4441
6105
|
*/
|
|
4442
6106
|
const filterSensitiveLog: (obj: UpdateFileSystemRequest) => any;
|
|
4443
6107
|
}
|
|
6108
|
+
export interface UpdateSnapshotRequest {
|
|
6109
|
+
/**
|
|
6110
|
+
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
6111
|
+
* ASCII characters. This token is automatically filled on your behalf when you use the
|
|
6112
|
+
* Command Line Interface (CLI) or an Amazon Web Services SDK.</p>
|
|
6113
|
+
*/
|
|
6114
|
+
ClientRequestToken?: string;
|
|
6115
|
+
/**
|
|
6116
|
+
* <p>The name of the snapshot to update. </p>
|
|
6117
|
+
*/
|
|
6118
|
+
Name: string | undefined;
|
|
6119
|
+
/**
|
|
6120
|
+
* <p>The ID of the snapshot that you want to update, in the format
|
|
6121
|
+
* <code>fsvolsnap-0123456789abcdef0</code>.</p>
|
|
6122
|
+
*/
|
|
6123
|
+
SnapshotId: string | undefined;
|
|
6124
|
+
}
|
|
6125
|
+
export declare namespace UpdateSnapshotRequest {
|
|
6126
|
+
/**
|
|
6127
|
+
* @internal
|
|
6128
|
+
*/
|
|
6129
|
+
const filterSensitiveLog: (obj: UpdateSnapshotRequest) => any;
|
|
6130
|
+
}
|
|
4444
6131
|
/**
|
|
4445
6132
|
* <p>Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD.
|
|
4446
|
-
*
|
|
6133
|
+
* Please note, account credentials are not returned in the response payload.</p>
|
|
4447
6134
|
*/
|
|
4448
6135
|
export interface UpdateSvmActiveDirectoryConfiguration {
|
|
4449
6136
|
/**
|
|
@@ -4530,6 +6217,60 @@ export declare namespace UpdateOntapVolumeConfiguration {
|
|
|
4530
6217
|
*/
|
|
4531
6218
|
const filterSensitiveLog: (obj: UpdateOntapVolumeConfiguration) => any;
|
|
4532
6219
|
}
|
|
6220
|
+
/**
|
|
6221
|
+
* <p>Used to specify changes to the OpenZFS configuration for the volume that you are
|
|
6222
|
+
* updating.</p>
|
|
6223
|
+
*/
|
|
6224
|
+
export interface UpdateOpenZFSVolumeConfiguration {
|
|
6225
|
+
/**
|
|
6226
|
+
* <p>The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't
|
|
6227
|
+
* reserve more storage than the parent volume has reserved.</p>
|
|
6228
|
+
*/
|
|
6229
|
+
StorageCapacityReservationGiB?: number;
|
|
6230
|
+
/**
|
|
6231
|
+
* <p></p>
|
|
6232
|
+
* <p>The maximum amount of storage in gibibytes (GiB) that the volume can use from its
|
|
6233
|
+
* parent. You can specify a quota larger than the storage on the parent volume.</p>
|
|
6234
|
+
*/
|
|
6235
|
+
StorageCapacityQuotaGiB?: number;
|
|
6236
|
+
/**
|
|
6237
|
+
* <p></p>
|
|
6238
|
+
* <p>Specifies the method used to compress the data on the volume. Unless the compression
|
|
6239
|
+
* type is specified, volumes inherit the <code>DataCompressionType</code> value of their
|
|
6240
|
+
* parent volume.</p>
|
|
6241
|
+
* <ul>
|
|
6242
|
+
* <li>
|
|
6243
|
+
* <p>
|
|
6244
|
+
* <code>NONE</code> - Doesn't compress the data on the volume.</p>
|
|
6245
|
+
* </li>
|
|
6246
|
+
* <li>
|
|
6247
|
+
* <p>
|
|
6248
|
+
* <code>ZSTD</code> - Compresses the data in the volume using the Zstandard
|
|
6249
|
+
* (ZSTD) compression algorithm. This algorithm reduces the amount of space used on
|
|
6250
|
+
* your volume and has very little impact on compute resources.</p>
|
|
6251
|
+
* </li>
|
|
6252
|
+
* </ul>
|
|
6253
|
+
*/
|
|
6254
|
+
DataCompressionType?: OpenZFSDataCompressionType | string;
|
|
6255
|
+
/**
|
|
6256
|
+
* <p>The configuration object for mounting a Network File System (NFS) file system.</p>
|
|
6257
|
+
*/
|
|
6258
|
+
NfsExports?: OpenZFSNfsExport[];
|
|
6259
|
+
/**
|
|
6260
|
+
* <p>An object specifying how much storage users or groups can use on the volume.</p>
|
|
6261
|
+
*/
|
|
6262
|
+
UserAndGroupQuotas?: OpenZFSUserOrGroupQuota[];
|
|
6263
|
+
/**
|
|
6264
|
+
* <p>A Boolean value indicating whether the volume is read-only.</p>
|
|
6265
|
+
*/
|
|
6266
|
+
ReadOnly?: boolean;
|
|
6267
|
+
}
|
|
6268
|
+
export declare namespace UpdateOpenZFSVolumeConfiguration {
|
|
6269
|
+
/**
|
|
6270
|
+
* @internal
|
|
6271
|
+
*/
|
|
6272
|
+
const filterSensitiveLog: (obj: UpdateOpenZFSVolumeConfiguration) => any;
|
|
6273
|
+
}
|
|
4533
6274
|
export interface UpdateVolumeRequest {
|
|
4534
6275
|
/**
|
|
4535
6276
|
* <p>(Optional) An idempotency token for resource creation, in a string of up to 64
|
|
@@ -4538,35 +6279,34 @@ export interface UpdateVolumeRequest {
|
|
|
4538
6279
|
*/
|
|
4539
6280
|
ClientRequestToken?: string;
|
|
4540
6281
|
/**
|
|
4541
|
-
* <p>
|
|
6282
|
+
* <p>The ID of the volume that you want to update, in the format
|
|
6283
|
+
* <code>fsvol-0123456789abcdef0</code>.</p>
|
|
4542
6284
|
*/
|
|
4543
6285
|
VolumeId: string | undefined;
|
|
4544
6286
|
/**
|
|
4545
|
-
* <p>The
|
|
6287
|
+
* <p>The configuration of the ONTAP volume that you are updating.</p>
|
|
4546
6288
|
*/
|
|
4547
6289
|
OntapConfiguration?: UpdateOntapVolumeConfiguration;
|
|
4548
|
-
}
|
|
4549
|
-
export declare namespace UpdateVolumeRequest {
|
|
4550
6290
|
/**
|
|
4551
|
-
*
|
|
6291
|
+
* <p>The name of the OpenZFS volume. OpenZFS root volumes are automatically named
|
|
6292
|
+
* <code>FSX</code>. Child volume names must be unique among their parent volume's
|
|
6293
|
+
* children. The name of the volume is part of the mount string for the OpenZFS volume. </p>
|
|
4552
6294
|
*/
|
|
4553
|
-
|
|
4554
|
-
}
|
|
4555
|
-
export interface UpdateVolumeResponse {
|
|
6295
|
+
Name?: string;
|
|
4556
6296
|
/**
|
|
4557
|
-
* <p>
|
|
6297
|
+
* <p>The configuration of the OpenZFS volume that you are updating.</p>
|
|
4558
6298
|
*/
|
|
4559
|
-
|
|
6299
|
+
OpenZFSConfiguration?: UpdateOpenZFSVolumeConfiguration;
|
|
4560
6300
|
}
|
|
4561
|
-
export declare namespace
|
|
6301
|
+
export declare namespace UpdateVolumeRequest {
|
|
4562
6302
|
/**
|
|
4563
6303
|
* @internal
|
|
4564
6304
|
*/
|
|
4565
|
-
const filterSensitiveLog: (obj:
|
|
6305
|
+
const filterSensitiveLog: (obj: UpdateVolumeRequest) => any;
|
|
4566
6306
|
}
|
|
4567
6307
|
/**
|
|
4568
|
-
* <p>Describes a specific Amazon FSx administrative action for the current Windows
|
|
4569
|
-
* Lustre file system.</p>
|
|
6308
|
+
* <p>Describes a specific Amazon FSx administrative action for the current Windows,
|
|
6309
|
+
* Lustre, or OpenZFS file system.</p>
|
|
4570
6310
|
*/
|
|
4571
6311
|
export interface AdministrativeAction {
|
|
4572
6312
|
/**
|
|
@@ -4574,15 +6314,16 @@ export interface AdministrativeAction {
|
|
|
4574
6314
|
* <ul>
|
|
4575
6315
|
* <li>
|
|
4576
6316
|
* <p>
|
|
4577
|
-
* <code>FILE_SYSTEM_UPDATE</code> - A file system update administrative action
|
|
4578
|
-
* Amazon FSx console, API
|
|
6317
|
+
* <code>FILE_SYSTEM_UPDATE</code> - A file system update administrative action
|
|
6318
|
+
* initiated from the Amazon FSx console, API
|
|
6319
|
+
* (<code>UpdateFileSystem</code>), or CLI
|
|
6320
|
+
* (<code>update-file-system</code>).</p>
|
|
4579
6321
|
* </li>
|
|
4580
6322
|
* <li>
|
|
4581
6323
|
* <p>
|
|
4582
|
-
* <code>STORAGE_OPTIMIZATION</code> -
|
|
4583
|
-
* task to increase a file system's storage capacity
|
|
4584
|
-
* <code>STORAGE_OPTIMIZATION</code> task starts.
|
|
4585
|
-
* </p>
|
|
6324
|
+
* <code>STORAGE_OPTIMIZATION</code> - After the <code>FILE_SYSTEM_UPDATE</code>
|
|
6325
|
+
* task to increase a file system's storage capacity has been completed
|
|
6326
|
+
* successfully, a <code>STORAGE_OPTIMIZATION</code> task starts. </p>
|
|
4586
6327
|
* <ul>
|
|
4587
6328
|
* <li>
|
|
4588
6329
|
* <p>For Windows, storage optimization is the process of migrating the file system data
|
|
@@ -4592,38 +6333,61 @@ export interface AdministrativeAction {
|
|
|
4592
6333
|
* <p>For Lustre, storage optimization consists of rebalancing the data across the existing and
|
|
4593
6334
|
* newly added file servers.</p>
|
|
4594
6335
|
* </li>
|
|
6336
|
+
* <li>
|
|
6337
|
+
* <p>For OpenZFS, storage optimization consists of migrating data from the
|
|
6338
|
+
* older smaller disks to the newer larger disks.</p>
|
|
6339
|
+
* </li>
|
|
4595
6340
|
* </ul>
|
|
4596
|
-
* <p>You can track the storage
|
|
6341
|
+
* <p>You can track the storage-optimization progress using the
|
|
4597
6342
|
* <code>ProgressPercent</code> property. When
|
|
4598
|
-
* <code>STORAGE_OPTIMIZATION</code>
|
|
4599
|
-
*
|
|
6343
|
+
* <code>STORAGE_OPTIMIZATION</code> has been completed successfully, the
|
|
6344
|
+
* parent <code>FILE_SYSTEM_UPDATE</code> action status changes to
|
|
4600
6345
|
* <code>COMPLETED</code>. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html">Managing
|
|
4601
|
-
* storage capacity</a> in the <i>Amazon FSx for Windows
|
|
4602
|
-
* User Guide</i
|
|
4603
|
-
* and throughput capacity</a> in the <i>Amazon FSx for
|
|
4604
|
-
* Guide</i
|
|
6346
|
+
* storage capacity</a> in the <i>Amazon FSx for Windows
|
|
6347
|
+
* File Server User Guide</i>, <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html">Managing storage
|
|
6348
|
+
* and throughput capacity</a> in the <i>Amazon FSx for
|
|
6349
|
+
* Lustre User Guide</i>, and <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-storage-capacity.html">Managing storage capacity</a> in the
|
|
6350
|
+
* <i>Amazon FSx for OpenZFS User Guide</i>. </p>
|
|
4605
6351
|
* </li>
|
|
4606
6352
|
* <li>
|
|
4607
6353
|
* <p>
|
|
4608
|
-
* <code>FILE_SYSTEM_ALIAS_ASSOCIATION</code> - A file system update to associate a new
|
|
4609
|
-
*
|
|
4610
|
-
*
|
|
6354
|
+
* <code>FILE_SYSTEM_ALIAS_ASSOCIATION</code> - A file system update to associate a new Domain
|
|
6355
|
+
* Name System (DNS) alias with the file system. For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html">
|
|
6356
|
+
* AssociateFileSystemAliases</a>.</p>
|
|
4611
6357
|
* </li>
|
|
4612
6358
|
* <li>
|
|
4613
6359
|
* <p>
|
|
4614
6360
|
* <code>FILE_SYSTEM_ALIAS_DISASSOCIATION</code> - A file system update to disassociate a DNS alias from the file system.
|
|
4615
|
-
* For more information, see
|
|
6361
|
+
* For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html">DisassociateFileSystemAliases</a>.</p>
|
|
6362
|
+
* </li>
|
|
6363
|
+
* <li>
|
|
6364
|
+
* <p>
|
|
6365
|
+
* <code>VOLUME_UPDATE</code> - A volume update to an Amazon FSx for NetApp ONTAP or
|
|
6366
|
+
* Amazon FSx for OpenZFS volume initiated from the Amazon FSx
|
|
6367
|
+
* console, API (<code>UpdateVolume</code>), or CLI
|
|
6368
|
+
* (<code>update-volume</code>).</p>
|
|
6369
|
+
* </li>
|
|
6370
|
+
* <li>
|
|
6371
|
+
* <p>
|
|
6372
|
+
* <code>SNAPSHOT_UPDATE</code> - A snapshot update to an Amazon FSx for
|
|
6373
|
+
* OpenZFS volume initiated from the Amazon FSx console, API
|
|
6374
|
+
* (<code>UpdateSnapshot</code>), or CLI (<code>update-snapshot</code>).</p>
|
|
6375
|
+
* </li>
|
|
6376
|
+
* <li>
|
|
6377
|
+
* <p>
|
|
6378
|
+
* <code>RELEASE_NFS_V3_LOCKS</code> - Tracks the release of Network File System
|
|
6379
|
+
* (NFS) V3 locks on an Amazon FSx for OpenZFS file system. </p>
|
|
4616
6380
|
* </li>
|
|
4617
6381
|
* </ul>
|
|
4618
6382
|
*/
|
|
4619
6383
|
AdministrativeActionType?: AdministrativeActionType | string;
|
|
4620
6384
|
/**
|
|
4621
|
-
* <p>
|
|
4622
|
-
* Does not apply to any other administrative action type.</p>
|
|
6385
|
+
* <p>The percentage-complete status of a <code>STORAGE_OPTIMIZATION</code> administrative
|
|
6386
|
+
* action. Does not apply to any other administrative action type.</p>
|
|
4623
6387
|
*/
|
|
4624
6388
|
ProgressPercent?: number;
|
|
4625
6389
|
/**
|
|
4626
|
-
* <p>
|
|
6390
|
+
* <p>The time that the administrative action request was received.</p>
|
|
4627
6391
|
*/
|
|
4628
6392
|
RequestTime?: Date;
|
|
4629
6393
|
/**
|
|
@@ -4631,7 +6395,8 @@ export interface AdministrativeAction {
|
|
|
4631
6395
|
* <ul>
|
|
4632
6396
|
* <li>
|
|
4633
6397
|
* <p>
|
|
4634
|
-
* <code>FAILED</code> - Amazon FSx failed to process the administrative action
|
|
6398
|
+
* <code>FAILED</code> - Amazon FSx failed to process the administrative action
|
|
6399
|
+
* successfully.</p>
|
|
4635
6400
|
* </li>
|
|
4636
6401
|
* <li>
|
|
4637
6402
|
* <p>
|
|
@@ -4639,22 +6404,19 @@ export interface AdministrativeAction {
|
|
|
4639
6404
|
* </li>
|
|
4640
6405
|
* <li>
|
|
4641
6406
|
* <p>
|
|
4642
|
-
* <code>PENDING</code> - Amazon FSx is waiting to process the administrative
|
|
6407
|
+
* <code>PENDING</code> - Amazon FSx is waiting to process the administrative
|
|
6408
|
+
* action.</p>
|
|
4643
6409
|
* </li>
|
|
4644
6410
|
* <li>
|
|
4645
6411
|
* <p>
|
|
4646
|
-
* <code>COMPLETED</code> - Amazon FSx has finished processing the administrative
|
|
6412
|
+
* <code>COMPLETED</code> - Amazon FSx has finished processing the administrative
|
|
6413
|
+
* task.</p>
|
|
4647
6414
|
* </li>
|
|
4648
6415
|
* <li>
|
|
4649
6416
|
* <p>
|
|
4650
|
-
* <code>UPDATED_OPTIMIZING</code> - For a storage
|
|
4651
|
-
* updated the file system with the new storage capacity, and is now performing
|
|
4652
|
-
* storage
|
|
4653
|
-
* <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html">Managing
|
|
4654
|
-
* storage capacity</a> in the <i>Amazon FSx for Windows File Server
|
|
4655
|
-
* User Guide</i> and <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html">Managing storage
|
|
4656
|
-
* and throughput capacity</a> in the <i>Amazon FSx for Lustre User
|
|
4657
|
-
* Guide</i>.</p>
|
|
6417
|
+
* <code>UPDATED_OPTIMIZING</code> - For a storage-capacity increase update, Amazon FSx
|
|
6418
|
+
* has updated the file system with the new storage capacity, and is now performing
|
|
6419
|
+
* the storage-optimization process. </p>
|
|
4658
6420
|
* </li>
|
|
4659
6421
|
* </ul>
|
|
4660
6422
|
*/
|
|
@@ -4671,9 +6433,14 @@ export interface AdministrativeAction {
|
|
|
4671
6433
|
*/
|
|
4672
6434
|
FailureDetails?: AdministrativeActionFailureDetails;
|
|
4673
6435
|
/**
|
|
4674
|
-
* <p>Describes an Amazon FSx for NetApp ONTAP
|
|
6436
|
+
* <p>Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS
|
|
6437
|
+
* volume.</p>
|
|
4675
6438
|
*/
|
|
4676
6439
|
TargetVolumeValues?: Volume;
|
|
6440
|
+
/**
|
|
6441
|
+
* <p>A snapshot of an Amazon FSx for OpenZFS volume.</p>
|
|
6442
|
+
*/
|
|
6443
|
+
TargetSnapshotValues?: Snapshot;
|
|
4677
6444
|
}
|
|
4678
6445
|
export declare namespace AdministrativeAction {
|
|
4679
6446
|
/**
|
|
@@ -4701,12 +6468,13 @@ export interface FileSystem {
|
|
|
4701
6468
|
*/
|
|
4702
6469
|
FileSystemId?: string;
|
|
4703
6470
|
/**
|
|
4704
|
-
* <p>The type of Amazon FSx file system, which can be <code>LUSTRE</code>,
|
|
4705
|
-
*
|
|
6471
|
+
* <p>The type of Amazon FSx file system, which can be <code>LUSTRE</code>,
|
|
6472
|
+
* <code>WINDOWS</code>, <code>ONTAP</code>, or <code>OPENZFS</code>.</p>
|
|
4706
6473
|
*/
|
|
4707
6474
|
FileSystemType?: FileSystemType | string;
|
|
4708
6475
|
/**
|
|
4709
|
-
* <p>The lifecycle status of the file system
|
|
6476
|
+
* <p>The lifecycle status of the file system. The following are the possible values and
|
|
6477
|
+
* what they mean:</p>
|
|
4710
6478
|
* <ul>
|
|
4711
6479
|
* <li>
|
|
4712
6480
|
* <p>
|
|
@@ -4726,19 +6494,19 @@ export interface FileSystem {
|
|
|
4726
6494
|
* When creating a new file system, Amazon FSx was unable to create the file system.</p>
|
|
4727
6495
|
* </li>
|
|
4728
6496
|
* <li>
|
|
4729
|
-
*
|
|
4730
|
-
* <code>MISCONFIGURED</code>
|
|
4731
|
-
*
|
|
6497
|
+
* <p>
|
|
6498
|
+
* <code>MISCONFIGURED</code> - The file system is in a failed but recoverable state.</p>
|
|
6499
|
+
* </li>
|
|
4732
6500
|
* <li>
|
|
4733
|
-
*
|
|
4734
|
-
* <code>UPDATING</code>
|
|
4735
|
-
*
|
|
6501
|
+
* <p>
|
|
6502
|
+
* <code>UPDATING</code> - The file system is undergoing a customer-initiated update.</p>
|
|
6503
|
+
* </li>
|
|
4736
6504
|
* </ul>
|
|
4737
6505
|
*/
|
|
4738
6506
|
Lifecycle?: FileSystemLifecycle | string;
|
|
4739
6507
|
/**
|
|
4740
|
-
* <p>A structure providing details of any failures that
|
|
4741
|
-
*
|
|
6508
|
+
* <p>A structure providing details of any failures that occurred when creating a file
|
|
6509
|
+
* system.</p>
|
|
4742
6510
|
*/
|
|
4743
6511
|
FailureDetails?: FileSystemFailureDetails;
|
|
4744
6512
|
/**
|
|
@@ -4746,50 +6514,50 @@ export interface FileSystem {
|
|
|
4746
6514
|
*/
|
|
4747
6515
|
StorageCapacity?: number;
|
|
4748
6516
|
/**
|
|
4749
|
-
* <p>The
|
|
4750
|
-
* Valid values are <code>SSD</code> and <code>HDD</code>.
|
|
6517
|
+
* <p>The type of storage the file system is using.
|
|
4751
6518
|
* If set to <code>SSD</code>, the file system uses solid state drive storage.
|
|
4752
6519
|
* If set to <code>HDD</code>, the file system uses hard disk drive storage.
|
|
4753
6520
|
* </p>
|
|
4754
6521
|
*/
|
|
4755
6522
|
StorageType?: StorageType | string;
|
|
4756
6523
|
/**
|
|
4757
|
-
* <p>The ID of the primary VPC for the file system.</p>
|
|
6524
|
+
* <p>The ID of the primary virtual private cloud (VPC) for the file system.</p>
|
|
4758
6525
|
*/
|
|
4759
6526
|
VpcId?: string;
|
|
4760
6527
|
/**
|
|
4761
|
-
* <p>Specifies the IDs of the subnets that the file system is accessible from. For Windows and
|
|
6528
|
+
* <p>Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and
|
|
4762
6529
|
* ONTAP <code>MULTI_AZ_1</code> file system deployment type, there are two subnet IDs, one for
|
|
4763
6530
|
* the preferred file server and one for the standby file server. The preferred file server subnet
|
|
4764
6531
|
* identified in the <code>PreferredSubnetID</code> property. All other file systems have only one subnet ID.</p>
|
|
4765
|
-
* <p>For Lustre file systems, and Single-AZ Windows file systems, this is the ID of
|
|
4766
|
-
* the subnet that contains the
|
|
4767
|
-
* ONTAP file systems, the
|
|
6532
|
+
* <p>For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of
|
|
6533
|
+
* the subnet that contains the file system's endpoint. For <code>MULTI_AZ_1</code> Windows and
|
|
6534
|
+
* ONTAP file systems, the file system endpoint is available in the <code>PreferredSubnetID</code>.</p>
|
|
4768
6535
|
*/
|
|
4769
6536
|
SubnetIds?: string[];
|
|
4770
6537
|
/**
|
|
4771
|
-
* <p>The IDs of the elastic network
|
|
4772
|
-
* accessible. The elastic network interface is automatically created in the same
|
|
4773
|
-
* the Amazon FSx file system was created in. For more
|
|
4774
|
-
*
|
|
6538
|
+
* <p>The IDs of the elastic network interfaces from which a specific file system is
|
|
6539
|
+
* accessible. The elastic network interface is automatically created in the same virtual
|
|
6540
|
+
* private cloud (VPC) that the Amazon FSx file system was created in. For more
|
|
6541
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html">Elastic Network Interfaces</a> in
|
|
6542
|
+
* the <i>Amazon EC2 User Guide.</i>
|
|
4775
6543
|
* </p>
|
|
4776
6544
|
*
|
|
4777
|
-
* <p>For an Amazon FSx for Windows File Server file system, you can have one
|
|
4778
|
-
* interface ID. For an Amazon FSx for Lustre file system, you can have
|
|
4779
|
-
* one.</p>
|
|
6545
|
+
* <p>For an Amazon FSx for Windows File Server file system, you can have one
|
|
6546
|
+
* network interface ID. For an Amazon FSx for Lustre file system, you can have
|
|
6547
|
+
* more than one.</p>
|
|
4780
6548
|
*/
|
|
4781
6549
|
NetworkInterfaceIds?: string[];
|
|
4782
6550
|
/**
|
|
4783
|
-
* <p>The DNS name for the file system.</p>
|
|
6551
|
+
* <p>The Domain Name System (DNS) name for the file system.</p>
|
|
4784
6552
|
*/
|
|
4785
6553
|
DNSName?: string;
|
|
4786
6554
|
/**
|
|
4787
|
-
* <p>The ID of the Key Management Service (KMS) key used to encrypt the file
|
|
4788
|
-
* for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and
|
|
4789
|
-
*
|
|
4790
|
-
*
|
|
4791
|
-
*
|
|
4792
|
-
*
|
|
6555
|
+
* <p>The ID of the Key Management Service (KMS) key used to encrypt the file
|
|
6556
|
+
* system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and <code>PERSISTENT</code>
|
|
6557
|
+
* Amazon FSx for Lustre file systems at rest. If this ID isn't specified, the
|
|
6558
|
+
* Amazon FSx-managed key for your account is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using the Amazon
|
|
6559
|
+
* FSx-managed key for your account. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html">Encrypt</a> in the
|
|
6560
|
+
* <i>Key Management Service API Reference</i>.</p>
|
|
4793
6561
|
*/
|
|
4794
6562
|
KmsKeyId?: string;
|
|
4795
6563
|
/**
|
|
@@ -4797,13 +6565,13 @@ export interface FileSystem {
|
|
|
4797
6565
|
*/
|
|
4798
6566
|
ResourceARN?: string;
|
|
4799
6567
|
/**
|
|
4800
|
-
* <p>The tags to associate with the file system. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging
|
|
4801
|
-
* Amazon EC2
|
|
6568
|
+
* <p>The tags to associate with the file system. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging your
|
|
6569
|
+
* Amazon EC2 resources</a> in the <i>Amazon EC2 User
|
|
4802
6570
|
* Guide</i>.</p>
|
|
4803
6571
|
*/
|
|
4804
6572
|
Tags?: Tag[];
|
|
4805
6573
|
/**
|
|
4806
|
-
* <p>The configuration for this
|
|
6574
|
+
* <p>The configuration for this FSx for Windows File Server file system.</p>
|
|
4807
6575
|
*/
|
|
4808
6576
|
WindowsConfiguration?: WindowsFileSystemConfiguration;
|
|
4809
6577
|
/**
|
|
@@ -4811,20 +6579,24 @@ export interface FileSystem {
|
|
|
4811
6579
|
*/
|
|
4812
6580
|
LustreConfiguration?: LustreFileSystemConfiguration;
|
|
4813
6581
|
/**
|
|
4814
|
-
* <p>A list of administrative actions for the file system that are in process or waiting to
|
|
4815
|
-
* Administrative actions describe changes to the Amazon FSx
|
|
4816
|
-
* the <code>UpdateFileSystem</code>
|
|
6582
|
+
* <p>A list of administrative actions for the file system that are in process or waiting to
|
|
6583
|
+
* be processed. Administrative actions describe changes to the Amazon FSx system
|
|
6584
|
+
* that you have initiated using the <code>UpdateFileSystem</code> operation.</p>
|
|
4817
6585
|
*/
|
|
4818
6586
|
AdministrativeActions?: AdministrativeAction[];
|
|
4819
6587
|
/**
|
|
4820
|
-
* <p>The configuration for this FSx for
|
|
6588
|
+
* <p>The configuration for this FSx for ONTAP file system.</p>
|
|
4821
6589
|
*/
|
|
4822
6590
|
OntapConfiguration?: OntapFileSystemConfiguration;
|
|
4823
6591
|
/**
|
|
4824
|
-
* <p>The version of
|
|
6592
|
+
* <p>The Lustre version of the Amazon FSx for Lustrefile system, either
|
|
4825
6593
|
* <code>2.10</code> or <code>2.12</code>.</p>
|
|
4826
6594
|
*/
|
|
4827
6595
|
FileSystemTypeVersion?: string;
|
|
6596
|
+
/**
|
|
6597
|
+
* <p>The configuration for this Amazon FSx for OpenZFS file system.</p>
|
|
6598
|
+
*/
|
|
6599
|
+
OpenZFSConfiguration?: OpenZFSFileSystemConfiguration;
|
|
4828
6600
|
}
|
|
4829
6601
|
export declare namespace FileSystem {
|
|
4830
6602
|
/**
|
|
@@ -4833,115 +6605,173 @@ export declare namespace FileSystem {
|
|
|
4833
6605
|
const filterSensitiveLog: (obj: FileSystem) => any;
|
|
4834
6606
|
}
|
|
4835
6607
|
/**
|
|
4836
|
-
* <p>A
|
|
4837
|
-
* or of an Amazon FSx for NetApp ONTAP volume.</p>
|
|
6608
|
+
* <p>A snapshot of an Amazon FSx for OpenZFS volume.</p>
|
|
4838
6609
|
*/
|
|
4839
|
-
export interface
|
|
6610
|
+
export interface Snapshot {
|
|
4840
6611
|
/**
|
|
4841
|
-
* <p>The
|
|
6612
|
+
* <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services
|
|
6613
|
+
* resources. We require an ARN when you need to specify a resource unambiguously across
|
|
6614
|
+
* all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in
|
|
6615
|
+
* the <i>Amazon Web Services General Reference</i>.</p>
|
|
4842
6616
|
*/
|
|
4843
|
-
|
|
6617
|
+
ResourceARN?: string;
|
|
4844
6618
|
/**
|
|
4845
|
-
* <p>The
|
|
6619
|
+
* <p>The ID of the snapshot.</p>
|
|
6620
|
+
*/
|
|
6621
|
+
SnapshotId?: string;
|
|
6622
|
+
/**
|
|
6623
|
+
* <p>The name of the snapshot.</p>
|
|
6624
|
+
*/
|
|
6625
|
+
Name?: string;
|
|
6626
|
+
/**
|
|
6627
|
+
* <p>The ID of the volume that the snapshot is of.</p>
|
|
6628
|
+
*/
|
|
6629
|
+
VolumeId?: string;
|
|
6630
|
+
/**
|
|
6631
|
+
* <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z),
|
|
6632
|
+
* also known as Unix time.</p>
|
|
6633
|
+
*/
|
|
6634
|
+
CreationTime?: Date;
|
|
6635
|
+
/**
|
|
6636
|
+
* <p>The lifecycle status of the snapshot.</p>
|
|
4846
6637
|
* <ul>
|
|
4847
6638
|
* <li>
|
|
4848
|
-
*
|
|
4849
|
-
* <code>
|
|
4850
|
-
*
|
|
4851
|
-
* <li>
|
|
4852
|
-
* <p>
|
|
4853
|
-
* <code>PENDING</code> - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.</p>
|
|
4854
|
-
* </li>
|
|
4855
|
-
* <li>
|
|
4856
|
-
* <p>
|
|
4857
|
-
* <code>CREATING</code> - Amazon FSx is creating the backup.</p>
|
|
6639
|
+
* <p>
|
|
6640
|
+
* <code>PENDING</code> - Amazon FSx hasn't started creating the
|
|
6641
|
+
* snapshot.</p>
|
|
4858
6642
|
* </li>
|
|
4859
6643
|
* <li>
|
|
4860
|
-
*
|
|
4861
|
-
* <code>
|
|
6644
|
+
* <p>
|
|
6645
|
+
* <code>CREATING</code> - Amazon FSx is creating the snapshot.</p>
|
|
4862
6646
|
* </li>
|
|
4863
6647
|
* <li>
|
|
4864
|
-
*
|
|
4865
|
-
* <code>
|
|
6648
|
+
* <p>
|
|
6649
|
+
* <code>DELETING</code> - Amazon FSx is deleting the snapshot.</p>
|
|
4866
6650
|
* </li>
|
|
4867
6651
|
* <li>
|
|
4868
|
-
*
|
|
4869
|
-
* <code>
|
|
4870
|
-
* </li>
|
|
4871
|
-
* <li>
|
|
4872
|
-
* <p>
|
|
4873
|
-
* <code>FAILED</code> - Amazon FSx could not complete the backup.</p>
|
|
6652
|
+
* <p>
|
|
6653
|
+
* <code>AVAILABLE</code> - The snapshot is fully available.</p>
|
|
4874
6654
|
* </li>
|
|
4875
6655
|
* </ul>
|
|
4876
6656
|
*/
|
|
4877
|
-
Lifecycle
|
|
6657
|
+
Lifecycle?: SnapshotLifecycle | string;
|
|
4878
6658
|
/**
|
|
4879
|
-
* <p>
|
|
6659
|
+
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
4880
6660
|
*/
|
|
4881
|
-
|
|
6661
|
+
Tags?: Tag[];
|
|
4882
6662
|
/**
|
|
4883
|
-
* <p>
|
|
6663
|
+
* <p>A list of administrative actions for the file system that are in process or waiting to
|
|
6664
|
+
* be processed. Administrative actions describe changes to the Amazon FSx
|
|
6665
|
+
* system.</p>
|
|
4884
6666
|
*/
|
|
4885
|
-
|
|
6667
|
+
AdministrativeActions?: AdministrativeAction[];
|
|
6668
|
+
}
|
|
6669
|
+
export declare namespace Snapshot {
|
|
4886
6670
|
/**
|
|
4887
|
-
*
|
|
6671
|
+
* @internal
|
|
4888
6672
|
*/
|
|
4889
|
-
|
|
6673
|
+
const filterSensitiveLog: (obj: Snapshot) => any;
|
|
6674
|
+
}
|
|
6675
|
+
/**
|
|
6676
|
+
* <p>Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS
|
|
6677
|
+
* volume.</p>
|
|
6678
|
+
*/
|
|
6679
|
+
export interface Volume {
|
|
4890
6680
|
/**
|
|
4891
|
-
* <p>The time
|
|
6681
|
+
* <p>The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z),
|
|
6682
|
+
* also known as Unix time.</p>
|
|
4892
6683
|
*/
|
|
4893
|
-
CreationTime
|
|
6684
|
+
CreationTime?: Date;
|
|
4894
6685
|
/**
|
|
4895
|
-
* <p>The ID of the
|
|
4896
|
-
* backup of the Amazon FSx file system's data at rest.
|
|
4897
|
-
* </p>
|
|
6686
|
+
* <p>The globally unique ID of the file system, assigned by Amazon FSx.</p>
|
|
4898
6687
|
*/
|
|
4899
|
-
|
|
6688
|
+
FileSystemId?: string;
|
|
4900
6689
|
/**
|
|
4901
|
-
* <p>The
|
|
6690
|
+
* <p>The lifecycle status of the volume.</p>
|
|
6691
|
+
* <ul>
|
|
6692
|
+
* <li>
|
|
6693
|
+
* <p>
|
|
6694
|
+
* <code>AVAILABLE</code> - The volume is fully available for
|
|
6695
|
+
* use.</p>
|
|
6696
|
+
* </li>
|
|
6697
|
+
* <li>
|
|
6698
|
+
* <p>
|
|
6699
|
+
* <code>CREATED</code> - The volume has been created.</p>
|
|
6700
|
+
* </li>
|
|
6701
|
+
* <li>
|
|
6702
|
+
* <p>
|
|
6703
|
+
* <code>CREATING</code> - Amazon FSx is creating the new volume.</p>
|
|
6704
|
+
* </li>
|
|
6705
|
+
* <li>
|
|
6706
|
+
* <p>
|
|
6707
|
+
* <code>DELETING</code> - Amazon FSx is deleting an existing
|
|
6708
|
+
* volume.</p>
|
|
6709
|
+
* </li>
|
|
6710
|
+
* <li>
|
|
6711
|
+
* <p>
|
|
6712
|
+
* <code>FAILED</code> - Amazon FSx was unable to create the
|
|
6713
|
+
* volume.</p>
|
|
6714
|
+
* </li>
|
|
6715
|
+
* <li>
|
|
6716
|
+
* <p>
|
|
6717
|
+
* <code>MISCONFIGURED</code> - The volume is in a failed but recoverable
|
|
6718
|
+
* state.</p>
|
|
6719
|
+
* </li>
|
|
6720
|
+
* <li>
|
|
6721
|
+
* <p>
|
|
6722
|
+
* <code>PENDING</code> - Amazon FSx hasn't started creating the
|
|
6723
|
+
* volume.</p>
|
|
6724
|
+
* </li>
|
|
6725
|
+
* </ul>
|
|
4902
6726
|
*/
|
|
4903
|
-
|
|
6727
|
+
Lifecycle?: VolumeLifecycle | string;
|
|
4904
6728
|
/**
|
|
4905
|
-
* <p>
|
|
6729
|
+
* <p>The name of the volume.</p>
|
|
4906
6730
|
*/
|
|
4907
|
-
|
|
6731
|
+
Name?: string;
|
|
4908
6732
|
/**
|
|
4909
|
-
* <p>
|
|
4910
|
-
* even if the file system is deleted.</p>
|
|
6733
|
+
* <p>The configuration of an Amazon FSx for NetApp ONTAP volume.</p>
|
|
4911
6734
|
*/
|
|
4912
|
-
|
|
6735
|
+
OntapConfiguration?: OntapVolumeConfiguration;
|
|
4913
6736
|
/**
|
|
4914
|
-
* <p>The
|
|
6737
|
+
* <p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services
|
|
6738
|
+
* resources. We require an ARN when you need to specify a resource unambiguously across
|
|
6739
|
+
* all of Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in
|
|
6740
|
+
* the <i>Amazon Web Services General Reference</i>.</p>
|
|
4915
6741
|
*/
|
|
4916
|
-
|
|
6742
|
+
ResourceARN?: string;
|
|
4917
6743
|
/**
|
|
4918
|
-
* <p>
|
|
4919
|
-
* Resource Names (ARNs) for resources.</p>
|
|
6744
|
+
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
4920
6745
|
*/
|
|
4921
|
-
|
|
6746
|
+
Tags?: Tag[];
|
|
4922
6747
|
/**
|
|
4923
|
-
* <p>The ID of the
|
|
6748
|
+
* <p>The system-generated, unique ID of the volume.</p>
|
|
4924
6749
|
*/
|
|
4925
|
-
|
|
6750
|
+
VolumeId?: string;
|
|
4926
6751
|
/**
|
|
4927
|
-
* <p>The
|
|
4928
|
-
* is copied.</p>
|
|
6752
|
+
* <p>The type of the volume.</p>
|
|
4929
6753
|
*/
|
|
4930
|
-
|
|
6754
|
+
VolumeType?: VolumeType | string;
|
|
4931
6755
|
/**
|
|
4932
|
-
* <p>
|
|
6756
|
+
* <p>The reason why the volume lifecycle status changed.</p>
|
|
4933
6757
|
*/
|
|
4934
|
-
|
|
6758
|
+
LifecycleTransitionReason?: LifecycleTransitionReason;
|
|
4935
6759
|
/**
|
|
4936
|
-
* <p>
|
|
6760
|
+
* <p>A list of administrative actions for the file system that are in process or waiting to
|
|
6761
|
+
* be processed. Administrative actions describe changes to the Amazon FSx system
|
|
6762
|
+
* that you initiated.</p>
|
|
4937
6763
|
*/
|
|
4938
|
-
|
|
6764
|
+
AdministrativeActions?: AdministrativeAction[];
|
|
6765
|
+
/**
|
|
6766
|
+
* <p>The configuration of an Amazon FSx for OpenZFS volume.</p>
|
|
6767
|
+
*/
|
|
6768
|
+
OpenZFSConfiguration?: OpenZFSVolumeConfiguration;
|
|
4939
6769
|
}
|
|
4940
|
-
export declare namespace
|
|
6770
|
+
export declare namespace Volume {
|
|
4941
6771
|
/**
|
|
4942
6772
|
* @internal
|
|
4943
6773
|
*/
|
|
4944
|
-
const filterSensitiveLog: (obj:
|
|
6774
|
+
const filterSensitiveLog: (obj: Volume) => any;
|
|
4945
6775
|
}
|
|
4946
6776
|
/**
|
|
4947
6777
|
* <p>The response object for the <code>CreateFileSystemFromBackup</code>
|
|
@@ -4974,6 +6804,55 @@ export declare namespace CreateFileSystemResponse {
|
|
|
4974
6804
|
*/
|
|
4975
6805
|
const filterSensitiveLog: (obj: CreateFileSystemResponse) => any;
|
|
4976
6806
|
}
|
|
6807
|
+
export interface CreateSnapshotResponse {
|
|
6808
|
+
/**
|
|
6809
|
+
* <p>A description of the snapshot.</p>
|
|
6810
|
+
*/
|
|
6811
|
+
Snapshot?: Snapshot;
|
|
6812
|
+
}
|
|
6813
|
+
export declare namespace CreateSnapshotResponse {
|
|
6814
|
+
/**
|
|
6815
|
+
* @internal
|
|
6816
|
+
*/
|
|
6817
|
+
const filterSensitiveLog: (obj: CreateSnapshotResponse) => any;
|
|
6818
|
+
}
|
|
6819
|
+
export interface CreateVolumeFromBackupResponse {
|
|
6820
|
+
/**
|
|
6821
|
+
* <p>Returned after a successful <code>CreateVolumeFromBackup</code> API operation,
|
|
6822
|
+
* describing the volume just created.</p>
|
|
6823
|
+
*/
|
|
6824
|
+
Volume?: Volume;
|
|
6825
|
+
}
|
|
6826
|
+
export declare namespace CreateVolumeFromBackupResponse {
|
|
6827
|
+
/**
|
|
6828
|
+
* @internal
|
|
6829
|
+
*/
|
|
6830
|
+
const filterSensitiveLog: (obj: CreateVolumeFromBackupResponse) => any;
|
|
6831
|
+
}
|
|
6832
|
+
export interface CreateVolumeResponse {
|
|
6833
|
+
/**
|
|
6834
|
+
* <p>Returned after a successful <code>CreateVolume</code> API operation, describing the volume just created.</p>
|
|
6835
|
+
*/
|
|
6836
|
+
Volume?: Volume;
|
|
6837
|
+
}
|
|
6838
|
+
export declare namespace CreateVolumeResponse {
|
|
6839
|
+
/**
|
|
6840
|
+
* @internal
|
|
6841
|
+
*/
|
|
6842
|
+
const filterSensitiveLog: (obj: CreateVolumeResponse) => any;
|
|
6843
|
+
}
|
|
6844
|
+
export interface ReleaseFileSystemNfsV3LocksResponse {
|
|
6845
|
+
/**
|
|
6846
|
+
* <p>A description of a specific Amazon FSx file system.</p>
|
|
6847
|
+
*/
|
|
6848
|
+
FileSystem?: FileSystem;
|
|
6849
|
+
}
|
|
6850
|
+
export declare namespace ReleaseFileSystemNfsV3LocksResponse {
|
|
6851
|
+
/**
|
|
6852
|
+
* @internal
|
|
6853
|
+
*/
|
|
6854
|
+
const filterSensitiveLog: (obj: ReleaseFileSystemNfsV3LocksResponse) => any;
|
|
6855
|
+
}
|
|
4977
6856
|
/**
|
|
4978
6857
|
* <p>The response object for the <code>UpdateFileSystem</code> operation.</p>
|
|
4979
6858
|
*/
|
|
@@ -4989,33 +6868,31 @@ export declare namespace UpdateFileSystemResponse {
|
|
|
4989
6868
|
*/
|
|
4990
6869
|
const filterSensitiveLog: (obj: UpdateFileSystemResponse) => any;
|
|
4991
6870
|
}
|
|
4992
|
-
export interface
|
|
6871
|
+
export interface UpdateSnapshotResponse {
|
|
4993
6872
|
/**
|
|
4994
|
-
* <p>
|
|
4995
|
-
*
|
|
6873
|
+
* <p>Returned after a successful <code>UpdateSnapshot</code> operation, describing the
|
|
6874
|
+
* snapshot that you updated.</p>
|
|
4996
6875
|
*/
|
|
4997
|
-
|
|
6876
|
+
Snapshot?: Snapshot;
|
|
4998
6877
|
}
|
|
4999
|
-
export declare namespace
|
|
6878
|
+
export declare namespace UpdateSnapshotResponse {
|
|
5000
6879
|
/**
|
|
5001
6880
|
* @internal
|
|
5002
6881
|
*/
|
|
5003
|
-
const filterSensitiveLog: (obj:
|
|
6882
|
+
const filterSensitiveLog: (obj: UpdateSnapshotResponse) => any;
|
|
5004
6883
|
}
|
|
5005
|
-
|
|
5006
|
-
* <p>The response object for the <code>CreateBackup</code> operation.</p>
|
|
5007
|
-
*/
|
|
5008
|
-
export interface CreateBackupResponse {
|
|
6884
|
+
export interface UpdateVolumeResponse {
|
|
5009
6885
|
/**
|
|
5010
|
-
* <p>A description of the
|
|
6886
|
+
* <p>A description of the volume just updated. Returned after a successful
|
|
6887
|
+
* <code>UpdateVolume</code> API operation.</p>
|
|
5011
6888
|
*/
|
|
5012
|
-
|
|
6889
|
+
Volume?: Volume;
|
|
5013
6890
|
}
|
|
5014
|
-
export declare namespace
|
|
6891
|
+
export declare namespace UpdateVolumeResponse {
|
|
5015
6892
|
/**
|
|
5016
6893
|
* @internal
|
|
5017
6894
|
*/
|
|
5018
|
-
const filterSensitiveLog: (obj:
|
|
6895
|
+
const filterSensitiveLog: (obj: UpdateVolumeResponse) => any;
|
|
5019
6896
|
}
|
|
5020
6897
|
/**
|
|
5021
6898
|
* <p>The response object for <code>DescribeFileSystems</code> operation.</p>
|
|
@@ -5038,8 +6915,187 @@ export declare namespace DescribeFileSystemsResponse {
|
|
|
5038
6915
|
*/
|
|
5039
6916
|
const filterSensitiveLog: (obj: DescribeFileSystemsResponse) => any;
|
|
5040
6917
|
}
|
|
6918
|
+
export interface DescribeSnapshotsResponse {
|
|
6919
|
+
/**
|
|
6920
|
+
* <p>An array of snapshots.</p>
|
|
6921
|
+
*/
|
|
6922
|
+
Snapshots?: Snapshot[];
|
|
6923
|
+
/**
|
|
6924
|
+
* <p>(Optional) Opaque pagination token returned from a previous operation (String). If
|
|
6925
|
+
* present, this token indicates from what point you can continue processing the request, where
|
|
6926
|
+
* the previous <code>NextToken</code> value left off.</p>
|
|
6927
|
+
*/
|
|
6928
|
+
NextToken?: string;
|
|
6929
|
+
}
|
|
6930
|
+
export declare namespace DescribeSnapshotsResponse {
|
|
6931
|
+
/**
|
|
6932
|
+
* @internal
|
|
6933
|
+
*/
|
|
6934
|
+
const filterSensitiveLog: (obj: DescribeSnapshotsResponse) => any;
|
|
6935
|
+
}
|
|
6936
|
+
export interface DescribeVolumesResponse {
|
|
6937
|
+
/**
|
|
6938
|
+
* <p>Returned after a successful <code>DescribeVolumes</code> operation, describing each volume.</p>
|
|
6939
|
+
*/
|
|
6940
|
+
Volumes?: Volume[];
|
|
6941
|
+
/**
|
|
6942
|
+
* <p>(Optional) Opaque pagination token returned from a previous operation (String). If
|
|
6943
|
+
* present, this token indicates from what point you can continue processing the request, where
|
|
6944
|
+
* the previous <code>NextToken</code> value left off.</p>
|
|
6945
|
+
*/
|
|
6946
|
+
NextToken?: string;
|
|
6947
|
+
}
|
|
6948
|
+
export declare namespace DescribeVolumesResponse {
|
|
6949
|
+
/**
|
|
6950
|
+
* @internal
|
|
6951
|
+
*/
|
|
6952
|
+
const filterSensitiveLog: (obj: DescribeVolumesResponse) => any;
|
|
6953
|
+
}
|
|
6954
|
+
/**
|
|
6955
|
+
* <p>A backup of an Amazon FSx for Windows File Server, Amazon FSx for
|
|
6956
|
+
* Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx
|
|
6957
|
+
* for OpenZFS file system.</p>
|
|
6958
|
+
*/
|
|
6959
|
+
export interface Backup {
|
|
6960
|
+
/**
|
|
6961
|
+
* <p>The ID of the backup.</p>
|
|
6962
|
+
*/
|
|
6963
|
+
BackupId: string | undefined;
|
|
6964
|
+
/**
|
|
6965
|
+
* <p>The lifecycle status of the backup.</p>
|
|
6966
|
+
* <ul>
|
|
6967
|
+
* <li>
|
|
6968
|
+
* <p>
|
|
6969
|
+
* <code>AVAILABLE</code> - The backup is fully available.</p>
|
|
6970
|
+
* </li>
|
|
6971
|
+
* <li>
|
|
6972
|
+
* <p>
|
|
6973
|
+
* <code>PENDING</code> - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.</p>
|
|
6974
|
+
* </li>
|
|
6975
|
+
* <li>
|
|
6976
|
+
* <p>
|
|
6977
|
+
* <code>CREATING</code> - Amazon FSx is creating the backup.</p>
|
|
6978
|
+
* </li>
|
|
6979
|
+
* <li>
|
|
6980
|
+
* <p>
|
|
6981
|
+
* <code>TRANSFERRING</code> - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.</p>
|
|
6982
|
+
* </li>
|
|
6983
|
+
* <li>
|
|
6984
|
+
* <p>
|
|
6985
|
+
* <code>COPYING</code> - Amazon FSx is copying the backup.</p>
|
|
6986
|
+
* </li>
|
|
6987
|
+
* <li>
|
|
6988
|
+
* <p>
|
|
6989
|
+
* <code>DELETED</code> - Amazon FSx deleted the backup and it's no longer
|
|
6990
|
+
* available.</p>
|
|
6991
|
+
* </li>
|
|
6992
|
+
* <li>
|
|
6993
|
+
* <p>
|
|
6994
|
+
* <code>FAILED</code> - Amazon FSx couldn't finish the backup.</p>
|
|
6995
|
+
* </li>
|
|
6996
|
+
* </ul>
|
|
6997
|
+
*/
|
|
6998
|
+
Lifecycle: BackupLifecycle | string | undefined;
|
|
6999
|
+
/**
|
|
7000
|
+
* <p>Details explaining any failures that occurred when creating a backup.</p>
|
|
7001
|
+
*/
|
|
7002
|
+
FailureDetails?: BackupFailureDetails;
|
|
7003
|
+
/**
|
|
7004
|
+
* <p>The type of the file-system backup.</p>
|
|
7005
|
+
*/
|
|
7006
|
+
Type: BackupType | string | undefined;
|
|
7007
|
+
/**
|
|
7008
|
+
* <p>The current percent of progress of an asynchronous task.</p>
|
|
7009
|
+
*/
|
|
7010
|
+
ProgressPercent?: number;
|
|
7011
|
+
/**
|
|
7012
|
+
* <p>The time when a particular backup was created.</p>
|
|
7013
|
+
*/
|
|
7014
|
+
CreationTime: Date | undefined;
|
|
7015
|
+
/**
|
|
7016
|
+
* <p>The ID of the Key Management Service (KMS) key used to encrypt the
|
|
7017
|
+
* backup of the Amazon FSx file system's data at rest. </p>
|
|
7018
|
+
*/
|
|
7019
|
+
KmsKeyId?: string;
|
|
7020
|
+
/**
|
|
7021
|
+
* <p>The Amazon Resource Name (ARN) for the backup resource.</p>
|
|
7022
|
+
*/
|
|
7023
|
+
ResourceARN?: string;
|
|
7024
|
+
/**
|
|
7025
|
+
* <p>The tags associated with a particular file system.</p>
|
|
7026
|
+
*/
|
|
7027
|
+
Tags?: Tag[];
|
|
7028
|
+
/**
|
|
7029
|
+
* <p>The metadata of the file system associated with the backup. This metadata is persisted
|
|
7030
|
+
* even if the file system is deleted.</p>
|
|
7031
|
+
*/
|
|
7032
|
+
FileSystem: FileSystem | undefined;
|
|
7033
|
+
/**
|
|
7034
|
+
* <p>The configuration of the self-managed Microsoft Active Directory directory to which
|
|
7035
|
+
* the Windows File Server instance is joined.</p>
|
|
7036
|
+
*/
|
|
7037
|
+
DirectoryInformation?: ActiveDirectoryBackupAttributes;
|
|
7038
|
+
/**
|
|
7039
|
+
* <p>An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon
|
|
7040
|
+
* Resource Names (ARNs) for resources.</p>
|
|
7041
|
+
*/
|
|
7042
|
+
OwnerId?: string;
|
|
7043
|
+
/**
|
|
7044
|
+
* <p>The ID of the source backup. Specifies the backup that you are copying.</p>
|
|
7045
|
+
*/
|
|
7046
|
+
SourceBackupId?: string;
|
|
7047
|
+
/**
|
|
7048
|
+
* <p>The source Region of the backup. Specifies the Region from where this backup
|
|
7049
|
+
* is copied.</p>
|
|
7050
|
+
*/
|
|
7051
|
+
SourceBackupRegion?: string;
|
|
7052
|
+
/**
|
|
7053
|
+
* <p>Specifies the resource type that's backed up.</p>
|
|
7054
|
+
*/
|
|
7055
|
+
ResourceType?: ResourceType | string;
|
|
7056
|
+
/**
|
|
7057
|
+
* <p>Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS
|
|
7058
|
+
* volume.</p>
|
|
7059
|
+
*/
|
|
7060
|
+
Volume?: Volume;
|
|
7061
|
+
}
|
|
7062
|
+
export declare namespace Backup {
|
|
7063
|
+
/**
|
|
7064
|
+
* @internal
|
|
7065
|
+
*/
|
|
7066
|
+
const filterSensitiveLog: (obj: Backup) => any;
|
|
7067
|
+
}
|
|
7068
|
+
export interface CopyBackupResponse {
|
|
7069
|
+
/**
|
|
7070
|
+
* <p>A backup of an Amazon FSx for Windows File Server, Amazon FSx for
|
|
7071
|
+
* Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx
|
|
7072
|
+
* for OpenZFS file system.</p>
|
|
7073
|
+
*/
|
|
7074
|
+
Backup?: Backup;
|
|
7075
|
+
}
|
|
7076
|
+
export declare namespace CopyBackupResponse {
|
|
7077
|
+
/**
|
|
7078
|
+
* @internal
|
|
7079
|
+
*/
|
|
7080
|
+
const filterSensitiveLog: (obj: CopyBackupResponse) => any;
|
|
7081
|
+
}
|
|
7082
|
+
/**
|
|
7083
|
+
* <p>The response object for the <code>CreateBackup</code> operation.</p>
|
|
7084
|
+
*/
|
|
7085
|
+
export interface CreateBackupResponse {
|
|
7086
|
+
/**
|
|
7087
|
+
* <p>A description of the backup.</p>
|
|
7088
|
+
*/
|
|
7089
|
+
Backup?: Backup;
|
|
7090
|
+
}
|
|
7091
|
+
export declare namespace CreateBackupResponse {
|
|
7092
|
+
/**
|
|
7093
|
+
* @internal
|
|
7094
|
+
*/
|
|
7095
|
+
const filterSensitiveLog: (obj: CreateBackupResponse) => any;
|
|
7096
|
+
}
|
|
5041
7097
|
/**
|
|
5042
|
-
* <p>Response object for <code>DescribeBackups</code> operation.</p>
|
|
7098
|
+
* <p>Response object for the <code>DescribeBackups</code> operation.</p>
|
|
5043
7099
|
*/
|
|
5044
7100
|
export interface DescribeBackupsResponse {
|
|
5045
7101
|
/**
|
|
@@ -5047,9 +7103,9 @@ export interface DescribeBackupsResponse {
|
|
|
5047
7103
|
*/
|
|
5048
7104
|
Backups?: Backup[];
|
|
5049
7105
|
/**
|
|
5050
|
-
* <p>
|
|
5051
|
-
* You can use the <code>NextToken</code> value in the
|
|
5052
|
-
*
|
|
7106
|
+
* <p>A <code>NextToken</code> value is present if there are more backups than returned in
|
|
7107
|
+
* the response. You can use the <code>NextToken</code> value in the subsequent request to
|
|
7108
|
+
* fetch the backups. </p>
|
|
5053
7109
|
*/
|
|
5054
7110
|
NextToken?: string;
|
|
5055
7111
|
}
|