@aws-sdk/client-fsx 3.53.0 → 3.54.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 +11 -0
- package/dist-cjs/models/models_0.js +15 -10
- package/dist-cjs/protocols/Aws_json1_1.js +21 -0
- package/dist-es/models/models_0.js +9 -4
- package/dist-es/protocols/Aws_json1_1.js +25 -8
- package/dist-types/FSx.d.ts +9 -10
- package/dist-types/FSxClient.d.ts +2 -2
- package/dist-types/commands/CreateFileSystemFromBackupCommand.d.ts +2 -2
- package/dist-types/commands/CreateSnapshotCommand.d.ts +3 -3
- package/dist-types/commands/CreateVolumeCommand.d.ts +1 -2
- package/dist-types/commands/DeleteSnapshotCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSnapshotsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSnapshotCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +193 -81
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/FSxClient.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +25 -9
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +27 -27
|
@@ -549,6 +549,12 @@ export interface OntapFileSystemConfiguration {
|
|
|
549
549
|
/**
|
|
550
550
|
* <p>The IP address range in which the endpoints to access your file system
|
|
551
551
|
* are created.</p>
|
|
552
|
+
* <important>
|
|
553
|
+
* <p>The Endpoint IP address range you select for your file system
|
|
554
|
+
* must exist outside the VPC's CIDR range and must be at least /30 or larger.
|
|
555
|
+
* If you do not specify this optional parameter, Amazon FSx will automatically
|
|
556
|
+
* select a CIDR block for you.</p>
|
|
557
|
+
* </important>
|
|
552
558
|
*/
|
|
553
559
|
EndpointIpAddressRange?: string;
|
|
554
560
|
/**
|
|
@@ -643,7 +649,7 @@ export interface OpenZFSFileSystemConfiguration {
|
|
|
643
649
|
DeploymentType?: OpenZFSDeploymentType | string;
|
|
644
650
|
/**
|
|
645
651
|
* <p>The throughput of an Amazon FSx file system, measured in megabytes per second
|
|
646
|
-
* (MBps)
|
|
652
|
+
* (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.</p>
|
|
647
653
|
*/
|
|
648
654
|
ThroughputCapacity?: number;
|
|
649
655
|
/**
|
|
@@ -1019,15 +1025,6 @@ export declare enum SnapshotLifecycle {
|
|
|
1019
1025
|
DELETING = "DELETING",
|
|
1020
1026
|
PENDING = "PENDING"
|
|
1021
1027
|
}
|
|
1022
|
-
export declare enum VolumeLifecycle {
|
|
1023
|
-
AVAILABLE = "AVAILABLE",
|
|
1024
|
-
CREATED = "CREATED",
|
|
1025
|
-
CREATING = "CREATING",
|
|
1026
|
-
DELETING = "DELETING",
|
|
1027
|
-
FAILED = "FAILED",
|
|
1028
|
-
MISCONFIGURED = "MISCONFIGURED",
|
|
1029
|
-
PENDING = "PENDING"
|
|
1030
|
-
}
|
|
1031
1028
|
/**
|
|
1032
1029
|
* <p>Describes why a resource lifecycle state changed.</p>
|
|
1033
1030
|
*/
|
|
@@ -1043,6 +1040,15 @@ export declare namespace LifecycleTransitionReason {
|
|
|
1043
1040
|
*/
|
|
1044
1041
|
const filterSensitiveLog: (obj: LifecycleTransitionReason) => any;
|
|
1045
1042
|
}
|
|
1043
|
+
export declare enum VolumeLifecycle {
|
|
1044
|
+
AVAILABLE = "AVAILABLE",
|
|
1045
|
+
CREATED = "CREATED",
|
|
1046
|
+
CREATING = "CREATING",
|
|
1047
|
+
DELETING = "DELETING",
|
|
1048
|
+
FAILED = "FAILED",
|
|
1049
|
+
MISCONFIGURED = "MISCONFIGURED",
|
|
1050
|
+
PENDING = "PENDING"
|
|
1051
|
+
}
|
|
1046
1052
|
export declare enum FlexCacheEndpointType {
|
|
1047
1053
|
CACHE = "CACHE",
|
|
1048
1054
|
NONE = "NONE",
|
|
@@ -1233,6 +1239,7 @@ export declare namespace OntapVolumeConfiguration {
|
|
|
1233
1239
|
const filterSensitiveLog: (obj: OntapVolumeConfiguration) => any;
|
|
1234
1240
|
}
|
|
1235
1241
|
export declare enum OpenZFSDataCompressionType {
|
|
1242
|
+
LZ4 = "LZ4",
|
|
1236
1243
|
NONE = "NONE",
|
|
1237
1244
|
ZSTD = "ZSTD"
|
|
1238
1245
|
}
|
|
@@ -1244,7 +1251,7 @@ export interface OpenZFSClientConfiguration {
|
|
|
1244
1251
|
/**
|
|
1245
1252
|
* <p>A value that specifies who can mount the file system. You can provide a wildcard
|
|
1246
1253
|
* character (<code>*</code>), an IP address (<code>0.0.0.0</code>), or a CIDR address
|
|
1247
|
-
* (<code>192.0.2.0/24</code
|
|
1254
|
+
* (<code>192.0.2.0/24</code>). By default, Amazon FSx uses the wildcard
|
|
1248
1255
|
* character when specifying the client. </p>
|
|
1249
1256
|
*/
|
|
1250
1257
|
Clients: string | undefined;
|
|
@@ -1255,8 +1262,8 @@ export interface OpenZFSClientConfiguration {
|
|
|
1255
1262
|
* <ul>
|
|
1256
1263
|
* <li>
|
|
1257
1264
|
* <p>
|
|
1258
|
-
* <code>
|
|
1259
|
-
*
|
|
1265
|
+
* <code>crossmnt</code> is used by default. If you don't specify
|
|
1266
|
+
* <code>crossmnt</code> when changing the client configuration, you won't be
|
|
1260
1267
|
* able to see or access snapshots in your file system's snapshot directory.</p>
|
|
1261
1268
|
* </li>
|
|
1262
1269
|
* <li>
|
|
@@ -1277,7 +1284,7 @@ export declare namespace OpenZFSClientConfiguration {
|
|
|
1277
1284
|
const filterSensitiveLog: (obj: OpenZFSClientConfiguration) => any;
|
|
1278
1285
|
}
|
|
1279
1286
|
/**
|
|
1280
|
-
* <p>The Network File System NFS) configurations for mounting an Amazon FSx for
|
|
1287
|
+
* <p>The Network File System (NFS) configurations for mounting an Amazon FSx for
|
|
1281
1288
|
* OpenZFS file system. </p>
|
|
1282
1289
|
*/
|
|
1283
1290
|
export interface OpenZFSNfsExport {
|
|
@@ -1385,19 +1392,33 @@ export interface OpenZFSVolumeConfiguration {
|
|
|
1385
1392
|
*/
|
|
1386
1393
|
StorageCapacityQuotaGiB?: number;
|
|
1387
1394
|
/**
|
|
1388
|
-
* <p>The
|
|
1389
|
-
*
|
|
1390
|
-
*
|
|
1395
|
+
* <p>The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8,
|
|
1396
|
+
* 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
|
|
1397
|
+
* Most workloads should use the default record size. For guidance on when
|
|
1398
|
+
* to set a custom record size, see the
|
|
1399
|
+
* <i>Amazon FSx for OpenZFS User Guide</i>.</p>
|
|
1400
|
+
*/
|
|
1401
|
+
RecordSizeKiB?: number;
|
|
1402
|
+
/**
|
|
1403
|
+
* <p>Specifies the method used to compress the data on the volume. The compression
|
|
1404
|
+
* type is <code>NONE</code> by default.</p>
|
|
1391
1405
|
* <ul>
|
|
1392
1406
|
* <li>
|
|
1393
1407
|
* <p>
|
|
1394
|
-
* <code>NONE</code> - Doesn't compress the data on the volume
|
|
1408
|
+
* <code>NONE</code> - Doesn't compress the data on the volume.
|
|
1409
|
+
* <code>NONE</code> is the default.</p>
|
|
1395
1410
|
* </li>
|
|
1396
1411
|
* <li>
|
|
1397
1412
|
* <p>
|
|
1398
1413
|
* <code>ZSTD</code> - Compresses the data in the volume using the Zstandard
|
|
1399
|
-
* (ZSTD) compression algorithm.
|
|
1400
|
-
*
|
|
1414
|
+
* (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better
|
|
1415
|
+
* compression ratio to minimize on-disk storage utilization.</p>
|
|
1416
|
+
* </li>
|
|
1417
|
+
* <li>
|
|
1418
|
+
* <p>
|
|
1419
|
+
* <code>LZ4</code> - Compresses the data in the volume using the LZ4
|
|
1420
|
+
* compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive
|
|
1421
|
+
* and delivers higher write throughput speeds.</p>
|
|
1401
1422
|
* </li>
|
|
1402
1423
|
* </ul>
|
|
1403
1424
|
*/
|
|
@@ -1408,7 +1429,7 @@ export interface OpenZFSVolumeConfiguration {
|
|
|
1408
1429
|
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
1409
1430
|
* value is <code>true</code> and you specify one or more tags, only the specified tags are
|
|
1410
1431
|
* copied to snapshots. If you specify one or more tags when creating the snapshot, no tags
|
|
1411
|
-
* are copied from the volume, regardless of this value
|
|
1432
|
+
* are copied from the volume, regardless of this value.</p>
|
|
1412
1433
|
*/
|
|
1413
1434
|
CopyTagsToSnapshots?: boolean;
|
|
1414
1435
|
/**
|
|
@@ -1421,12 +1442,12 @@ export interface OpenZFSVolumeConfiguration {
|
|
|
1421
1442
|
*/
|
|
1422
1443
|
ReadOnly?: boolean;
|
|
1423
1444
|
/**
|
|
1424
|
-
* <p>The configuration object for mounting a Network File System (NFS)
|
|
1425
|
-
* system.</p>
|
|
1445
|
+
* <p>The configuration object for mounting a Network File System (NFS)
|
|
1446
|
+
* file system.</p>
|
|
1426
1447
|
*/
|
|
1427
1448
|
NfsExports?: OpenZFSNfsExport[];
|
|
1428
1449
|
/**
|
|
1429
|
-
* <p>An object specifying how much storage users or groups can use on the volume
|
|
1450
|
+
* <p>An object specifying how much storage users or groups can use on the volume.</p>
|
|
1430
1451
|
*/
|
|
1431
1452
|
UserAndGroupQuotas?: OpenZFSUserOrGroupQuota[];
|
|
1432
1453
|
}
|
|
@@ -2030,7 +2051,7 @@ export declare namespace CreateBackupRequest {
|
|
|
2030
2051
|
const filterSensitiveLog: (obj: CreateBackupRequest) => any;
|
|
2031
2052
|
}
|
|
2032
2053
|
/**
|
|
2033
|
-
* <p>No Amazon FSx
|
|
2054
|
+
* <p>No Amazon FSx volumes were found based upon the supplied parameters.</p>
|
|
2034
2055
|
*/
|
|
2035
2056
|
export declare class VolumeNotFound extends __BaseException {
|
|
2036
2057
|
readonly name: "VolumeNotFound";
|
|
@@ -2092,6 +2113,11 @@ export interface CreateDataRepositoryAssociationRequest {
|
|
|
2092
2113
|
* <p>This path specifies where in your file system files will be exported
|
|
2093
2114
|
* from or imported to. This file system directory can be linked to only one
|
|
2094
2115
|
* Amazon S3 bucket, and no other S3 bucket can be linked to the directory.</p>
|
|
2116
|
+
* <note>
|
|
2117
|
+
* <p>If you specify only a forward slash (<code>/</code>) as the file system
|
|
2118
|
+
* path, you can link only 1 data repository to the file system. You can only specify
|
|
2119
|
+
* "/" as the file system path for the first data repository associated with a file system.</p>
|
|
2120
|
+
* </note>
|
|
2095
2121
|
*/
|
|
2096
2122
|
FileSystemPath: string | undefined;
|
|
2097
2123
|
/**
|
|
@@ -2239,7 +2265,12 @@ export interface DataRepositoryAssociation {
|
|
|
2239
2265
|
* path <code>/ns1/ns2</code>.</p>
|
|
2240
2266
|
* <p>This path specifies where in your file system files will be exported
|
|
2241
2267
|
* from or imported to. This file system directory can be linked to only one
|
|
2242
|
-
* Amazon S3 bucket, and no other S3 bucket can be linked to the directory
|
|
2268
|
+
* Amazon S3 bucket, and no other S3 bucket can be linked to the directory.</p>
|
|
2269
|
+
* <note>
|
|
2270
|
+
* <p>If you specify only a forward slash (<code>/</code>) as the file system
|
|
2271
|
+
* path, you can link only 1 data repository to the file system. You can only specify
|
|
2272
|
+
* "/" as the file system path for the first data repository associated with a file system.</p>
|
|
2273
|
+
* </note>
|
|
2243
2274
|
*/
|
|
2244
2275
|
FileSystemPath?: string;
|
|
2245
2276
|
/**
|
|
@@ -2814,11 +2845,11 @@ export interface CreateFileSystemLustreConfiguration {
|
|
|
2814
2845
|
* in the S3 bucket.</p>
|
|
2815
2846
|
* </li>
|
|
2816
2847
|
* </ul>
|
|
2817
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/
|
|
2848
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3">
|
|
2818
2849
|
* Automatically import updates from your S3 bucket</a>.</p>
|
|
2819
2850
|
* <note>
|
|
2820
2851
|
* <p>This parameter is not supported for file systems with the <code>Persistent_2</code> deployment type.
|
|
2821
|
-
* Instead, use <code>CreateDataRepositoryAssociation
|
|
2852
|
+
* Instead, use <code>CreateDataRepositoryAssociation</code> to create
|
|
2822
2853
|
* a data repository association to link your Lustre file system to a data repository.</p>
|
|
2823
2854
|
* </note>
|
|
2824
2855
|
*/
|
|
@@ -2937,6 +2968,10 @@ export interface CreateFileSystemOntapConfiguration {
|
|
|
2937
2968
|
* <p>Specifies the IP address range in which the endpoints to access your file system
|
|
2938
2969
|
* will be created. By default, Amazon FSx selects an unused IP address range for you
|
|
2939
2970
|
* from the 198.19.* range.</p>
|
|
2971
|
+
* <important>
|
|
2972
|
+
* <p>The Endpoint IP address range you select for your file system
|
|
2973
|
+
* must exist outside the VPC's CIDR range and must be at least /30 or larger.</p>
|
|
2974
|
+
* </important>
|
|
2940
2975
|
*/
|
|
2941
2976
|
EndpointIpAddressRange?: string;
|
|
2942
2977
|
/**
|
|
@@ -2988,19 +3023,35 @@ export declare namespace CreateFileSystemOntapConfiguration {
|
|
|
2988
3023
|
*/
|
|
2989
3024
|
export interface OpenZFSCreateRootVolumeConfiguration {
|
|
2990
3025
|
/**
|
|
2991
|
-
* <p>Specifies the
|
|
2992
|
-
*
|
|
2993
|
-
*
|
|
3026
|
+
* <p>Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8,
|
|
3027
|
+
* 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the
|
|
3028
|
+
* default record size. Database workflows can benefit from a smaller record size, while streaming
|
|
3029
|
+
* workflows can benefit from a larger record size. For additional guidance on setting a custom record
|
|
3030
|
+
* size, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs">
|
|
3031
|
+
* Tips for maximizing performance</a> in the
|
|
3032
|
+
* <i>Amazon FSx for OpenZFS User Guide</i>.</p>
|
|
3033
|
+
*/
|
|
3034
|
+
RecordSizeKiB?: number;
|
|
3035
|
+
/**
|
|
3036
|
+
* <p>Specifies the method used to compress the data on the volume. The compression
|
|
3037
|
+
* type is <code>NONE</code> by default.</p>
|
|
2994
3038
|
* <ul>
|
|
2995
3039
|
* <li>
|
|
2996
3040
|
* <p>
|
|
2997
|
-
* <code>NONE</code> - Doesn't compress the data on the volume
|
|
3041
|
+
* <code>NONE</code> - Doesn't compress the data on the volume.
|
|
3042
|
+
* <code>NONE</code> is the default.</p>
|
|
2998
3043
|
* </li>
|
|
2999
3044
|
* <li>
|
|
3000
3045
|
* <p>
|
|
3001
|
-
* <code>ZSTD</code> - Compresses the data in the volume using the
|
|
3002
|
-
* (ZSTD) compression algorithm.
|
|
3003
|
-
*
|
|
3046
|
+
* <code>ZSTD</code> - Compresses the data in the volume using the Zstandard
|
|
3047
|
+
* (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better
|
|
3048
|
+
* compression ratio to minimize on-disk storage utilization.</p>
|
|
3049
|
+
* </li>
|
|
3050
|
+
* <li>
|
|
3051
|
+
* <p>
|
|
3052
|
+
* <code>LZ4</code> - Compresses the data in the volume using the LZ4
|
|
3053
|
+
* compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive
|
|
3054
|
+
* and delivers higher write throughput speeds.</p>
|
|
3004
3055
|
* </li>
|
|
3005
3056
|
* </ul>
|
|
3006
3057
|
*/
|
|
@@ -3014,9 +3065,9 @@ export interface OpenZFSCreateRootVolumeConfiguration {
|
|
|
3014
3065
|
*/
|
|
3015
3066
|
UserAndGroupQuotas?: OpenZFSUserOrGroupQuota[];
|
|
3016
3067
|
/**
|
|
3017
|
-
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots
|
|
3018
|
-
* This value defaults to <code>false</code>. If it's set to <code>true</code>,
|
|
3019
|
-
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
3068
|
+
* <p>A Boolean value indicating whether tags for the volume should be copied to snapshots
|
|
3069
|
+
* of the volume. This value defaults to <code>false</code>. If it's set to <code>true</code>,
|
|
3070
|
+
* all tags for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
3020
3071
|
* value is <code>true</code> and you specify one or more tags, only the specified tags are
|
|
3021
3072
|
* copied to snapshots. If you specify one or more tags when creating the snapshot, no tags
|
|
3022
3073
|
* are copied from the volume, regardless of this value. </p>
|
|
@@ -3036,7 +3087,7 @@ export declare namespace OpenZFSCreateRootVolumeConfiguration {
|
|
|
3036
3087
|
const filterSensitiveLog: (obj: OpenZFSCreateRootVolumeConfiguration) => any;
|
|
3037
3088
|
}
|
|
3038
3089
|
/**
|
|
3039
|
-
* <p>The OpenZFS configuration properties for the file system that you are creating.</p>
|
|
3090
|
+
* <p>The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.</p>
|
|
3040
3091
|
*/
|
|
3041
3092
|
export interface CreateFileSystemOpenZFSConfiguration {
|
|
3042
3093
|
/**
|
|
@@ -3072,8 +3123,8 @@ export interface CreateFileSystemOpenZFSConfiguration {
|
|
|
3072
3123
|
DailyAutomaticBackupStartTime?: string;
|
|
3073
3124
|
/**
|
|
3074
3125
|
* <p>Specifies the file system deployment type. Amazon FSx for OpenZFS supports
|
|
3075
|
-
*
|
|
3076
|
-
* single Availability Zone
|
|
3126
|
+
* <code>SINGLE_AZ_1</code>. <code>SINGLE_AZ_1</code> deployment type is configured for redundancy
|
|
3127
|
+
* within a single Availability Zone.</p>
|
|
3077
3128
|
*/
|
|
3078
3129
|
DeploymentType: OpenZFSDeploymentType | string | undefined;
|
|
3079
3130
|
/**
|
|
@@ -4226,39 +4277,73 @@ export declare namespace CreateOpenZFSOriginSnapshotConfiguration {
|
|
|
4226
4277
|
const filterSensitiveLog: (obj: CreateOpenZFSOriginSnapshotConfiguration) => any;
|
|
4227
4278
|
}
|
|
4228
4279
|
/**
|
|
4229
|
-
* <p>Specifies the configuration of the OpenZFS volume that you are creating.</p>
|
|
4280
|
+
* <p>Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.</p>
|
|
4230
4281
|
*/
|
|
4231
4282
|
export interface CreateOpenZFSVolumeConfiguration {
|
|
4232
4283
|
/**
|
|
4233
|
-
* <p>The ID of the volume to use as the parent volume
|
|
4284
|
+
* <p>The ID of the volume to use as the parent volume of the volume that you are creating.</p>
|
|
4234
4285
|
*/
|
|
4235
4286
|
ParentVolumeId: string | undefined;
|
|
4236
4287
|
/**
|
|
4237
|
-
* <p>
|
|
4238
|
-
*
|
|
4288
|
+
* <p>Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting
|
|
4289
|
+
* <code>StorageCapacityReservationGiB</code> guarantees that the specified amount of storage space
|
|
4290
|
+
* on the parent volume will always be available for the volume.
|
|
4291
|
+
* You can't reserve more storage than the parent volume has. To <i>not</i> specify a storage capacity
|
|
4292
|
+
* reservation, set this to <code>0</code> or <code>-1</code>. For more information, see
|
|
4293
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties">Volume properties</a>
|
|
4294
|
+
* in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>
|
|
4239
4295
|
*/
|
|
4240
4296
|
StorageCapacityReservationGiB?: number;
|
|
4241
4297
|
/**
|
|
4242
|
-
* <p>
|
|
4243
|
-
*
|
|
4298
|
+
* <p>Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify
|
|
4299
|
+
* a quota that is larger than the storage on the parent volume. A volume quota limits
|
|
4300
|
+
* the amount of storage that the volume can consume to the configured amount, but does not
|
|
4301
|
+
* guarantee the space will be available on the parent volume. To guarantee quota space, you must also set
|
|
4302
|
+
* <code>StorageCapacityReservationGiB</code>. To <i>not</i> specify a storage capacity quota, set this to <code>-1</code>.
|
|
4303
|
+
* </p>
|
|
4304
|
+
* <p>For more information, see
|
|
4305
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties">Volume properties</a>
|
|
4306
|
+
* in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>
|
|
4244
4307
|
*/
|
|
4245
4308
|
StorageCapacityQuotaGiB?: number;
|
|
4246
4309
|
/**
|
|
4247
|
-
* <p>Specifies the
|
|
4248
|
-
*
|
|
4249
|
-
*
|
|
4310
|
+
* <p>Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8,
|
|
4311
|
+
* 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
|
|
4312
|
+
* We recommend using the default setting for the majority of use cases.
|
|
4313
|
+
* Generally, workloads that write in fixed small or large record sizes
|
|
4314
|
+
* may benefit from setting a custom record size, like database workloads
|
|
4315
|
+
* (small record size) or media streaming workloads (large record size).
|
|
4316
|
+
* For additional guidance on when
|
|
4317
|
+
* to set a custom record size, see
|
|
4318
|
+
* <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance">
|
|
4319
|
+
* ZFS Record size</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>
|
|
4320
|
+
*/
|
|
4321
|
+
RecordSizeKiB?: number;
|
|
4322
|
+
/**
|
|
4323
|
+
* <p>Specifies the method used to compress the data on the volume. The compression
|
|
4324
|
+
* type is <code>NONE</code> by default.</p>
|
|
4250
4325
|
* <ul>
|
|
4251
4326
|
* <li>
|
|
4252
4327
|
* <p>
|
|
4253
|
-
* <code>NONE</code> - Doesn't compress the data on the volume
|
|
4328
|
+
* <code>NONE</code> - Doesn't compress the data on the volume.
|
|
4329
|
+
* <code>NONE</code> is the default.</p>
|
|
4254
4330
|
* </li>
|
|
4255
4331
|
* <li>
|
|
4256
4332
|
* <p>
|
|
4257
4333
|
* <code>ZSTD</code> - Compresses the data in the volume using the Zstandard
|
|
4258
|
-
* (ZSTD) compression algorithm.
|
|
4259
|
-
*
|
|
4334
|
+
* (ZSTD) compression algorithm. ZSTD compression provides a higher level of
|
|
4335
|
+
* data compression and higher read throughput performance than LZ4 compression.</p>
|
|
4336
|
+
* </li>
|
|
4337
|
+
* <li>
|
|
4338
|
+
* <p>
|
|
4339
|
+
* <code>LZ4</code> - Compresses the data in the volume using the LZ4
|
|
4340
|
+
* compression algorithm. LZ4 compression provides a lower level of compression
|
|
4341
|
+
* and higher write throughput performance than ZSTD compression.</p>
|
|
4260
4342
|
* </li>
|
|
4261
4343
|
* </ul>
|
|
4344
|
+
* <p>For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system,
|
|
4345
|
+
* see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs">
|
|
4346
|
+
* Tips for maximizing performance</a> File system and volume settings in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>
|
|
4262
4347
|
*/
|
|
4263
4348
|
DataCompressionType?: OpenZFSDataCompressionType | string;
|
|
4264
4349
|
/**
|
|
@@ -4267,7 +4352,7 @@ export interface CreateOpenZFSVolumeConfiguration {
|
|
|
4267
4352
|
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
4268
4353
|
* value is <code>true</code>, and you specify one or more tags, only the specified tags
|
|
4269
4354
|
* are copied to snapshots. If you specify one or more tags when creating the snapshot, no
|
|
4270
|
-
* tags are copied from the volume, regardless of this value
|
|
4355
|
+
* tags are copied from the volume, regardless of this value.</p>
|
|
4271
4356
|
*/
|
|
4272
4357
|
CopyTagsToSnapshots?: boolean;
|
|
4273
4358
|
/**
|
|
@@ -4276,15 +4361,15 @@ export interface CreateOpenZFSVolumeConfiguration {
|
|
|
4276
4361
|
*/
|
|
4277
4362
|
OriginSnapshot?: CreateOpenZFSOriginSnapshotConfiguration;
|
|
4278
4363
|
/**
|
|
4279
|
-
* <p>A Boolean value indicating whether the volume is read-only
|
|
4364
|
+
* <p>A Boolean value indicating whether the volume is read-only.</p>
|
|
4280
4365
|
*/
|
|
4281
4366
|
ReadOnly?: boolean;
|
|
4282
4367
|
/**
|
|
4283
|
-
* <p>The configuration object for mounting a Network File System (NFS) file system
|
|
4368
|
+
* <p>The configuration object for mounting a Network File System (NFS) file system.</p>
|
|
4284
4369
|
*/
|
|
4285
4370
|
NfsExports?: OpenZFSNfsExport[];
|
|
4286
4371
|
/**
|
|
4287
|
-
* <p>An object specifying how much storage users or groups can use on the volume
|
|
4372
|
+
* <p>An object specifying how much storage users or groups can use on the volume.</p>
|
|
4288
4373
|
*/
|
|
4289
4374
|
UserAndGroupQuotas?: OpenZFSUserOrGroupQuota[];
|
|
4290
4375
|
}
|
|
@@ -4345,7 +4430,7 @@ export declare class MissingVolumeConfiguration extends __BaseException {
|
|
|
4345
4430
|
constructor(opts: __ExceptionOptionType<MissingVolumeConfiguration, __BaseException>);
|
|
4346
4431
|
}
|
|
4347
4432
|
/**
|
|
4348
|
-
* <p>No
|
|
4433
|
+
* <p>No FSx for ONTAP SVMs were found based upon the supplied parameters.</p>
|
|
4349
4434
|
*/
|
|
4350
4435
|
export declare class StorageVirtualMachineNotFound extends __BaseException {
|
|
4351
4436
|
readonly name: "StorageVirtualMachineNotFound";
|
|
@@ -4556,8 +4641,11 @@ export declare namespace DeleteFileSystemLustreConfiguration {
|
|
|
4556
4641
|
*/
|
|
4557
4642
|
const filterSensitiveLog: (obj: DeleteFileSystemLustreConfiguration) => any;
|
|
4558
4643
|
}
|
|
4644
|
+
export declare enum DeleteFileSystemOpenZFSOption {
|
|
4645
|
+
DELETE_CHILD_VOLUMES_AND_SNAPSHOTS = "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"
|
|
4646
|
+
}
|
|
4559
4647
|
/**
|
|
4560
|
-
* <p>The configuration object for the OpenZFS file system used in the
|
|
4648
|
+
* <p>The configuration object for the Amazon FSx for OpenZFS file system used in the
|
|
4561
4649
|
* <code>DeleteFileSystem</code> operation.</p>
|
|
4562
4650
|
*/
|
|
4563
4651
|
export interface DeleteFileSystemOpenZFSConfiguration {
|
|
@@ -4565,15 +4653,19 @@ export interface DeleteFileSystemOpenZFSConfiguration {
|
|
|
4565
4653
|
* <p>By default, Amazon FSx for OpenZFS takes a final backup on your behalf when
|
|
4566
4654
|
* the <code>DeleteFileSystem</code> operation is invoked. Doing this helps protect you
|
|
4567
4655
|
* from data loss, and we highly recommend taking the final backup. If you want to skip
|
|
4568
|
-
*
|
|
4569
|
-
* value
|
|
4570
|
-
* to do so. </p>
|
|
4656
|
+
* taking a final backup, set this value to <code>true</code>.</p>
|
|
4571
4657
|
*/
|
|
4572
4658
|
SkipFinalBackup?: boolean;
|
|
4573
4659
|
/**
|
|
4574
|
-
* <p>A list of
|
|
4660
|
+
* <p>A list of tags to apply to the file system's final backup.</p>
|
|
4575
4661
|
*/
|
|
4576
4662
|
FinalBackupTags?: Tag[];
|
|
4663
|
+
/**
|
|
4664
|
+
* <p>To delete a file system if there are child volumes present below the root volume,
|
|
4665
|
+
* use the string <code>DELETE_CHILD_VOLUMES_AND_SNAPSHOTS</code>. If your file system
|
|
4666
|
+
* has child volumes and you don't use this option, the delete request will fail.</p>
|
|
4667
|
+
*/
|
|
4668
|
+
Options?: (DeleteFileSystemOpenZFSOption | string)[];
|
|
4577
4669
|
}
|
|
4578
4670
|
export declare namespace DeleteFileSystemOpenZFSConfiguration {
|
|
4579
4671
|
/**
|
|
@@ -5896,7 +5988,7 @@ export interface UpdateFileSystemOpenZFSConfiguration {
|
|
|
5896
5988
|
* where the user doesn't specify tags. If this value is <code>true</code> and you specify
|
|
5897
5989
|
* one or more tags, only the specified tags are copied to backups. If you specify one or
|
|
5898
5990
|
* more tags when creating a user-initiated backup, no tags are copied from the file
|
|
5899
|
-
* system, regardless of this value
|
|
5991
|
+
* system, regardless of this value.</p>
|
|
5900
5992
|
*/
|
|
5901
5993
|
CopyTagsToBackups?: boolean;
|
|
5902
5994
|
/**
|
|
@@ -5905,7 +5997,7 @@ export interface UpdateFileSystemOpenZFSConfiguration {
|
|
|
5905
5997
|
* for the volume are copied to snapshots where the user doesn't specify tags. If this
|
|
5906
5998
|
* value is <code>true</code> and you specify one or more tags, only the specified tags are
|
|
5907
5999
|
* copied to snapshots. If you specify one or more tags when creating the snapshot, no tags
|
|
5908
|
-
* are copied from the volume, regardless of this value
|
|
6000
|
+
* are copied from the volume, regardless of this value.</p>
|
|
5909
6001
|
*/
|
|
5910
6002
|
CopyTagsToVolumes?: boolean;
|
|
5911
6003
|
/**
|
|
@@ -5916,7 +6008,7 @@ export interface UpdateFileSystemOpenZFSConfiguration {
|
|
|
5916
6008
|
DailyAutomaticBackupStartTime?: string;
|
|
5917
6009
|
/**
|
|
5918
6010
|
* <p>The throughput of an Amazon FSx file system, measured in megabytes per second
|
|
5919
|
-
* (MBps)
|
|
6011
|
+
* (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.</p>
|
|
5920
6012
|
*/
|
|
5921
6013
|
ThroughputCapacity?: number;
|
|
5922
6014
|
/**
|
|
@@ -6103,7 +6195,7 @@ export interface UpdateSnapshotRequest {
|
|
|
6103
6195
|
*/
|
|
6104
6196
|
ClientRequestToken?: string;
|
|
6105
6197
|
/**
|
|
6106
|
-
* <p>The name of the snapshot to update
|
|
6198
|
+
* <p>The name of the snapshot to update.</p>
|
|
6107
6199
|
*/
|
|
6108
6200
|
Name: string | undefined;
|
|
6109
6201
|
/**
|
|
@@ -6208,36 +6300,52 @@ export declare namespace UpdateOntapVolumeConfiguration {
|
|
|
6208
6300
|
const filterSensitiveLog: (obj: UpdateOntapVolumeConfiguration) => any;
|
|
6209
6301
|
}
|
|
6210
6302
|
/**
|
|
6211
|
-
* <p>Used to specify changes to the OpenZFS configuration for the volume
|
|
6212
|
-
* updating.</p>
|
|
6303
|
+
* <p>Used to specify changes to the OpenZFS configuration for the volume
|
|
6304
|
+
* that you are updating.</p>
|
|
6213
6305
|
*/
|
|
6214
6306
|
export interface UpdateOpenZFSVolumeConfiguration {
|
|
6215
6307
|
/**
|
|
6216
|
-
* <p>The amount of storage in gibibytes (GiB) to reserve from the parent volume.
|
|
6217
|
-
* reserve more storage than the parent volume has reserved
|
|
6308
|
+
* <p>The amount of storage in gibibytes (GiB) to reserve from the parent volume.
|
|
6309
|
+
* You can't reserve more storage than the parent volume has reserved. You can specify
|
|
6310
|
+
* a value of <code>-1</code> to unset a volume's storage capacity reservation.</p>
|
|
6218
6311
|
*/
|
|
6219
6312
|
StorageCapacityReservationGiB?: number;
|
|
6220
6313
|
/**
|
|
6221
|
-
* <p
|
|
6222
|
-
*
|
|
6223
|
-
*
|
|
6314
|
+
* <p>The maximum amount of storage in gibibytes (GiB) that the volume can use from its
|
|
6315
|
+
* parent. You can specify a quota larger than the storage on the parent volume. You
|
|
6316
|
+
* can specify a value of <code>-1</code> to unset a volume's storage capacity quota.</p>
|
|
6224
6317
|
*/
|
|
6225
6318
|
StorageCapacityQuotaGiB?: number;
|
|
6226
6319
|
/**
|
|
6227
|
-
* <p
|
|
6228
|
-
*
|
|
6229
|
-
*
|
|
6230
|
-
*
|
|
6320
|
+
* <p>Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8,
|
|
6321
|
+
* 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB.
|
|
6322
|
+
* Most workloads should use the default record size. Database workflows can benefit from a smaller
|
|
6323
|
+
* record size, while streaming workflows can benefit from a larger record size. For additional guidance on when
|
|
6324
|
+
* to set a custom record size, see <a href="https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs">
|
|
6325
|
+
* Tips for maximizing performance</a> in the
|
|
6326
|
+
* <i>Amazon FSx for OpenZFS User Guide</i>.</p>
|
|
6327
|
+
*/
|
|
6328
|
+
RecordSizeKiB?: number;
|
|
6329
|
+
/**
|
|
6330
|
+
* <p>Specifies the method used to compress the data on the volume. The compression
|
|
6331
|
+
* type is <code>NONE</code> by default.</p>
|
|
6231
6332
|
* <ul>
|
|
6232
6333
|
* <li>
|
|
6233
6334
|
* <p>
|
|
6234
|
-
* <code>NONE</code> - Doesn't compress the data on the volume
|
|
6335
|
+
* <code>NONE</code> - Doesn't compress the data on the volume.
|
|
6336
|
+
* <code>NONE</code> is the default.</p>
|
|
6235
6337
|
* </li>
|
|
6236
6338
|
* <li>
|
|
6237
6339
|
* <p>
|
|
6238
6340
|
* <code>ZSTD</code> - Compresses the data in the volume using the Zstandard
|
|
6239
|
-
* (ZSTD) compression algorithm.
|
|
6240
|
-
*
|
|
6341
|
+
* (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better
|
|
6342
|
+
* compression ratio to minimize on-disk storage utilization.</p>
|
|
6343
|
+
* </li>
|
|
6344
|
+
* <li>
|
|
6345
|
+
* <p>
|
|
6346
|
+
* <code>LZ4</code> - Compresses the data in the volume using the LZ4
|
|
6347
|
+
* compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive
|
|
6348
|
+
* and delivers higher write throughput speeds.</p>
|
|
6241
6349
|
* </li>
|
|
6242
6350
|
* </ul>
|
|
6243
6351
|
*/
|
|
@@ -6642,6 +6750,10 @@ export interface Snapshot {
|
|
|
6642
6750
|
* </ul>
|
|
6643
6751
|
*/
|
|
6644
6752
|
Lifecycle?: SnapshotLifecycle | string;
|
|
6753
|
+
/**
|
|
6754
|
+
* <p>Describes why a resource lifecycle state changed.</p>
|
|
6755
|
+
*/
|
|
6756
|
+
LifecycleTransitionReason?: LifecycleTransitionReason;
|
|
6645
6757
|
/**
|
|
6646
6758
|
* <p>A list of <code>Tag</code> values, with a maximum of 50 elements.</p>
|
|
6647
6759
|
*/
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: FSxClientConfig) => {
|
|
|
8
8
|
defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
|
|
9
9
|
base64Decoder: import("@aws-sdk/types").Decoder;
|
|
10
10
|
base64Encoder: import("@aws-sdk/types").Encoder;
|
|
11
|
-
bodyLengthChecker: (
|
|
11
|
+
bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
|
|
12
12
|
credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
|
|
13
13
|
defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
|
|
14
14
|
maxAttempts: number | import("@aws-sdk/types").Provider<number>;
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: FSxClientConfig) => {
|
|
|
8
8
|
defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
|
|
9
9
|
base64Decoder: import("@aws-sdk/types").Decoder;
|
|
10
10
|
base64Encoder: import("@aws-sdk/types").Encoder;
|
|
11
|
-
bodyLengthChecker: (
|
|
11
|
+
bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
|
|
12
12
|
credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
|
|
13
13
|
defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
|
|
14
14
|
maxAttempts: number | import("@aws-sdk/types").Provider<number>;
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: FSxClientConfig) => {
|
|
|
8
8
|
requestHandler: (import("@aws-sdk/types").RequestHandler<any, any, import("@aws-sdk/types").HttpHandlerOptions> & import("@aws-sdk/protocol-http").HttpHandler) | import("@aws-sdk/fetch-http-handler").FetchHttpHandler;
|
|
9
9
|
apiVersion: string;
|
|
10
10
|
urlParser: import("@aws-sdk/types").UrlParser;
|
|
11
|
-
bodyLengthChecker: (
|
|
11
|
+
bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
|
|
12
12
|
streamCollector: import("@aws-sdk/types").StreamCollector;
|
|
13
13
|
base64Decoder: import("@aws-sdk/types").Decoder;
|
|
14
14
|
base64Encoder: import("@aws-sdk/types").Encoder;
|
|
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
|
|
|
5
5
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
7
|
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
|
-
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
8
|
+
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { AssociateFileSystemAliasesCommandInput, AssociateFileSystemAliasesCommandOutput } from "./commands/AssociateFileSystemAliasesCommand";
|
|
10
10
|
import { CancelDataRepositoryTaskCommandInput, CancelDataRepositoryTaskCommandOutput } from "./commands/CancelDataRepositoryTaskCommand";
|
|
11
11
|
import { CopyBackupCommandInput, CopyBackupCommandOutput } from "./commands/CopyBackupCommand";
|
|
@@ -53,7 +53,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
53
53
|
|
|
54
54
|
urlParser?: __UrlParser;
|
|
55
55
|
|
|
56
|
-
bodyLengthChecker?:
|
|
56
|
+
bodyLengthChecker?: __BodyLengthCalculator;
|
|
57
57
|
|
|
58
58
|
streamCollector?: __StreamCollector;
|
|
59
59
|
|