aws-sdk-datasync 1.46.0 → 1.49.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datasync/client.rb +278 -119
- data/lib/aws-sdk-datasync/client_api.rb +64 -0
- data/lib/aws-sdk-datasync/types.rb +539 -236
- data/lib/aws-sdk-datasync.rb +1 -1
- metadata +2 -2
@@ -199,63 +199,69 @@ module Aws::DataSync
|
|
199
199
|
# value: "TagValue",
|
200
200
|
# },
|
201
201
|
# ],
|
202
|
+
# access_point_arn: "EfsAccessPointArn",
|
203
|
+
# file_system_access_role_arn: "IamRoleArn",
|
204
|
+
# in_transit_encryption: "NONE", # accepts NONE, TLS1_2
|
202
205
|
# }
|
203
206
|
#
|
204
207
|
# @!attribute [rw] subdirectory
|
205
|
-
#
|
206
|
-
#
|
207
|
-
#
|
208
|
-
#
|
208
|
+
# Specifies a mount path for your Amazon EFS file system. This is
|
209
|
+
# where DataSync reads or writes data (depending on if this is a
|
210
|
+
# source or destination location). By default, DataSync uses the root
|
211
|
+
# directory, but you can also include subdirectories.
|
209
212
|
#
|
210
|
-
# <note markdown="1">
|
211
|
-
# `/path/to/folder
|
213
|
+
# <note markdown="1"> You must specify a value with forward slashes (for example,
|
214
|
+
# `/path/to/folder`).
|
212
215
|
#
|
213
216
|
# </note>
|
214
217
|
# @return [String]
|
215
218
|
#
|
216
219
|
# @!attribute [rw] efs_filesystem_arn
|
217
|
-
#
|
220
|
+
# Specifies the ARN for the Amazon EFS file system.
|
218
221
|
# @return [String]
|
219
222
|
#
|
220
223
|
# @!attribute [rw] ec2_config
|
221
|
-
#
|
222
|
-
#
|
223
|
-
# with the security group on the mount target in the subnet specified.
|
224
|
-
#
|
225
|
-
# The exact relationship between security group M (of the mount
|
226
|
-
# target) and security group S (which you provide for DataSync to use
|
227
|
-
# at this stage) is as follows:
|
228
|
-
#
|
229
|
-
# * Security group M (which you associate with the mount target) must
|
230
|
-
# allow inbound access for the Transmission Control Protocol (TCP)
|
231
|
-
# on the NFS port (2049) from security group S. You can enable
|
232
|
-
# inbound connections either by IP address (CIDR range) or security
|
233
|
-
# group.
|
234
|
-
#
|
235
|
-
# * Security group S (provided to DataSync to access EFS) should have
|
236
|
-
# a rule that enables outbound connections to the NFS port on one of
|
237
|
-
# the file system’s mount targets. You can enable outbound
|
238
|
-
# connections either by IP address (CIDR range) or security group.
|
239
|
-
#
|
240
|
-
# For information about security groups and mount targets, see
|
241
|
-
# Security Groups for Amazon EC2 Instances and Mount Targets in the
|
242
|
-
# *Amazon EFS User Guide.*
|
224
|
+
# Specifies the subnet and security groups DataSync uses to access
|
225
|
+
# your Amazon EFS file system.
|
243
226
|
# @return [Types::Ec2Config]
|
244
227
|
#
|
245
228
|
# @!attribute [rw] tags
|
246
|
-
#
|
247
|
-
# resource. The value can be an empty string. This value
|
248
|
-
# manage, filter, and search for your resources. We
|
249
|
-
# create a name tag for your location.
|
229
|
+
# Specifies the key-value pair that represents a tag that you want to
|
230
|
+
# add to the resource. The value can be an empty string. This value
|
231
|
+
# helps you manage, filter, and search for your resources. We
|
232
|
+
# recommend that you create a name tag for your location.
|
250
233
|
# @return [Array<Types::TagListEntry>]
|
251
234
|
#
|
235
|
+
# @!attribute [rw] access_point_arn
|
236
|
+
# Specifies the Amazon Resource Name (ARN) of the access point that
|
237
|
+
# DataSync uses to access the Amazon EFS file system.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] file_system_access_role_arn
|
241
|
+
# Specifies an Identity and Access Management (IAM) role that DataSync
|
242
|
+
# assumes when mounting the Amazon EFS file system.
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] in_transit_encryption
|
246
|
+
# Specifies whether you want DataSync to use Transport Layer Security
|
247
|
+
# (TLS) 1.2 encryption when it copies data to or from the Amazon EFS
|
248
|
+
# file system.
|
249
|
+
#
|
250
|
+
# If you specify an access point using `AccessPointArn` or an IAM role
|
251
|
+
# using `FileSystemAccessRoleArn`, you must set this parameter to
|
252
|
+
# `TLS1_2`.
|
253
|
+
# @return [String]
|
254
|
+
#
|
252
255
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationEfsRequest AWS API Documentation
|
253
256
|
#
|
254
257
|
class CreateLocationEfsRequest < Struct.new(
|
255
258
|
:subdirectory,
|
256
259
|
:efs_filesystem_arn,
|
257
260
|
:ec2_config,
|
258
|
-
:tags
|
261
|
+
:tags,
|
262
|
+
:access_point_arn,
|
263
|
+
:file_system_access_role_arn,
|
264
|
+
:in_transit_encryption)
|
259
265
|
SENSITIVE = []
|
260
266
|
include Aws::Structure
|
261
267
|
end
|
@@ -264,7 +270,7 @@ module Aws::DataSync
|
|
264
270
|
#
|
265
271
|
# @!attribute [rw] location_arn
|
266
272
|
# The Amazon Resource Name (ARN) of the Amazon EFS file system
|
267
|
-
# location that
|
273
|
+
# location that you create.
|
268
274
|
# @return [String]
|
269
275
|
#
|
270
276
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationEfsResponse AWS API Documentation
|
@@ -336,6 +342,107 @@ module Aws::DataSync
|
|
336
342
|
include Aws::Structure
|
337
343
|
end
|
338
344
|
|
345
|
+
# @note When making an API call, you may pass CreateLocationFsxOntapRequest
|
346
|
+
# data as a hash:
|
347
|
+
#
|
348
|
+
# {
|
349
|
+
# protocol: { # required
|
350
|
+
# nfs: {
|
351
|
+
# mount_options: {
|
352
|
+
# version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
|
353
|
+
# },
|
354
|
+
# },
|
355
|
+
# smb: {
|
356
|
+
# domain: "SmbDomain",
|
357
|
+
# mount_options: {
|
358
|
+
# version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
|
359
|
+
# },
|
360
|
+
# password: "SmbPassword", # required
|
361
|
+
# user: "SmbUser", # required
|
362
|
+
# },
|
363
|
+
# },
|
364
|
+
# security_group_arns: ["Ec2SecurityGroupArn"], # required
|
365
|
+
# storage_virtual_machine_arn: "StorageVirtualMachineArn", # required
|
366
|
+
# subdirectory: "FsxOntapSubdirectory",
|
367
|
+
# tags: [
|
368
|
+
# {
|
369
|
+
# key: "TagKey", # required
|
370
|
+
# value: "TagValue",
|
371
|
+
# },
|
372
|
+
# ],
|
373
|
+
# }
|
374
|
+
#
|
375
|
+
# @!attribute [rw] protocol
|
376
|
+
# Specifies the data transfer protocol that DataSync uses to access
|
377
|
+
# your Amazon FSx file system.
|
378
|
+
# @return [Types::FsxProtocol]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] security_group_arns
|
381
|
+
# Specifies the Amazon EC2 security groups that provide access to your
|
382
|
+
# file system's preferred subnet.
|
383
|
+
#
|
384
|
+
# The security groups must allow outbound traffic on the following
|
385
|
+
# ports (depending on the protocol you use):
|
386
|
+
#
|
387
|
+
# * **Network File System (NFS)**\: TCP ports 111, 635, and 2049
|
388
|
+
#
|
389
|
+
# * **Server Message Block (SMB)**\: TCP port 445
|
390
|
+
#
|
391
|
+
# Your file system's security groups must also allow inbound traffic
|
392
|
+
# on the same ports.
|
393
|
+
# @return [Array<String>]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] storage_virtual_machine_arn
|
396
|
+
# Specifies the ARN of the storage virtual machine (SVM) on your file
|
397
|
+
# system where you're copying data to or from.
|
398
|
+
# @return [String]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] subdirectory
|
401
|
+
# Specifies the junction path (also known as a mount point) in the SVM
|
402
|
+
# volume where you're copying data to or from (for example, `/vol1`).
|
403
|
+
#
|
404
|
+
# <note markdown="1"> Don't specify a junction path in the SVM's root volume. For more
|
405
|
+
# information, see [Managing FSx for ONTAP storage virtual
|
406
|
+
# machines][1] in the *Amazon FSx for NetApp ONTAP User Guide*.
|
407
|
+
#
|
408
|
+
# </note>
|
409
|
+
#
|
410
|
+
#
|
411
|
+
#
|
412
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html
|
413
|
+
# @return [String]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] tags
|
416
|
+
# Specifies labels that help you categorize, filter, and search for
|
417
|
+
# your Amazon Web Services resources. We recommend creating at least a
|
418
|
+
# name tag for your location.
|
419
|
+
# @return [Array<Types::TagListEntry>]
|
420
|
+
#
|
421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxOntapRequest AWS API Documentation
|
422
|
+
#
|
423
|
+
class CreateLocationFsxOntapRequest < Struct.new(
|
424
|
+
:protocol,
|
425
|
+
:security_group_arns,
|
426
|
+
:storage_virtual_machine_arn,
|
427
|
+
:subdirectory,
|
428
|
+
:tags)
|
429
|
+
SENSITIVE = []
|
430
|
+
include Aws::Structure
|
431
|
+
end
|
432
|
+
|
433
|
+
# @!attribute [rw] location_arn
|
434
|
+
# Specifies the ARN of the FSx for ONTAP file system location that you
|
435
|
+
# create.
|
436
|
+
# @return [String]
|
437
|
+
#
|
438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxOntapResponse AWS API Documentation
|
439
|
+
#
|
440
|
+
class CreateLocationFsxOntapResponse < Struct.new(
|
441
|
+
:location_arn)
|
442
|
+
SENSITIVE = []
|
443
|
+
include Aws::Structure
|
444
|
+
end
|
445
|
+
|
339
446
|
# @note When making an API call, you may pass CreateLocationFsxOpenZfsRequest
|
340
447
|
# data as a hash:
|
341
448
|
#
|
@@ -347,6 +454,14 @@ module Aws::DataSync
|
|
347
454
|
# version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
|
348
455
|
# },
|
349
456
|
# },
|
457
|
+
# smb: {
|
458
|
+
# domain: "SmbDomain",
|
459
|
+
# mount_options: {
|
460
|
+
# version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
|
461
|
+
# },
|
462
|
+
# password: "SmbPassword", # required
|
463
|
+
# user: "SmbUser", # required
|
464
|
+
# },
|
350
465
|
# },
|
351
466
|
# security_group_arns: ["Ec2SecurityGroupArn"], # required
|
352
467
|
# subdirectory: "FsxOpenZfsSubdirectory",
|
@@ -428,32 +543,41 @@ module Aws::DataSync
|
|
428
543
|
# }
|
429
544
|
#
|
430
545
|
# @!attribute [rw] subdirectory
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
434
|
-
# data to the FSx for Windows File Server destination.
|
546
|
+
# Specifies a mount path for your file system using forward slashes.
|
547
|
+
# This is where DataSync reads or writes data (depending on if this is
|
548
|
+
# a source or destination location).
|
435
549
|
# @return [String]
|
436
550
|
#
|
437
551
|
# @!attribute [rw] fsx_filesystem_arn
|
438
|
-
#
|
439
|
-
# file system.
|
552
|
+
# Specifies the Amazon Resource Name (ARN) for the FSx for Windows
|
553
|
+
# File Server file system.
|
440
554
|
# @return [String]
|
441
555
|
#
|
442
556
|
# @!attribute [rw] security_group_arns
|
443
|
-
#
|
444
|
-
#
|
557
|
+
# Specifies the ARNs of the security groups that provide access to
|
558
|
+
# your file system's preferred subnet.
|
559
|
+
#
|
560
|
+
# <note markdown="1"> If you choose a security group that doesn't allow connections from
|
561
|
+
# within itself, do one of the following:
|
562
|
+
#
|
563
|
+
# * Configure the security group to allow it to communicate within
|
564
|
+
# itself.
|
565
|
+
#
|
566
|
+
# * Choose a different security group that can communicate with the
|
567
|
+
# mount target's security group.
|
568
|
+
#
|
569
|
+
# </note>
|
445
570
|
# @return [Array<String>]
|
446
571
|
#
|
447
572
|
# @!attribute [rw] tags
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
# create a name tag for your location.
|
573
|
+
# Specifies labels that help you categorize, filter, and search for
|
574
|
+
# your Amazon Web Services resources. We recommend creating at least a
|
575
|
+
# name tag for your location.
|
452
576
|
# @return [Array<Types::TagListEntry>]
|
453
577
|
#
|
454
578
|
# @!attribute [rw] user
|
455
|
-
#
|
456
|
-
#
|
579
|
+
# Specifies the user who has the permissions to access files and
|
580
|
+
# folders in the file system.
|
457
581
|
#
|
458
582
|
# For information about choosing a user name that ensures sufficient
|
459
583
|
# permissions to files, folders, and metadata, see
|
@@ -461,13 +585,13 @@ module Aws::DataSync
|
|
461
585
|
# @return [String]
|
462
586
|
#
|
463
587
|
# @!attribute [rw] domain
|
464
|
-
#
|
465
|
-
# belongs to.
|
588
|
+
# Specifies the name of the Windows domain that the FSx for Windows
|
589
|
+
# File Server belongs to.
|
466
590
|
# @return [String]
|
467
591
|
#
|
468
592
|
# @!attribute [rw] password
|
469
|
-
#
|
470
|
-
# folders in the
|
593
|
+
# Specifies the password of the user who has the permissions to access
|
594
|
+
# files and folders in the file system.
|
471
595
|
# @return [String]
|
472
596
|
#
|
473
597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsRequest AWS API Documentation
|
@@ -485,8 +609,8 @@ module Aws::DataSync
|
|
485
609
|
end
|
486
610
|
|
487
611
|
# @!attribute [rw] location_arn
|
488
|
-
# The
|
489
|
-
#
|
612
|
+
# The ARN of the FSx for Windows File Server file system location you
|
613
|
+
# created.
|
490
614
|
# @return [String]
|
491
615
|
#
|
492
616
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindowsResponse AWS API Documentation
|
@@ -806,59 +930,53 @@ module Aws::DataSync
|
|
806
930
|
# }
|
807
931
|
#
|
808
932
|
# @!attribute [rw] server_hostname
|
809
|
-
#
|
810
|
-
#
|
811
|
-
# storage server. An agent uses this hostname to mount the object
|
933
|
+
# Specifies the domain name or IP address of the object storage
|
934
|
+
# server. A DataSync agent uses this hostname to mount the object
|
812
935
|
# storage server in a network.
|
813
936
|
# @return [String]
|
814
937
|
#
|
815
938
|
# @!attribute [rw] server_port
|
816
|
-
#
|
817
|
-
#
|
818
|
-
# 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your
|
819
|
-
# self-managed object storage server requires one.
|
939
|
+
# Specifies the port that your object storage server accepts inbound
|
940
|
+
# network traffic on (for example, port 443).
|
820
941
|
# @return [Integer]
|
821
942
|
#
|
822
943
|
# @!attribute [rw] server_protocol
|
823
|
-
#
|
824
|
-
#
|
944
|
+
# Specifies the protocol that your object storage server uses to
|
945
|
+
# communicate.
|
825
946
|
# @return [String]
|
826
947
|
#
|
827
948
|
# @!attribute [rw] subdirectory
|
828
|
-
#
|
829
|
-
#
|
949
|
+
# Specifies the object prefix for your object storage server. If this
|
950
|
+
# is a source location, DataSync only copies objects with this prefix.
|
951
|
+
# If this is a destination location, DataSync writes all objects with
|
952
|
+
# this prefix.
|
830
953
|
# @return [String]
|
831
954
|
#
|
832
955
|
# @!attribute [rw] bucket_name
|
833
|
-
#
|
834
|
-
#
|
956
|
+
# Specifies the name of the object storage bucket involved in the
|
957
|
+
# transfer.
|
835
958
|
# @return [String]
|
836
959
|
#
|
837
960
|
# @!attribute [rw] access_key
|
838
|
-
#
|
839
|
-
#
|
840
|
-
# storage requires a user name and password to authenticate, use
|
841
|
-
# `AccessKey` and `SecretKey` to provide the user name and password,
|
842
|
-
# respectively.
|
961
|
+
# Specifies the access key (for example, a user name) if credentials
|
962
|
+
# are required to authenticate with the object storage server.
|
843
963
|
# @return [String]
|
844
964
|
#
|
845
965
|
# @!attribute [rw] secret_key
|
846
|
-
#
|
847
|
-
#
|
848
|
-
# storage requires a user name and password to authenticate, use
|
849
|
-
# `AccessKey` and `SecretKey` to provide the user name and password,
|
850
|
-
# respectively.
|
966
|
+
# Specifies the secret key (for example, a password) if credentials
|
967
|
+
# are required to authenticate with the object storage server.
|
851
968
|
# @return [String]
|
852
969
|
#
|
853
970
|
# @!attribute [rw] agent_arns
|
854
|
-
#
|
855
|
-
#
|
971
|
+
# Specifies the Amazon Resource Names (ARNs) of the DataSync agents
|
972
|
+
# that can securely connect with your location.
|
856
973
|
# @return [Array<String>]
|
857
974
|
#
|
858
975
|
# @!attribute [rw] tags
|
859
|
-
#
|
860
|
-
# the
|
861
|
-
#
|
976
|
+
# Specifies the key-value pair that represents a tag that you want to
|
977
|
+
# add to the resource. Tags can help you manage, filter, and search
|
978
|
+
# for your resources. We recommend creating a name tag for your
|
979
|
+
# location.
|
862
980
|
# @return [Array<Types::TagListEntry>]
|
863
981
|
#
|
864
982
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationObjectStorageRequest AWS API Documentation
|
@@ -880,8 +998,8 @@ module Aws::DataSync
|
|
880
998
|
# CreateLocationObjectStorageResponse
|
881
999
|
#
|
882
1000
|
# @!attribute [rw] location_arn
|
883
|
-
#
|
884
|
-
#
|
1001
|
+
# Specifies the ARN of the object storage system location that you
|
1002
|
+
# create.
|
885
1003
|
# @return [String]
|
886
1004
|
#
|
887
1005
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationObjectStorageResponse AWS API Documentation
|
@@ -1060,8 +1178,8 @@ module Aws::DataSync
|
|
1060
1178
|
# files and folders in the SMB share.
|
1061
1179
|
#
|
1062
1180
|
# For information about choosing a user name that ensures sufficient
|
1063
|
-
# permissions to files, folders, and metadata, see
|
1064
|
-
#
|
1181
|
+
# permissions to files, folders, and metadata, see the [User
|
1182
|
+
# setting](create-smb-location.html#SMBuser) for SMB locations.
|
1065
1183
|
# @return [String]
|
1066
1184
|
#
|
1067
1185
|
# @!attribute [rw] domain
|
@@ -1424,7 +1542,8 @@ module Aws::DataSync
|
|
1424
1542
|
# }
|
1425
1543
|
#
|
1426
1544
|
# @!attribute [rw] location_arn
|
1427
|
-
# The Amazon Resource Name (ARN) of the EFS
|
1545
|
+
# The Amazon Resource Name (ARN) of the Amazon EFS file system
|
1546
|
+
# location that you want information about.
|
1428
1547
|
# @return [String]
|
1429
1548
|
#
|
1430
1549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfsRequest AWS API Documentation
|
@@ -1438,32 +1557,47 @@ module Aws::DataSync
|
|
1438
1557
|
# DescribeLocationEfsResponse
|
1439
1558
|
#
|
1440
1559
|
# @!attribute [rw] location_arn
|
1441
|
-
# The
|
1442
|
-
# described.
|
1560
|
+
# The ARN of the Amazon EFS file system location.
|
1443
1561
|
# @return [String]
|
1444
1562
|
#
|
1445
1563
|
# @!attribute [rw] location_uri
|
1446
|
-
# The URL of the EFS
|
1564
|
+
# The URL of the Amazon EFS file system location.
|
1447
1565
|
# @return [String]
|
1448
1566
|
#
|
1449
1567
|
# @!attribute [rw] ec2_config
|
1450
|
-
# The subnet that DataSync uses to access
|
1451
|
-
#
|
1452
|
-
# security group that you provide needs to be able to communicate with
|
1453
|
-
# the security group on the mount target in the subnet specified.
|
1568
|
+
# The subnet and security groups that DataSync uses to access your
|
1569
|
+
# Amazon EFS file system.
|
1454
1570
|
# @return [Types::Ec2Config]
|
1455
1571
|
#
|
1456
1572
|
# @!attribute [rw] creation_time
|
1457
|
-
# The time that the
|
1573
|
+
# The time that the location was created.
|
1458
1574
|
# @return [Time]
|
1459
1575
|
#
|
1576
|
+
# @!attribute [rw] access_point_arn
|
1577
|
+
# The ARN of the access point that DataSync uses to access the Amazon
|
1578
|
+
# EFS file system.
|
1579
|
+
# @return [String]
|
1580
|
+
#
|
1581
|
+
# @!attribute [rw] file_system_access_role_arn
|
1582
|
+
# The Identity and Access Management (IAM) role that DataSync assumes
|
1583
|
+
# when mounting the Amazon EFS file system.
|
1584
|
+
# @return [String]
|
1585
|
+
#
|
1586
|
+
# @!attribute [rw] in_transit_encryption
|
1587
|
+
# Describes whether DataSync uses Transport Layer Security (TLS)
|
1588
|
+
# encryption when copying data to or from the Amazon EFS file system.
|
1589
|
+
# @return [String]
|
1590
|
+
#
|
1460
1591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfsResponse AWS API Documentation
|
1461
1592
|
#
|
1462
1593
|
class DescribeLocationEfsResponse < Struct.new(
|
1463
1594
|
:location_arn,
|
1464
1595
|
:location_uri,
|
1465
1596
|
:ec2_config,
|
1466
|
-
:creation_time
|
1597
|
+
:creation_time,
|
1598
|
+
:access_point_arn,
|
1599
|
+
:file_system_access_role_arn,
|
1600
|
+
:in_transit_encryption)
|
1467
1601
|
SENSITIVE = []
|
1468
1602
|
include Aws::Structure
|
1469
1603
|
end
|
@@ -1517,6 +1651,72 @@ module Aws::DataSync
|
|
1517
1651
|
include Aws::Structure
|
1518
1652
|
end
|
1519
1653
|
|
1654
|
+
# @note When making an API call, you may pass DescribeLocationFsxOntapRequest
|
1655
|
+
# data as a hash:
|
1656
|
+
#
|
1657
|
+
# {
|
1658
|
+
# location_arn: "LocationArn", # required
|
1659
|
+
# }
|
1660
|
+
#
|
1661
|
+
# @!attribute [rw] location_arn
|
1662
|
+
# Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file
|
1663
|
+
# system location that you want information about.
|
1664
|
+
# @return [String]
|
1665
|
+
#
|
1666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxOntapRequest AWS API Documentation
|
1667
|
+
#
|
1668
|
+
class DescribeLocationFsxOntapRequest < Struct.new(
|
1669
|
+
:location_arn)
|
1670
|
+
SENSITIVE = []
|
1671
|
+
include Aws::Structure
|
1672
|
+
end
|
1673
|
+
|
1674
|
+
# @!attribute [rw] creation_time
|
1675
|
+
# The time that the location was created.
|
1676
|
+
# @return [Time]
|
1677
|
+
#
|
1678
|
+
# @!attribute [rw] location_arn
|
1679
|
+
# The ARN of the FSx for ONTAP file system location.
|
1680
|
+
# @return [String]
|
1681
|
+
#
|
1682
|
+
# @!attribute [rw] location_uri
|
1683
|
+
# The uniform resource identifier (URI) of the FSx for ONTAP file
|
1684
|
+
# system location.
|
1685
|
+
# @return [String]
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] protocol
|
1688
|
+
# Specifies the data transfer protocol that DataSync uses to access
|
1689
|
+
# your Amazon FSx file system.
|
1690
|
+
# @return [Types::FsxProtocol]
|
1691
|
+
#
|
1692
|
+
# @!attribute [rw] security_group_arns
|
1693
|
+
# The security groups that DataSync uses to access your FSx for ONTAP
|
1694
|
+
# file system.
|
1695
|
+
# @return [Array<String>]
|
1696
|
+
#
|
1697
|
+
# @!attribute [rw] storage_virtual_machine_arn
|
1698
|
+
# The ARN of the storage virtual machine (SVM) on your FSx for ONTAP
|
1699
|
+
# file system where you're copying data to or from.
|
1700
|
+
# @return [String]
|
1701
|
+
#
|
1702
|
+
# @!attribute [rw] fsx_filesystem_arn
|
1703
|
+
# The ARN of the FSx for ONTAP file system.
|
1704
|
+
# @return [String]
|
1705
|
+
#
|
1706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxOntapResponse AWS API Documentation
|
1707
|
+
#
|
1708
|
+
class DescribeLocationFsxOntapResponse < Struct.new(
|
1709
|
+
:creation_time,
|
1710
|
+
:location_arn,
|
1711
|
+
:location_uri,
|
1712
|
+
:protocol,
|
1713
|
+
:security_group_arns,
|
1714
|
+
:storage_virtual_machine_arn,
|
1715
|
+
:fsx_filesystem_arn)
|
1716
|
+
SENSITIVE = []
|
1717
|
+
include Aws::Structure
|
1718
|
+
end
|
1719
|
+
|
1520
1720
|
# @note When making an API call, you may pass DescribeLocationFsxOpenZfsRequest
|
1521
1721
|
# data as a hash:
|
1522
1722
|
#
|
@@ -1797,8 +1997,8 @@ module Aws::DataSync
|
|
1797
1997
|
# }
|
1798
1998
|
#
|
1799
1999
|
# @!attribute [rw] location_arn
|
1800
|
-
# The Amazon Resource Name (ARN) of the
|
1801
|
-
#
|
2000
|
+
# The Amazon Resource Name (ARN) of the object storage system location
|
2001
|
+
# that you want information about.
|
1802
2002
|
# @return [String]
|
1803
2003
|
#
|
1804
2004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorageRequest AWS API Documentation
|
@@ -1812,42 +2012,34 @@ module Aws::DataSync
|
|
1812
2012
|
# DescribeLocationObjectStorageResponse
|
1813
2013
|
#
|
1814
2014
|
# @!attribute [rw] location_arn
|
1815
|
-
# The
|
1816
|
-
# server location to describe.
|
2015
|
+
# The ARN of the object storage system location.
|
1817
2016
|
# @return [String]
|
1818
2017
|
#
|
1819
2018
|
# @!attribute [rw] location_uri
|
1820
|
-
# The URL of the
|
1821
|
-
# that was described.
|
2019
|
+
# The URL of the object storage system location.
|
1822
2020
|
# @return [String]
|
1823
2021
|
#
|
1824
2022
|
# @!attribute [rw] access_key
|
1825
|
-
#
|
1826
|
-
#
|
1827
|
-
# storage requires a user name and password to authenticate, use
|
1828
|
-
# `AccessKey` and `SecretKey` to provide the user name and password,
|
1829
|
-
# respectively.
|
2023
|
+
# The access key (for example, a user name) required to authenticate
|
2024
|
+
# with the object storage server.
|
1830
2025
|
# @return [String]
|
1831
2026
|
#
|
1832
2027
|
# @!attribute [rw] server_port
|
1833
|
-
# The port that your
|
1834
|
-
#
|
1835
|
-
# 80 (HTTP) or TCP 443 (HTTPS).
|
2028
|
+
# The port that your object storage server accepts inbound network
|
2029
|
+
# traffic on (for example, port 443).
|
1836
2030
|
# @return [Integer]
|
1837
2031
|
#
|
1838
2032
|
# @!attribute [rw] server_protocol
|
1839
|
-
# The protocol that
|
1840
|
-
# Valid values are HTTP or HTTPS.
|
2033
|
+
# The protocol that your object storage server uses to communicate.
|
1841
2034
|
# @return [String]
|
1842
2035
|
#
|
1843
2036
|
# @!attribute [rw] agent_arns
|
1844
|
-
# The
|
1845
|
-
#
|
2037
|
+
# The ARNs of the DataSync agents that can securely connect with your
|
2038
|
+
# location.
|
1846
2039
|
# @return [Array<String>]
|
1847
2040
|
#
|
1848
2041
|
# @!attribute [rw] creation_time
|
1849
|
-
# The time that the
|
1850
|
-
# created.
|
2042
|
+
# The time that the location was created.
|
1851
2043
|
# @return [Time]
|
1852
2044
|
#
|
1853
2045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorageResponse AWS API Documentation
|
@@ -2298,10 +2490,8 @@ module Aws::DataSync
|
|
2298
2490
|
include Aws::Structure
|
2299
2491
|
end
|
2300
2492
|
|
2301
|
-
# The subnet that DataSync uses to access
|
2302
|
-
#
|
2303
|
-
# security group that you provide needs to be able to communicate with
|
2304
|
-
# the security group on the mount target in the subnet specified.
|
2493
|
+
# The subnet and security groups that DataSync uses to access your
|
2494
|
+
# Amazon EFS file system.
|
2305
2495
|
#
|
2306
2496
|
# @note When making an API call, you may pass Ec2Config
|
2307
2497
|
# data as a hash:
|
@@ -2312,13 +2502,30 @@ module Aws::DataSync
|
|
2312
2502
|
# }
|
2313
2503
|
#
|
2314
2504
|
# @!attribute [rw] subnet_arn
|
2315
|
-
#
|
2316
|
-
#
|
2505
|
+
# Specifies the ARN of a subnet where DataSync creates the [network
|
2506
|
+
# interfaces][1] for managing traffic during your transfer.
|
2507
|
+
#
|
2508
|
+
# The subnet must be located:
|
2509
|
+
#
|
2510
|
+
# * In the same virtual private cloud (VPC) as the Amazon EFS file
|
2511
|
+
# system.
|
2512
|
+
#
|
2513
|
+
# * In the same Availability Zone as at least one mount target for the
|
2514
|
+
# Amazon EFS file system.
|
2515
|
+
#
|
2516
|
+
# <note markdown="1"> You don't need to specify a subnet that includes a file system
|
2517
|
+
# mount target.
|
2518
|
+
#
|
2519
|
+
# </note>
|
2520
|
+
#
|
2521
|
+
#
|
2522
|
+
#
|
2523
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces
|
2317
2524
|
# @return [String]
|
2318
2525
|
#
|
2319
2526
|
# @!attribute [rw] security_group_arns
|
2320
|
-
#
|
2321
|
-
#
|
2527
|
+
# Specifies the Amazon Resource Names (ARNs) of the security groups
|
2528
|
+
# associated with an Amazon EFS file system's mount target.
|
2322
2529
|
# @return [Array<String>]
|
2323
2530
|
#
|
2324
2531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/Ec2Config AWS API Documentation
|
@@ -2361,8 +2568,8 @@ module Aws::DataSync
|
|
2361
2568
|
include Aws::Structure
|
2362
2569
|
end
|
2363
2570
|
|
2364
|
-
#
|
2365
|
-
#
|
2571
|
+
# Specifies the data transfer protocol that DataSync uses to access your
|
2572
|
+
# Amazon FSx file system.
|
2366
2573
|
#
|
2367
2574
|
# @note When making an API call, you may pass FsxProtocol
|
2368
2575
|
# data as a hash:
|
@@ -2373,23 +2580,39 @@ module Aws::DataSync
|
|
2373
2580
|
# version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
|
2374
2581
|
# },
|
2375
2582
|
# },
|
2583
|
+
# smb: {
|
2584
|
+
# domain: "SmbDomain",
|
2585
|
+
# mount_options: {
|
2586
|
+
# version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
|
2587
|
+
# },
|
2588
|
+
# password: "SmbPassword", # required
|
2589
|
+
# user: "SmbUser", # required
|
2590
|
+
# },
|
2376
2591
|
# }
|
2377
2592
|
#
|
2378
2593
|
# @!attribute [rw] nfs
|
2379
|
-
#
|
2380
|
-
# to access your FSx for OpenZFS file system
|
2594
|
+
# Specifies the Network File System (NFS) protocol configuration that
|
2595
|
+
# DataSync uses to access your FSx for OpenZFS file system or FSx for
|
2596
|
+
# ONTAP file system's storage virtual machine (SVM).
|
2381
2597
|
# @return [Types::FsxProtocolNfs]
|
2382
2598
|
#
|
2599
|
+
# @!attribute [rw] smb
|
2600
|
+
# Specifies the Server Message Block (SMB) protocol configuration that
|
2601
|
+
# DataSync uses to access your FSx for ONTAP file system's SVM.
|
2602
|
+
# @return [Types::FsxProtocolSmb]
|
2603
|
+
#
|
2383
2604
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocol AWS API Documentation
|
2384
2605
|
#
|
2385
2606
|
class FsxProtocol < Struct.new(
|
2386
|
-
:nfs
|
2607
|
+
:nfs,
|
2608
|
+
:smb)
|
2387
2609
|
SENSITIVE = []
|
2388
2610
|
include Aws::Structure
|
2389
2611
|
end
|
2390
2612
|
|
2391
|
-
#
|
2392
|
-
# to access your Amazon FSx for OpenZFS
|
2613
|
+
# Specifies the Network File System (NFS) protocol configuration that
|
2614
|
+
# DataSync uses to access your Amazon FSx for OpenZFS or Amazon FSx for
|
2615
|
+
# NetApp ONTAP file system.
|
2393
2616
|
#
|
2394
2617
|
# @note When making an API call, you may pass FsxProtocolNfs
|
2395
2618
|
# data as a hash:
|
@@ -2401,8 +2624,7 @@ module Aws::DataSync
|
|
2401
2624
|
# }
|
2402
2625
|
#
|
2403
2626
|
# @!attribute [rw] mount_options
|
2404
|
-
#
|
2405
|
-
# access an NFS location.
|
2627
|
+
# Specifies how DataSync can access a location using the NFS protocol.
|
2406
2628
|
# @return [Types::NfsMountOptions]
|
2407
2629
|
#
|
2408
2630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocolNfs AWS API Documentation
|
@@ -2413,6 +2635,85 @@ module Aws::DataSync
|
|
2413
2635
|
include Aws::Structure
|
2414
2636
|
end
|
2415
2637
|
|
2638
|
+
# Specifies the Server Message Block (SMB) protocol configuration that
|
2639
|
+
# DataSync uses to access your Amazon FSx for NetApp ONTAP file system.
|
2640
|
+
# For more information, see [Accessing FSx for ONTAP file systems][1].
|
2641
|
+
#
|
2642
|
+
#
|
2643
|
+
#
|
2644
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access
|
2645
|
+
#
|
2646
|
+
# @note When making an API call, you may pass FsxProtocolSmb
|
2647
|
+
# data as a hash:
|
2648
|
+
#
|
2649
|
+
# {
|
2650
|
+
# domain: "SmbDomain",
|
2651
|
+
# mount_options: {
|
2652
|
+
# version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
|
2653
|
+
# },
|
2654
|
+
# password: "SmbPassword", # required
|
2655
|
+
# user: "SmbUser", # required
|
2656
|
+
# }
|
2657
|
+
#
|
2658
|
+
# @!attribute [rw] domain
|
2659
|
+
# Specifies the fully qualified domain name (FQDN) of the Microsoft
|
2660
|
+
# Active Directory that your storage virtual machine (SVM) belongs to.
|
2661
|
+
# @return [String]
|
2662
|
+
#
|
2663
|
+
# @!attribute [rw] mount_options
|
2664
|
+
# Specifies how DataSync can access a location using the SMB protocol.
|
2665
|
+
# @return [Types::SmbMountOptions]
|
2666
|
+
#
|
2667
|
+
# @!attribute [rw] password
|
2668
|
+
# Specifies the password of a user who has permission to access your
|
2669
|
+
# SVM.
|
2670
|
+
# @return [String]
|
2671
|
+
#
|
2672
|
+
# @!attribute [rw] user
|
2673
|
+
# Specifies a user name that can mount the location and access the
|
2674
|
+
# files, folders, and metadata that you need in the SVM.
|
2675
|
+
#
|
2676
|
+
# If you provide a user in your Active Directory, note the following:
|
2677
|
+
#
|
2678
|
+
# * If you're using Directory Service for Microsoft Active Directory,
|
2679
|
+
# the user must be a member of the Amazon Web Services Delegated FSx
|
2680
|
+
# Administrators group.
|
2681
|
+
#
|
2682
|
+
# * If you're using a self-managed Active Directory, the user must be
|
2683
|
+
# a member of either the Domain Admins group or a custom group that
|
2684
|
+
# you specified for file system administration when you created your
|
2685
|
+
# file system.
|
2686
|
+
#
|
2687
|
+
# Make sure that the user has the permissions it needs to copy the
|
2688
|
+
# data you want:
|
2689
|
+
#
|
2690
|
+
# * `SE_TCB_NAME`\: Required to set object ownership and file
|
2691
|
+
# metadata. With this privilege, you also can copy NTFS
|
2692
|
+
# discretionary access lists (DACLs).
|
2693
|
+
#
|
2694
|
+
# * `SE_SECURITY_NAME`\: May be needed to copy NTFS system access
|
2695
|
+
# control lists (SACLs). This operation specifically requires the
|
2696
|
+
# Windows privilege, which is granted to members of the Domain
|
2697
|
+
# Admins group. If you configure your task to copy SACLs, make sure
|
2698
|
+
# that the user has the required privileges. For information about
|
2699
|
+
# copying SACLs, see [Ownership and permissions-related options][1].
|
2700
|
+
#
|
2701
|
+
#
|
2702
|
+
#
|
2703
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions
|
2704
|
+
# @return [String]
|
2705
|
+
#
|
2706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocolSmb AWS API Documentation
|
2707
|
+
#
|
2708
|
+
class FsxProtocolSmb < Struct.new(
|
2709
|
+
:domain,
|
2710
|
+
:mount_options,
|
2711
|
+
:password,
|
2712
|
+
:user)
|
2713
|
+
SENSITIVE = [:password]
|
2714
|
+
include Aws::Structure
|
2715
|
+
end
|
2716
|
+
|
2416
2717
|
# The NameNode of the Hadoop Distributed File System (HDFS). The
|
2417
2718
|
# NameNode manages the file system's namespace. The NameNode performs
|
2418
2719
|
# operations such as opening, closing, and renaming files and
|
@@ -2768,10 +3069,16 @@ module Aws::DataSync
|
|
2768
3069
|
include Aws::Structure
|
2769
3070
|
end
|
2770
3071
|
|
2771
|
-
#
|
2772
|
-
#
|
2773
|
-
#
|
2774
|
-
# S3
|
3072
|
+
# Narrow down the list of resources returned by `ListLocations`. For
|
3073
|
+
# example, to see all your Amazon S3 locations, create a filter using
|
3074
|
+
# `"Name": "LocationType"`, `"Operator": "Equals"`, and `"Values":
|
3075
|
+
# "S3"`.
|
3076
|
+
#
|
3077
|
+
# For more information, see [filtering resources][1].
|
3078
|
+
#
|
3079
|
+
#
|
3080
|
+
#
|
3081
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
|
2775
3082
|
#
|
2776
3083
|
# @note When making an API call, you may pass LocationFilter
|
2777
3084
|
# data as a hash:
|
@@ -2795,12 +3102,7 @@ module Aws::DataSync
|
|
2795
3102
|
#
|
2796
3103
|
# @!attribute [rw] operator
|
2797
3104
|
# The operator that is used to compare filter values (for example,
|
2798
|
-
# `Equals` or `Contains`).
|
2799
|
-
# [API filters for ListTasks and ListLocations][1].
|
2800
|
-
#
|
2801
|
-
#
|
2802
|
-
#
|
2803
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
|
3105
|
+
# `Equals` or `Contains`).
|
2804
3106
|
# @return [String]
|
2805
3107
|
#
|
2806
3108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/LocationFilter AWS API Documentation
|
@@ -2864,8 +3166,7 @@ module Aws::DataSync
|
|
2864
3166
|
include Aws::Structure
|
2865
3167
|
end
|
2866
3168
|
|
2867
|
-
#
|
2868
|
-
# an NFS location.
|
3169
|
+
# Specifies how DataSync can access a location using the NFS protocol.
|
2869
3170
|
#
|
2870
3171
|
# @note When making an API call, you may pass NfsMountOptions
|
2871
3172
|
# data as a hash:
|
@@ -2875,26 +3176,28 @@ module Aws::DataSync
|
|
2875
3176
|
# }
|
2876
3177
|
#
|
2877
3178
|
# @!attribute [rw] version
|
2878
|
-
#
|
2879
|
-
# NFS share. If the server refuses to use the version
|
2880
|
-
#
|
2881
|
-
#
|
2882
|
-
#
|
3179
|
+
# Specifies the NFS version that you want DataSync to use when
|
3180
|
+
# mounting your NFS share. If the server refuses to use the version
|
3181
|
+
# specified, the task fails.
|
3182
|
+
#
|
3183
|
+
# You can specify the following options:
|
3184
|
+
#
|
3185
|
+
# * `AUTOMATIC` (default): DataSync chooses NFS version 4.1.
|
3186
|
+
#
|
3187
|
+
# * `NFS3`\: Stateless protocol version that allows for asynchronous
|
3188
|
+
# writes on the server.
|
2883
3189
|
#
|
2884
|
-
#
|
3190
|
+
# * `NFSv4_0`\: Stateful, firewall-friendly protocol version that
|
3191
|
+
# supports delegations and pseudo file systems.
|
2885
3192
|
#
|
2886
|
-
# *
|
2887
|
-
#
|
2888
|
-
#
|
3193
|
+
# * `NFSv4_1`\: Stateful protocol version that supports sessions,
|
3194
|
+
# directory delegations, and parallel data processing. NFS version
|
3195
|
+
# 4.1 also includes all features available in version 4.0.
|
2889
3196
|
#
|
2890
|
-
#
|
2891
|
-
#
|
2892
|
-
# delegations and pseudo file systems.
|
3197
|
+
# <note markdown="1"> DataSync currently only supports NFS version 3 with Amazon FSx for
|
3198
|
+
# NetApp ONTAP locations.
|
2893
3199
|
#
|
2894
|
-
#
|
2895
|
-
# - stateful protocol version that supports sessions, directory
|
2896
|
-
# delegations, and parallel data processing. Version 4.1 also
|
2897
|
-
# includes all features available in version 4.0.
|
3200
|
+
# </note>
|
2898
3201
|
# @return [String]
|
2899
3202
|
#
|
2900
3203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/NfsMountOptions AWS API Documentation
|
@@ -2969,20 +3272,20 @@ module Aws::DataSync
|
|
2969
3272
|
# metadata have been transferred. For more information, see [Configure
|
2970
3273
|
# task settings][1].
|
2971
3274
|
#
|
2972
|
-
# Default value:
|
3275
|
+
# Default value: `POINT_IN_TIME_CONSISTENT`
|
2973
3276
|
#
|
2974
|
-
#
|
3277
|
+
# `ONLY_FILES_TRANSFERRED` (recommended): Perform verification only on
|
2975
3278
|
# files that were transferred.
|
2976
3279
|
#
|
2977
|
-
#
|
3280
|
+
# `POINT_IN_TIME_CONSISTENT`\: Scan the entire source and entire
|
2978
3281
|
# destination at the end of the transfer to verify that source and
|
2979
3282
|
# destination are fully synchronized. This option isn't supported
|
2980
3283
|
# when transferring to S3 Glacier Flexible Retrieval or S3 Glacier
|
2981
3284
|
# Deep Archive storage classes.
|
2982
3285
|
#
|
2983
|
-
# NONE
|
2984
|
-
# but all data transmissions are integrity-checked with
|
2985
|
-
# verification during the transfer.
|
3286
|
+
# `NONE`\: No additional verification is done at the end of the
|
3287
|
+
# transfer, but all data transmissions are integrity-checked with
|
3288
|
+
# checksum verification during the transfer.
|
2986
3289
|
#
|
2987
3290
|
#
|
2988
3291
|
#
|
@@ -3010,58 +3313,59 @@ module Aws::DataSync
|
|
3010
3313
|
# @!attribute [rw] atime
|
3011
3314
|
# A file metadata value that shows the last time a file was accessed
|
3012
3315
|
# (that is, when the file was read or written to). If you set `Atime`
|
3013
|
-
# to
|
3316
|
+
# to `BEST_EFFORT`, DataSync attempts to preserve the original `Atime`
|
3014
3317
|
# attribute on all source files (that is, the version before the
|
3015
|
-
# PREPARING phase). However, `Atime`'s behavior is not fully
|
3016
|
-
# across platforms, so DataSync can only do this on a
|
3017
|
-
# basis.
|
3318
|
+
# `PREPARING` phase). However, `Atime`'s behavior is not fully
|
3319
|
+
# standard across platforms, so DataSync can only do this on a
|
3320
|
+
# best-effort basis.
|
3018
3321
|
#
|
3019
|
-
# Default value:
|
3322
|
+
# Default value: `BEST_EFFORT`
|
3020
3323
|
#
|
3021
|
-
#
|
3324
|
+
# `BEST_EFFORT`\: Attempt to preserve the per-file `Atime` value
|
3022
3325
|
# (recommended).
|
3023
3326
|
#
|
3024
|
-
# NONE
|
3327
|
+
# `NONE`\: Ignore `Atime`.
|
3025
3328
|
#
|
3026
|
-
# <note markdown="1"> If `Atime` is set to
|
3329
|
+
# <note markdown="1"> If `Atime` is set to `BEST_EFFORT`, `Mtime` must be set to
|
3330
|
+
# `PRESERVE`.
|
3027
3331
|
#
|
3028
|
-
# If `Atime` is set to NONE
|
3332
|
+
# If `Atime` is set to `NONE`, `Mtime` must also be `NONE`.
|
3029
3333
|
#
|
3030
3334
|
# </note>
|
3031
3335
|
# @return [String]
|
3032
3336
|
#
|
3033
3337
|
# @!attribute [rw] mtime
|
3034
3338
|
# A value that indicates the last time that a file was modified (that
|
3035
|
-
# is, a file was written to) before the PREPARING phase. This option
|
3339
|
+
# is, a file was written to) before the `PREPARING` phase. This option
|
3036
3340
|
# is required for cases when you need to run the same task more than
|
3037
3341
|
# one time.
|
3038
3342
|
#
|
3039
3343
|
# Default Value: `PRESERVE`
|
3040
3344
|
#
|
3041
|
-
# PRESERVE
|
3345
|
+
# `PRESERVE`\: Preserve original `Mtime` (recommended)
|
3042
3346
|
#
|
3043
|
-
# NONE
|
3347
|
+
# `NONE`\: Ignore `Mtime`.
|
3044
3348
|
#
|
3045
|
-
# <note markdown="1"> If `Mtime` is set to PRESERVE
|
3349
|
+
# <note markdown="1"> If `Mtime` is set to `PRESERVE`, `Atime` must be set to
|
3350
|
+
# `BEST_EFFORT`.
|
3046
3351
|
#
|
3047
|
-
# If `Mtime` is set to NONE
|
3352
|
+
# If `Mtime` is set to `NONE`, `Atime` must also be set to `NONE`.
|
3048
3353
|
#
|
3049
3354
|
# </note>
|
3050
3355
|
# @return [String]
|
3051
3356
|
#
|
3052
3357
|
# @!attribute [rw] uid
|
3053
|
-
# The POSIX user ID (UID) of the file's owner.
|
3054
|
-
#
|
3055
|
-
#
|
3056
|
-
# DataSync][1].
|
3358
|
+
# The POSIX user ID (UID) of the file's owner.
|
3359
|
+
#
|
3360
|
+
# For more information, see [Metadata copied by DataSync][1].
|
3057
3361
|
#
|
3058
|
-
# Default value:
|
3362
|
+
# Default value: `INT_VALUE`. This preserves the integer value of the
|
3059
3363
|
# ID.
|
3060
3364
|
#
|
3061
|
-
#
|
3365
|
+
# `INT_VALUE`\: Preserve the integer value of UID and group ID (GID)
|
3062
3366
|
# (recommended).
|
3063
3367
|
#
|
3064
|
-
# NONE
|
3368
|
+
# `NONE`\: Ignore UID and GID.
|
3065
3369
|
#
|
3066
3370
|
#
|
3067
3371
|
#
|
@@ -3069,18 +3373,17 @@ module Aws::DataSync
|
|
3069
3373
|
# @return [String]
|
3070
3374
|
#
|
3071
3375
|
# @!attribute [rw] gid
|
3072
|
-
# The POSIX group ID (GID) of the file's owners.
|
3073
|
-
# only be set for NFS, EFS, and S3 locations. For more information
|
3074
|
-
# about what metadata is copied by DataSync, see [Metadata Copied by
|
3075
|
-
# DataSync][1].
|
3376
|
+
# The POSIX group ID (GID) of the file's owners.
|
3076
3377
|
#
|
3077
|
-
#
|
3378
|
+
# For more information, see [Metadata copied by DataSync][1].
|
3379
|
+
#
|
3380
|
+
# Default value: `INT_VALUE`. This preserves the integer value of the
|
3078
3381
|
# ID.
|
3079
3382
|
#
|
3080
|
-
#
|
3383
|
+
# `INT_VALUE`\: Preserve the integer value of user ID (UID) and GID
|
3081
3384
|
# (recommended).
|
3082
3385
|
#
|
3083
|
-
# NONE
|
3386
|
+
# `NONE`\: Ignore UID and GID.
|
3084
3387
|
#
|
3085
3388
|
#
|
3086
3389
|
#
|
@@ -3096,11 +3399,12 @@ module Aws::DataSync
|
|
3096
3399
|
# Amazon S3 storage classes in DataSync ][1] in the *DataSync User
|
3097
3400
|
# Guide*.
|
3098
3401
|
#
|
3099
|
-
# Default value: PRESERVE
|
3402
|
+
# Default value: `PRESERVE`
|
3100
3403
|
#
|
3101
|
-
# PRESERVE
|
3404
|
+
# `PRESERVE`\: Ignore such destination files (recommended).
|
3102
3405
|
#
|
3103
|
-
# REMOVE
|
3406
|
+
# `REMOVE`\: Delete destination files that aren’t present in the
|
3407
|
+
# source.
|
3104
3408
|
#
|
3105
3409
|
#
|
3106
3410
|
#
|
@@ -3119,26 +3423,26 @@ module Aws::DataSync
|
|
3119
3423
|
#
|
3120
3424
|
# </note>
|
3121
3425
|
#
|
3122
|
-
# Default value: NONE
|
3426
|
+
# Default value: `NONE`
|
3123
3427
|
#
|
3124
|
-
# NONE
|
3428
|
+
# `NONE`\: Ignore special devices (recommended).
|
3125
3429
|
#
|
3126
|
-
# PRESERVE
|
3127
|
-
# isn't currently supported for Amazon EFS.
|
3430
|
+
# `PRESERVE`\: Preserve character and block device metadata. This
|
3431
|
+
# option isn't currently supported for Amazon EFS.
|
3128
3432
|
# @return [String]
|
3129
3433
|
#
|
3130
3434
|
# @!attribute [rw] posix_permissions
|
3131
3435
|
# A value that determines which users or groups can access a file for
|
3132
3436
|
# a specific purpose such as reading, writing, or execution of the
|
3133
|
-
# file.
|
3134
|
-
#
|
3135
|
-
# [Metadata
|
3437
|
+
# file.
|
3438
|
+
#
|
3439
|
+
# For more information, see [Metadata copied by DataSync][1].
|
3136
3440
|
#
|
3137
|
-
# Default value: PRESERVE
|
3441
|
+
# Default value: `PRESERVE`
|
3138
3442
|
#
|
3139
|
-
# PRESERVE
|
3443
|
+
# `PRESERVE`\: Preserve POSIX-style permissions (recommended).
|
3140
3444
|
#
|
3141
|
-
# NONE
|
3445
|
+
# `NONE`\: Ignore permissions.
|
3142
3446
|
#
|
3143
3447
|
# <note markdown="1"> DataSync can preserve extant permissions of a source location.
|
3144
3448
|
#
|
@@ -3189,12 +3493,13 @@ module Aws::DataSync
|
|
3189
3493
|
# location, or whether DataSync transfers all the content from the
|
3190
3494
|
# source, without comparing to the destination location.
|
3191
3495
|
#
|
3192
|
-
# CHANGED
|
3496
|
+
# `CHANGED`\: DataSync copies only data or metadata that is new or
|
3193
3497
|
# different content from the source location to the destination
|
3194
3498
|
# location.
|
3195
3499
|
#
|
3196
|
-
# ALL
|
3197
|
-
# without comparing to existing content on the
|
3500
|
+
# `ALL`\: DataSync copies all source location content to the
|
3501
|
+
# destination, without comparing to existing content on the
|
3502
|
+
# destination.
|
3198
3503
|
# @return [String]
|
3199
3504
|
#
|
3200
3505
|
# @!attribute [rw] security_descriptor_copy_flags
|
@@ -3207,10 +3512,10 @@ module Aws::DataSync
|
|
3207
3512
|
# handles metadata, see [How DataSync Handles Metadata and Special
|
3208
3513
|
# Files][1].
|
3209
3514
|
#
|
3210
|
-
# Default value:
|
3515
|
+
# Default value: `OWNER_DACL`
|
3211
3516
|
#
|
3212
|
-
#
|
3213
|
-
#
|
3517
|
+
# `OWNER_DACL`\: For each copied object, DataSync copies the following
|
3518
|
+
# metadata:
|
3214
3519
|
#
|
3215
3520
|
# * Object owner.
|
3216
3521
|
#
|
@@ -3221,7 +3526,7 @@ module Aws::DataSync
|
|
3221
3526
|
# access control lists (SACLs), which are used by administrators to
|
3222
3527
|
# log attempts to access a secured object.
|
3223
3528
|
#
|
3224
|
-
#
|
3529
|
+
# `OWNER_DACL_SACL`\: For each copied object, DataSync copies the
|
3225
3530
|
# following metadata:
|
3226
3531
|
#
|
3227
3532
|
# * Object owner.
|
@@ -3238,10 +3543,10 @@ module Aws::DataSync
|
|
3238
3543
|
# permissions to files, folders, and metadata, see
|
3239
3544
|
# [user](create-smb-location.html#SMBuser).
|
3240
3545
|
#
|
3241
|
-
#
|
3242
|
-
#
|
3243
|
-
#
|
3244
|
-
#
|
3546
|
+
# `NONE`\: None of the SMB security descriptor components are copied.
|
3547
|
+
# Destination objects are owned by the user that was provided for
|
3548
|
+
# accessing the destination location. DACLs and SACLs are set based on
|
3549
|
+
# the destination server’s configuration.
|
3245
3550
|
#
|
3246
3551
|
#
|
3247
3552
|
#
|
@@ -3378,8 +3683,7 @@ module Aws::DataSync
|
|
3378
3683
|
include Aws::Structure
|
3379
3684
|
end
|
3380
3685
|
|
3381
|
-
#
|
3382
|
-
# an SMB location.
|
3686
|
+
# Specifies how DataSync can access a location using the SMB protocol.
|
3383
3687
|
#
|
3384
3688
|
# @note When making an API call, you may pass SmbMountOptions
|
3385
3689
|
# data as a hash:
|
@@ -3389,10 +3693,10 @@ module Aws::DataSync
|
|
3389
3693
|
# }
|
3390
3694
|
#
|
3391
3695
|
# @!attribute [rw] version
|
3392
|
-
#
|
3393
|
-
# SMB share. If you don't specify a version, DataSync
|
3394
|
-
# `AUTOMATIC
|
3395
|
-
#
|
3696
|
+
# Specifies the SMB version that you want DataSync to use when
|
3697
|
+
# mounting your SMB share. If you don't specify a version, DataSync
|
3698
|
+
# defaults to `AUTOMATIC` and chooses a version based on negotiation
|
3699
|
+
# with the SMB server.
|
3396
3700
|
# @return [String]
|
3397
3701
|
#
|
3398
3702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/SmbMountOptions AWS API Documentation
|
@@ -3666,6 +3970,12 @@ module Aws::DataSync
|
|
3666
3970
|
# location, you can use `ListTasks` with filter name `LocationId` and
|
3667
3971
|
# `Operator Equals` with the ARN for the location.
|
3668
3972
|
#
|
3973
|
+
# For more information, see [filtering DataSync resources][1].
|
3974
|
+
#
|
3975
|
+
#
|
3976
|
+
#
|
3977
|
+
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
|
3978
|
+
#
|
3669
3979
|
# @note When making an API call, you may pass TaskFilter
|
3670
3980
|
# data as a hash:
|
3671
3981
|
#
|
@@ -3688,12 +3998,7 @@ module Aws::DataSync
|
|
3688
3998
|
#
|
3689
3999
|
# @!attribute [rw] operator
|
3690
4000
|
# The operator that is used to compare filter values (for example,
|
3691
|
-
# `Equals` or `Contains`).
|
3692
|
-
# [API filters for ListTasks and ListLocations][1].
|
3693
|
-
#
|
3694
|
-
#
|
3695
|
-
#
|
3696
|
-
# [1]: https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html
|
4001
|
+
# `Equals` or `Contains`).
|
3697
4002
|
# @return [String]
|
3698
4003
|
#
|
3699
4004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TaskFilter AWS API Documentation
|
@@ -4005,8 +4310,7 @@ module Aws::DataSync
|
|
4005
4310
|
# @return [Types::OnPremConfig]
|
4006
4311
|
#
|
4007
4312
|
# @!attribute [rw] mount_options
|
4008
|
-
#
|
4009
|
-
# access an NFS location.
|
4313
|
+
# Specifies how DataSync can access a location using the NFS protocol.
|
4010
4314
|
# @return [Types::NfsMountOptions]
|
4011
4315
|
#
|
4012
4316
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationNfsRequest AWS API Documentation
|
@@ -4165,8 +4469,7 @@ module Aws::DataSync
|
|
4165
4469
|
# @return [Array<String>]
|
4166
4470
|
#
|
4167
4471
|
# @!attribute [rw] mount_options
|
4168
|
-
#
|
4169
|
-
# access an SMB location.
|
4472
|
+
# Specifies how DataSync can access a location using the SMB protocol.
|
4170
4473
|
# @return [Types::SmbMountOptions]
|
4171
4474
|
#
|
4172
4475
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmbRequest AWS API Documentation
|