@aws-sdk/client-datasync 3.118.1 → 3.119.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.
Files changed (30) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/DataSync.js +30 -0
  3. package/dist-cjs/commands/CreateLocationFsxOntapCommand.js +36 -0
  4. package/dist-cjs/commands/DescribeLocationFsxOntapCommand.js +36 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/models/models_0.js +51 -15
  7. package/dist-cjs/protocols/Aws_json1_1.js +168 -2
  8. package/dist-es/DataSync.js +30 -0
  9. package/dist-es/commands/CreateLocationFsxOntapCommand.js +39 -0
  10. package/dist-es/commands/DescribeLocationFsxOntapCommand.js +39 -0
  11. package/dist-es/commands/index.js +2 -0
  12. package/dist-es/models/models_0.js +33 -13
  13. package/dist-es/protocols/Aws_json1_1.js +186 -2
  14. package/dist-types/DataSync.d.ts +17 -4
  15. package/dist-types/DataSyncClient.d.ts +4 -2
  16. package/dist-types/commands/CreateLocationFsxOntapCommand.d.ts +36 -0
  17. package/dist-types/commands/CreateLocationObjectStorageCommand.d.ts +1 -2
  18. package/dist-types/commands/DescribeLocationFsxOntapCommand.d.ts +35 -0
  19. package/dist-types/commands/DescribeLocationObjectStorageCommand.d.ts +1 -2
  20. package/dist-types/commands/index.d.ts +2 -0
  21. package/dist-types/models/models_0.d.ts +293 -154
  22. package/dist-types/protocols/Aws_json1_1.d.ts +6 -0
  23. package/dist-types/ts3.4/DataSync.d.ts +10 -0
  24. package/dist-types/ts3.4/DataSyncClient.d.ts +4 -2
  25. package/dist-types/ts3.4/commands/CreateLocationFsxOntapCommand.d.ts +17 -0
  26. package/dist-types/ts3.4/commands/DescribeLocationFsxOntapCommand.d.ts +17 -0
  27. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  28. package/dist-types/ts3.4/models/models_0.d.ts +83 -14
  29. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +6 -0
  30. package/package.json +1 -1
@@ -254,7 +254,8 @@ export interface CreateLocationEfsRequest {
254
254
  */
255
255
  FileSystemAccessRoleArn?: string;
256
256
  /**
257
- * <p>Specifies whether you want DataSync to use TLS encryption when transferring data to or from your Amazon EFS file system.</p>
257
+ * <p>Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to
258
+ * or from the Amazon EFS file system.</p>
258
259
  * <p>If you specify an access point using <code>AccessPointArn</code> or an IAM
259
260
  * role using <code>FileSystemAccessRoleArn</code>, you must set this parameter to
260
261
  * <code>TLS1_2</code>.</p>
@@ -327,41 +328,38 @@ export declare enum NfsVersion {
327
328
  NFS4_1 = "NFS4_1"
328
329
  }
329
330
  /**
330
- * <p>Represents the mount options that are available for DataSync to access an NFS
331
- * location.</p>
331
+ * <p>Specifies how DataSync can access a location using the NFS protocol.</p>
332
332
  */
333
333
  export interface NfsMountOptions {
334
334
  /**
335
- * <p>The specific NFS version that you want DataSync to use to mount your NFS share. If the
336
- * server refuses to use the version specified, the sync will fail. If you don't specify a
337
- * version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically
338
- * selects a version based on negotiation with the NFS server.</p>
335
+ * <p>Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.</p>
339
336
  *
340
- * <p>You can specify the following NFS versions:</p>
337
+ * <p>You can specify the following options:</p>
341
338
  * <ul>
342
339
  * <li>
343
340
  * <p>
344
- * <b>
345
- * <a href="https://tools.ietf.org/html/rfc1813">NFSv3</a>
346
- * </b> - stateless protocol version that allows for asynchronous
341
+ * <code>AUTOMATIC</code> (default): DataSync chooses NFS version 4.1.</p>
342
+ * </li>
343
+ * <li>
344
+ * <p>
345
+ * <code>NFS3</code>: Stateless protocol version that allows for asynchronous
347
346
  * writes on the server.</p>
348
347
  * </li>
349
348
  * <li>
350
349
  * <p>
351
- * <b>
352
- * <a href="https://tools.ietf.org/html/rfc3530">NFSv4.0</a>
353
- * </b> - stateful, firewall-friendly protocol version that supports
350
+ * <code>NFSv4_0</code>: Stateful, firewall-friendly protocol version that supports
354
351
  * delegations and pseudo file systems.</p>
355
352
  * </li>
356
353
  * <li>
357
354
  * <p>
358
- * <b>
359
- * <a href="https://tools.ietf.org/html/rfc5661">NFSv4.1</a>
360
- * </b> - stateful protocol version that supports sessions,
361
- * directory delegations, and parallel data processing. Version 4.1 also includes all
355
+ * <code>NFSv4_1</code>: Stateful protocol version that supports sessions,
356
+ * directory delegations, and parallel data processing. NFS version 4.1 also includes all
362
357
  * features available in version 4.0.</p>
363
358
  * </li>
364
359
  * </ul>
360
+ * <note>
361
+ * <p>DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.</p>
362
+ * </note>
365
363
  */
366
364
  Version?: NfsVersion | string;
367
365
  }
@@ -372,12 +370,11 @@ export declare namespace NfsMountOptions {
372
370
  const filterSensitiveLog: (obj: NfsMountOptions) => any;
373
371
  }
374
372
  /**
375
- * <p>Represents the Network File System (NFS) protocol that DataSync uses to access your Amazon FSx for OpenZFS file system.</p>
373
+ * <p>Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP file system.</p>
376
374
  */
377
375
  export interface FsxProtocolNfs {
378
376
  /**
379
- * <p>Represents the mount options that are available for DataSync to access an NFS
380
- * location.</p>
377
+ * <p>Specifies how DataSync can access a location using the NFS protocol.</p>
381
378
  */
382
379
  MountOptions?: NfsMountOptions;
383
380
  }
@@ -387,14 +384,66 @@ export declare namespace FsxProtocolNfs {
387
384
  */
388
385
  const filterSensitiveLog: (obj: FsxProtocolNfs) => any;
389
386
  }
387
+ export declare enum SmbVersion {
388
+ AUTOMATIC = "AUTOMATIC",
389
+ SMB2 = "SMB2",
390
+ SMB3 = "SMB3"
391
+ }
392
+ /**
393
+ * <p>Specifies how DataSync can access a location using the SMB protocol.</p>
394
+ */
395
+ export interface SmbMountOptions {
396
+ /**
397
+ * <p>Specifies the SMB version that you want DataSync to use when mounting your SMB share. If you
398
+ * don't specify a version, DataSync defaults to <code>AUTOMATIC</code> and chooses a version based on negotiation with the SMB server.</p>
399
+ */
400
+ Version?: SmbVersion | string;
401
+ }
402
+ export declare namespace SmbMountOptions {
403
+ /**
404
+ * @internal
405
+ */
406
+ const filterSensitiveLog: (obj: SmbMountOptions) => any;
407
+ }
390
408
  /**
391
- * <p>Represents the protocol that DataSync uses to access your Amazon FSx for OpenZFS file system.</p>
409
+ * <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">Accessing FSx for ONTAP file systems</a>.</p>
410
+ */
411
+ export interface FsxProtocolSmb {
412
+ /**
413
+ * <p>Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.</p>
414
+ */
415
+ Domain?: string;
416
+ /**
417
+ * <p>Specifies how DataSync can access a location using the SMB protocol.</p>
418
+ */
419
+ MountOptions?: SmbMountOptions;
420
+ /**
421
+ * <p>Specifies the password of a user who has permission to access your SVM.</p>
422
+ */
423
+ Password: string | undefined;
424
+ /**
425
+ * <p>Specifies a user who has permission to access your SVM.</p>
426
+ */
427
+ User: string | undefined;
428
+ }
429
+ export declare namespace FsxProtocolSmb {
430
+ /**
431
+ * @internal
432
+ */
433
+ const filterSensitiveLog: (obj: FsxProtocolSmb) => any;
434
+ }
435
+ /**
436
+ * <p>Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.</p>
392
437
  */
393
438
  export interface FsxProtocol {
394
439
  /**
395
- * <p>Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system.</p>
440
+ * <p>Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).</p>
396
441
  */
397
442
  NFS?: FsxProtocolNfs;
443
+ /**
444
+ * <p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.</p>
445
+ */
446
+ SMB?: FsxProtocolSmb;
398
447
  }
399
448
  export declare namespace FsxProtocol {
400
449
  /**
@@ -402,6 +451,65 @@ export declare namespace FsxProtocol {
402
451
  */
403
452
  const filterSensitiveLog: (obj: FsxProtocol) => any;
404
453
  }
454
+ export interface CreateLocationFsxOntapRequest {
455
+ /**
456
+ * <p>Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.</p>
457
+ */
458
+ Protocol: FsxProtocol | undefined;
459
+ /**
460
+ * <p>Specifies the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound
461
+ * traffic on the following ports (depending on the protocol that you're using):</p>
462
+ * <ul>
463
+ * <li>
464
+ * <p>
465
+ * <b>Network File System (NFS)</b>: TCP port 2049</p>
466
+ * </li>
467
+ * <li>
468
+ * <p>
469
+ * <b>Server Message Block (SMB)</b>: TCP port 445</p>
470
+ * </li>
471
+ * </ul>
472
+ * <p>Your file system's security groups must also allow inbound traffic on the same port.</p>
473
+ */
474
+ SecurityGroupArns: string[] | undefined;
475
+ /**
476
+ * <p>Specifies the ARN of the storage virtual machine (SVM) on your file system where you're
477
+ * copying data to or from.</p>
478
+ */
479
+ StorageVirtualMachineArn: string | undefined;
480
+ /**
481
+ * <p>Specifies the junction path (also known as a mount point) in the SVM volume where you're
482
+ * copying data to or from (for example, <code>/vol1</code>).</p>
483
+ * <note>
484
+ * <p>Don't specify a junction path in the SVM's root volume. For more
485
+ * information, see <a href="https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html">Managing FSx for ONTAP
486
+ * storage virtual machines</a> in the <i>Amazon FSx for NetApp ONTAP User Guide</i>.</p>
487
+ * </note>
488
+ */
489
+ Subdirectory?: string;
490
+ /**
491
+ * <p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</p>
492
+ */
493
+ Tags?: TagListEntry[];
494
+ }
495
+ export declare namespace CreateLocationFsxOntapRequest {
496
+ /**
497
+ * @internal
498
+ */
499
+ const filterSensitiveLog: (obj: CreateLocationFsxOntapRequest) => any;
500
+ }
501
+ export interface CreateLocationFsxOntapResponse {
502
+ /**
503
+ * <p>Specifies the ARN of the FSx for ONTAP file system location that you create.</p>
504
+ */
505
+ LocationArn?: string;
506
+ }
507
+ export declare namespace CreateLocationFsxOntapResponse {
508
+ /**
509
+ * @internal
510
+ */
511
+ const filterSensitiveLog: (obj: CreateLocationFsxOntapResponse) => any;
512
+ }
405
513
  export interface CreateLocationFsxOpenZfsRequest {
406
514
  /**
407
515
  * <p>The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.</p>
@@ -775,54 +883,40 @@ export declare enum ObjectStorageServerProtocol {
775
883
  */
776
884
  export interface CreateLocationObjectStorageRequest {
777
885
  /**
778
- * <p>The name of the self-managed object storage server. This value is the IP address or Domain
779
- * Name Service (DNS) name of the object storage server. An agent uses this hostname to mount the
780
- * object storage server in a network. </p>
886
+ * <p>Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the
887
+ * object storage server in a network.</p>
781
888
  */
782
889
  ServerHostname: string | undefined;
783
890
  /**
784
- * <p>The port that your self-managed object storage server accepts inbound network traffic on.
785
- * The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can
786
- * specify a custom port if your self-managed object storage server requires one.</p>
891
+ * <p>Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).</p>
787
892
  */
788
893
  ServerPort?: number;
789
894
  /**
790
- * <p>The protocol that the object storage server uses to communicate.
791
- * Valid values are HTTP or HTTPS.</p>
895
+ * <p>Specifies the protocol that your object storage server uses to communicate.</p>
792
896
  */
793
897
  ServerProtocol?: ObjectStorageServerProtocol | string;
794
898
  /**
795
- * <p>The subdirectory in the self-managed object storage server that is used
796
- * to read data from.</p>
899
+ * <p>Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix. </p>
797
900
  */
798
901
  Subdirectory?: string;
799
902
  /**
800
- * <p>The bucket on the self-managed object storage server that is used
801
- * to read data from.</p>
903
+ * <p>Specifies the name of the object storage bucket involved in the transfer.</p>
802
904
  */
803
905
  BucketName: string | undefined;
804
906
  /**
805
- * <p>Optional. The access key is used if credentials are required to access the self-managed
806
- * object storage server. If your object storage requires a user name and password to
807
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
808
- * and password, respectively.</p>
907
+ * <p>Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.</p>
809
908
  */
810
909
  AccessKey?: string;
811
910
  /**
812
- * <p>Optional. The secret key is used if credentials are required to access the self-managed
813
- * object storage server. If your object storage requires a user name and password to
814
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
815
- * and password, respectively.</p>
911
+ * <p>Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.</p>
816
912
  */
817
913
  SecretKey?: string;
818
914
  /**
819
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
820
- * self-managed object storage server location.</p>
915
+ * <p>Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.</p>
821
916
  */
822
917
  AgentArns: string[] | undefined;
823
918
  /**
824
- * <p>The key-value pair that represents the tag that you want to add to the location. The
825
- * value can be an empty string. We recommend using tags to name your resources.</p>
919
+ * <p>Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.</p>
826
920
  */
827
921
  Tags?: TagListEntry[];
828
922
  }
@@ -837,8 +931,7 @@ export declare namespace CreateLocationObjectStorageRequest {
837
931
  */
838
932
  export interface CreateLocationObjectStorageResponse {
839
933
  /**
840
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
841
- * self-managed object storage server location.</p>
934
+ * <p>Specifies the ARN of the object storage system location that you create.</p>
842
935
  */
843
936
  LocationArn?: string;
844
937
  }
@@ -942,29 +1035,6 @@ export declare namespace CreateLocationS3Response {
942
1035
  */
943
1036
  const filterSensitiveLog: (obj: CreateLocationS3Response) => any;
944
1037
  }
945
- export declare enum SmbVersion {
946
- AUTOMATIC = "AUTOMATIC",
947
- SMB2 = "SMB2",
948
- SMB3 = "SMB3"
949
- }
950
- /**
951
- * <p>Represents the mount options that are available for DataSync to access an SMB
952
- * location.</p>
953
- */
954
- export interface SmbMountOptions {
955
- /**
956
- * <p>The specific SMB version that you want DataSync to use to mount your SMB share. If you
957
- * don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync
958
- * automatically selects a version based on negotiation with the SMB server.</p>
959
- */
960
- Version?: SmbVersion | string;
961
- }
962
- export declare namespace SmbMountOptions {
963
- /**
964
- * @internal
965
- */
966
- const filterSensitiveLog: (obj: SmbMountOptions) => any;
967
- }
968
1038
  /**
969
1039
  * <p>CreateLocationSmbRequest</p>
970
1040
  */
@@ -1003,7 +1073,7 @@ export interface CreateLocationSmbRequest {
1003
1073
  * SMB share.</p>
1004
1074
  *
1005
1075
  * <p>For information about choosing a user name that ensures sufficient permissions to files,
1006
- * folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
1076
+ * folders, and metadata, see the <a href="create-smb-location.html#SMBuser">User setting</a> for SMB locations.</p>
1007
1077
  */
1008
1078
  User: string | undefined;
1009
1079
  /**
@@ -1158,17 +1228,20 @@ export interface Options {
1158
1228
  * For more information, see
1159
1229
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html">Configure task settings</a>.
1160
1230
  * </p>
1161
- * <p>Default value: POINT_IN_TIME_CONSISTENT.</p>
1162
- * <p>ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.
1163
- * </p>
1231
+ * <p>Default value: <code>POINT_IN_TIME_CONSISTENT</code>
1232
+ * </p>
1233
+ * <p>
1234
+ * <code>ONLY_FILES_TRANSFERRED</code> (recommended): Perform verification only on files
1235
+ * that were transferred. </p>
1164
1236
  *
1165
- * <p>POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination
1166
- * at the end of the transfer
1167
- * to verify that source and destination are fully
1168
- * synchronized. This option isn't supported when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes.</p>
1169
- * <p>NONE: No additional verification is done at the end of the
1170
- * transfer, but all data transmissions are integrity-checked with
1171
- * checksum verification during the transfer.</p>
1237
+ * <p>
1238
+ * <code>POINT_IN_TIME_CONSISTENT</code>: Scan the entire source and entire destination at
1239
+ * the end of the transfer to verify that source and destination are fully synchronized. This
1240
+ * option isn't supported when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes.</p>
1241
+ * <p>
1242
+ * <code>NONE</code>: No additional verification is done at the end of the transfer, but
1243
+ * all data transmissions are integrity-checked with checksum verification during the
1244
+ * transfer.</p>
1172
1245
  */
1173
1246
  VerifyMode?: VerifyMode | string;
1174
1247
  /**
@@ -1184,52 +1257,63 @@ export interface Options {
1184
1257
  OverwriteMode?: OverwriteMode | string;
1185
1258
  /**
1186
1259
  * <p>A file metadata value that shows the last time a file was accessed (that is, when the
1187
- * file was read or written to). If you set <code>Atime</code> to BEST_EFFORT, DataSync
1188
- * attempts to preserve the original <code>Atime</code> attribute on all source files (that is,
1189
- * the version before the PREPARING phase). However, <code>Atime</code>'s behavior is not
1190
- * fully standard across platforms, so DataSync can only do this on a best-effort basis. </p>
1191
- * <p>Default value: BEST_EFFORT.</p>
1192
- * <p>BEST_EFFORT: Attempt to preserve the per-file <code>Atime</code> value
1260
+ * file was read or written to). If you set <code>Atime</code> to <code>BEST_EFFORT</code>,
1261
+ * DataSync attempts to preserve the original <code>Atime</code> attribute on all
1262
+ * source files (that is, the version before the <code>PREPARING</code> phase). However,
1263
+ * <code>Atime</code>'s behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis. </p>
1264
+ * <p>Default value: <code>BEST_EFFORT</code>
1265
+ * </p>
1266
+ * <p>
1267
+ * <code>BEST_EFFORT</code>: Attempt to preserve the per-file <code>Atime</code> value
1193
1268
  * (recommended).</p>
1194
- * <p>NONE: Ignore <code>Atime</code>.</p>
1269
+ * <p>
1270
+ * <code>NONE</code>: Ignore <code>Atime</code>.</p>
1195
1271
  * <note>
1196
- * <p>If <code>Atime</code> is set to BEST_EFFORT, <code>Mtime</code> must be set to PRESERVE. </p>
1197
- * <p>If <code>Atime</code> is set to NONE, <code>Mtime</code> must also be NONE. </p>
1272
+ * <p>If <code>Atime</code> is set to <code>BEST_EFFORT</code>, <code>Mtime</code> must be set
1273
+ * to <code>PRESERVE</code>. </p>
1274
+ * <p>If <code>Atime</code> is set to <code>NONE</code>, <code>Mtime</code> must also be
1275
+ * <code>NONE</code>. </p>
1198
1276
  * </note>
1199
1277
  */
1200
1278
  Atime?: Atime | string;
1201
1279
  /**
1202
1280
  * <p>A value that indicates the last time that a file was modified (that is, a file was
1203
- * written to) before the PREPARING phase. This option is required for cases when you need to run
1204
- * the same task more than one time. </p>
1281
+ * written to) before the <code>PREPARING</code> phase. This option is required for cases when
1282
+ * you need to run the same task more than one time. </p>
1205
1283
  * <p>Default Value: <code>PRESERVE</code>
1206
1284
  * </p>
1207
- * <p>PRESERVE: Preserve original <code>Mtime</code> (recommended)</p>
1208
- * <p> NONE: Ignore <code>Mtime</code>. </p>
1285
+ * <p>
1286
+ * <code>PRESERVE</code>: Preserve original <code>Mtime</code> (recommended)</p>
1287
+ * <p>
1288
+ * <code>NONE</code>: Ignore <code>Mtime</code>. </p>
1209
1289
  * <note>
1210
- * <p>If <code>Mtime</code> is set to PRESERVE, <code>Atime</code> must be set to
1211
- * BEST_EFFORT.</p>
1212
- * <p>If <code>Mtime</code> is set to NONE, <code>Atime</code> must also be set to NONE.
1213
- * </p>
1290
+ * <p>If <code>Mtime</code> is set to <code>PRESERVE</code>, <code>Atime</code> must be set to
1291
+ * <code>BEST_EFFORT</code>.</p>
1292
+ * <p>If <code>Mtime</code> is set to <code>NONE</code>, <code>Atime</code> must also be set
1293
+ * to <code>NONE</code>. </p>
1214
1294
  * </note>
1215
1295
  */
1216
1296
  Mtime?: Mtime | string;
1217
1297
  /**
1218
- * <p>The POSIX user ID (UID) of the file's owner. This option should only be set for NFS,
1219
- * EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>.</p>
1220
- * <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p>
1221
- * <p>INT_VALUE: Preserve the integer value of UID and group ID (GID)
1298
+ * <p>The POSIX user ID (UID) of the file's owner.</p>
1299
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
1300
+ * <p>Default value: <code>INT_VALUE</code>. This preserves the integer value of the ID.</p>
1301
+ * <p>
1302
+ * <code>INT_VALUE</code>: Preserve the integer value of UID and group ID (GID)
1222
1303
  * (recommended).</p>
1223
- * <p>NONE: Ignore UID and GID. </p>
1304
+ * <p>
1305
+ * <code>NONE</code>: Ignore UID and GID. </p>
1224
1306
  */
1225
1307
  Uid?: Uid | string;
1226
1308
  /**
1227
- * <p>The POSIX group ID (GID) of the file's owners. This option should only be set for
1228
- * NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync,
1229
- * see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>. </p>
1230
- * <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p>
1231
- * <p>INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).</p>
1232
- * <p>NONE: Ignore UID and GID. </p>
1309
+ * <p>The POSIX group ID (GID) of the file's owners.</p>
1310
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
1311
+ * <p>Default value: <code>INT_VALUE</code>. This preserves the integer value of the ID.</p>
1312
+ * <p>
1313
+ * <code>INT_VALUE</code>: Preserve the integer value of user ID (UID) and GID
1314
+ * (recommended).</p>
1315
+ * <p>
1316
+ * <code>NONE</code>: Ignore UID and GID.</p>
1233
1317
  */
1234
1318
  Gid?: Gid | string;
1235
1319
  /**
@@ -1238,9 +1322,13 @@ export interface Options {
1238
1322
  * If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed
1239
1323
  * information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Considerations when working with Amazon S3 storage classes in DataSync </a> in the <i>DataSync User
1240
1324
  * Guide</i>.</p>
1241
- * <p>Default value: PRESERVE.</p>
1242
- * <p>PRESERVE: Ignore such destination files (recommended). </p>
1243
- * <p>REMOVE: Delete destination files that aren’t present in the source.</p>
1325
+ * <p>Default value: <code>PRESERVE</code>
1326
+ * </p>
1327
+ * <p>
1328
+ * <code>PRESERVE</code>: Ignore such destination files (recommended). </p>
1329
+ * <p>
1330
+ * <code>REMOVE</code>: Delete destination files that aren’t present in the
1331
+ * source.</p>
1244
1332
  */
1245
1333
  PreserveDeletedFiles?: PreserveDeletedFiles | string;
1246
1334
  /**
@@ -1252,20 +1340,25 @@ export interface Options {
1252
1340
  * <p>DataSync can't sync the actual contents of such devices, because they are
1253
1341
  * nonterminal and don't return an end-of-file (EOF) marker.</p>
1254
1342
  * </note>
1255
- * <p>Default value: NONE.</p>
1256
- * <p>NONE: Ignore special devices (recommended). </p>
1257
- * <p>PRESERVE: Preserve character and block device metadata. This option isn't currently
1258
- * supported for Amazon EFS. </p>
1343
+ * <p>Default value: <code>NONE</code>
1344
+ * </p>
1345
+ * <p>
1346
+ * <code>NONE</code>: Ignore special devices (recommended). </p>
1347
+ * <p>
1348
+ * <code>PRESERVE</code>: Preserve character and block device metadata. This option isn't
1349
+ * currently supported for Amazon EFS. </p>
1259
1350
  */
1260
1351
  PreserveDevices?: PreserveDevices | string;
1261
1352
  /**
1262
1353
  * <p>A value that determines which users or groups can access a file for a specific purpose
1263
- * such as reading, writing, or execution of the file. This option should only be set for NFS,
1264
- * EFS, and S3 locations. For more information about what metadata is copied by DataSync, see
1265
- * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata Copied by DataSync</a>. </p>
1266
- * <p>Default value: PRESERVE.</p>
1267
- * <p>PRESERVE: Preserve POSIX-style permissions (recommended).</p>
1268
- * <p>NONE: Ignore permissions. </p>
1354
+ * such as reading, writing, or execution of the file.</p>
1355
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied">Metadata copied by DataSync</a>.</p>
1356
+ * <p>Default value: <code>PRESERVE</code>
1357
+ * </p>
1358
+ * <p>
1359
+ * <code>PRESERVE</code>: Preserve POSIX-style permissions (recommended).</p>
1360
+ * <p>
1361
+ * <code>NONE</code>: Ignore permissions. </p>
1269
1362
  * <note>
1270
1363
  * <p>DataSync can preserve extant permissions of a source location.</p>
1271
1364
  * </note>
@@ -1298,10 +1391,12 @@ export interface Options {
1298
1391
  * <p>A value that determines whether DataSync transfers only the data and metadata that differ between the source
1299
1392
  * and the destination location, or whether DataSync transfers all the content from the source, without comparing to
1300
1393
  * the destination location. </p>
1301
- * <p>CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the
1302
- * destination location.</p>
1303
- * <p>ALL: DataSync copies all source location content to the destination, without comparing to existing content on
1304
- * the destination.</p>
1394
+ * <p>
1395
+ * <code>CHANGED</code>: DataSync copies only data or metadata that is new or
1396
+ * different content from the source location to the destination location.</p>
1397
+ * <p>
1398
+ * <code>ALL</code>: DataSync copies all source location content to the
1399
+ * destination, without comparing to existing content on the destination.</p>
1305
1400
  */
1306
1401
  TransferMode?: TransferMode | string;
1307
1402
  /**
@@ -1314,10 +1409,12 @@ export interface Options {
1314
1409
  * DataSync handles metadata, see
1315
1410
  * <a href="https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html">How DataSync Handles Metadata and Special Files</a>.
1316
1411
  * </p>
1317
- * <p>Default value: OWNER_DACL.</p>
1412
+ * <p>Default value: <code>OWNER_DACL</code>
1413
+ * </p>
1318
1414
  *
1319
1415
  * <p>
1320
- * <b>OWNER_DACL</b>: For each copied object, DataSync copies the following metadata:</p>
1416
+ * <code>OWNER_DACL</code>: For each copied object, DataSync copies the following
1417
+ * metadata:</p>
1321
1418
  * <ul>
1322
1419
  * <li>
1323
1420
  * <p>Object owner.</p>
@@ -1331,7 +1428,8 @@ export interface Options {
1331
1428
  * (SACLs), which are used by administrators to log attempts to access a secured object.</p>
1332
1429
  *
1333
1430
  * <p>
1334
- * <b>OWNER_DACL_SACL</b>: For each copied object, DataSync copies the following metadata:</p>
1431
+ * <code>OWNER_DACL_SACL</code>: For each copied object, DataSync copies the following
1432
+ * metadata:</p>
1335
1433
  * <ul>
1336
1434
  * <li>
1337
1435
  * <p>Object owner.</p>
@@ -1350,10 +1448,9 @@ export interface Options {
1350
1448
  * sufficient permissions to files, folders, and metadata, see <a href="create-smb-location.html#SMBuser">user</a>.</p>
1351
1449
  *
1352
1450
  * <p>
1353
- * <b>NONE</b>: None of the SMB security descriptor components
1354
- * are copied. Destination objects are owned by the user that was provided for accessing the
1355
- * destination location. DACLs and SACLs are set based on the destination server’s configuration.
1356
- * </p>
1451
+ * <code>NONE</code>: None of the SMB security descriptor components are copied. Destination
1452
+ * objects are owned by the user that was provided for accessing the destination location. DACLs
1453
+ * and SACLs are set based on the destination server’s configuration. </p>
1357
1454
  */
1358
1455
  SecurityDescriptorCopyFlags?: SmbSecurityDescriptorCopyFlags | string;
1359
1456
  /**
@@ -1676,7 +1773,8 @@ export interface DescribeLocationEfsResponse {
1676
1773
  */
1677
1774
  FileSystemAccessRoleArn?: string;
1678
1775
  /**
1679
- * <p>Whether DataSync uses TLS encryption when transferring data to or from your Amazon EFS file system.</p>
1776
+ * <p>Describes whether DataSync uses Transport Layer Security (TLS) encryption when
1777
+ * copying data to or from the Amazon EFS file system.</p>
1680
1778
  */
1681
1779
  InTransitEncryption?: EfsInTransitEncryption | string;
1682
1780
  }
@@ -1722,6 +1820,55 @@ export declare namespace DescribeLocationFsxLustreResponse {
1722
1820
  */
1723
1821
  const filterSensitiveLog: (obj: DescribeLocationFsxLustreResponse) => any;
1724
1822
  }
1823
+ export interface DescribeLocationFsxOntapRequest {
1824
+ /**
1825
+ * <p>Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.</p>
1826
+ */
1827
+ LocationArn: string | undefined;
1828
+ }
1829
+ export declare namespace DescribeLocationFsxOntapRequest {
1830
+ /**
1831
+ * @internal
1832
+ */
1833
+ const filterSensitiveLog: (obj: DescribeLocationFsxOntapRequest) => any;
1834
+ }
1835
+ export interface DescribeLocationFsxOntapResponse {
1836
+ /**
1837
+ * <p>The time that the location was created.</p>
1838
+ */
1839
+ CreationTime?: Date;
1840
+ /**
1841
+ * <p>The ARN of the FSx for ONTAP file system location.</p>
1842
+ */
1843
+ LocationArn?: string;
1844
+ /**
1845
+ * <p>The uniform resource identifier (URI) of the FSx for ONTAP file system
1846
+ * location.</p>
1847
+ */
1848
+ LocationUri?: string;
1849
+ /**
1850
+ * <p>Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.</p>
1851
+ */
1852
+ Protocol?: FsxProtocol;
1853
+ /**
1854
+ * <p>The security groups that DataSync uses to access your FSx for ONTAP file system.</p>
1855
+ */
1856
+ SecurityGroupArns?: string[];
1857
+ /**
1858
+ * <p>The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.</p>
1859
+ */
1860
+ StorageVirtualMachineArn?: string;
1861
+ /**
1862
+ * <p>The ARN of the FSx for ONTAP file system.</p>
1863
+ */
1864
+ FsxFilesystemArn?: string;
1865
+ }
1866
+ export declare namespace DescribeLocationFsxOntapResponse {
1867
+ /**
1868
+ * @internal
1869
+ */
1870
+ const filterSensitiveLog: (obj: DescribeLocationFsxOntapResponse) => any;
1871
+ }
1725
1872
  export interface DescribeLocationFsxOpenZfsRequest {
1726
1873
  /**
1727
1874
  * <p>The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.</p>
@@ -1940,7 +2087,7 @@ export declare namespace DescribeLocationNfsResponse {
1940
2087
  */
1941
2088
  export interface DescribeLocationObjectStorageRequest {
1942
2089
  /**
1943
- * <p>The Amazon Resource Name (ARN) of the self-managed object storage server location that was described.</p>
2090
+ * <p>The Amazon Resource Name (ARN) of the object storage system location that you want information about.</p>
1944
2091
  */
1945
2092
  LocationArn: string | undefined;
1946
2093
  }
@@ -1955,37 +2102,31 @@ export declare namespace DescribeLocationObjectStorageRequest {
1955
2102
  */
1956
2103
  export interface DescribeLocationObjectStorageResponse {
1957
2104
  /**
1958
- * <p>The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.</p>
2105
+ * <p>The ARN of the object storage system location.</p>
1959
2106
  */
1960
2107
  LocationArn?: string;
1961
2108
  /**
1962
- * <p>The URL of the source self-managed object storage server location that was described.</p>
2109
+ * <p>The URL of the object storage system location.</p>
1963
2110
  */
1964
2111
  LocationUri?: string;
1965
2112
  /**
1966
- * <p>Optional. The access key is used if credentials are required to access the self-managed
1967
- * object storage server. If your object storage requires a user name and password to
1968
- * authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name
1969
- * and password, respectively.</p>
2113
+ * <p>The access key (for example, a user name) required to authenticate with the object storage server.</p>
1970
2114
  */
1971
2115
  AccessKey?: string;
1972
2116
  /**
1973
- * <p>The port that your self-managed object storage server accepts inbound network traffic on.
1974
- * The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).</p>
2117
+ * <p>The port that your object storage server accepts inbound network traffic on (for example, port 443).</p>
1975
2118
  */
1976
2119
  ServerPort?: number;
1977
2120
  /**
1978
- * <p>The protocol that the object storage server uses to communicate.
1979
- * Valid values are HTTP or HTTPS.</p>
2121
+ * <p>The protocol that your object storage server uses to communicate.</p>
1980
2122
  */
1981
2123
  ServerProtocol?: ObjectStorageServerProtocol | string;
1982
2124
  /**
1983
- * <p>The Amazon Resource Name (ARN) of the agents associated with the
1984
- * self-managed object storage server location.</p>
2125
+ * <p>The ARNs of the DataSync agents that can securely connect with your location.</p>
1985
2126
  */
1986
2127
  AgentArns?: string[];
1987
2128
  /**
1988
- * <p>The time that the self-managed object storage server agent was created.</p>
2129
+ * <p>The time that the location was created.</p>
1989
2130
  */
1990
2131
  CreationTime?: Date;
1991
2132
  }
@@ -3056,8 +3197,7 @@ export interface UpdateLocationNfsRequest {
3056
3197
  */
3057
3198
  OnPremConfig?: OnPremConfig;
3058
3199
  /**
3059
- * <p>Represents the mount options that are available for DataSync to access an NFS
3060
- * location.</p>
3200
+ * <p>Specifies how DataSync can access a location using the NFS protocol.</p>
3061
3201
  */
3062
3202
  MountOptions?: NfsMountOptions;
3063
3203
  }
@@ -3183,8 +3323,7 @@ export interface UpdateLocationSmbRequest {
3183
3323
  */
3184
3324
  AgentArns?: string[];
3185
3325
  /**
3186
- * <p>Represents the mount options that are available for DataSync to access an SMB
3187
- * location.</p>
3326
+ * <p>Specifies how DataSync can access a location using the SMB protocol.</p>
3188
3327
  */
3189
3328
  MountOptions?: SmbMountOptions;
3190
3329
  }