aws-sdk-datasync 1.47.0 → 1.48.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -243,8 +243,9 @@ module Aws::DataSync
243
243
  # @return [String]
244
244
  #
245
245
  # @!attribute [rw] in_transit_encryption
246
- # Specifies whether you want DataSync to use TLS encryption when
247
- # transferring data to or from your Amazon EFS file system.
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.
248
249
  #
249
250
  # If you specify an access point using `AccessPointArn` or an IAM role
250
251
  # using `FileSystemAccessRoleArn`, you must set this parameter to
@@ -341,6 +342,106 @@ module Aws::DataSync
341
342
  include Aws::Structure
342
343
  end
343
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 security groups that DataSync can use to access your
382
+ # FSx for ONTAP file system. You must configure the security groups to
383
+ # allow outbound traffic on the following ports (depending on the
384
+ # protocol that you're using):
385
+ #
386
+ # * **Network File System (NFS)**\: TCP port 2049
387
+ #
388
+ # * **Server Message Block (SMB)**\: TCP port 445
389
+ #
390
+ # Your file system's security groups must also allow inbound traffic
391
+ # on the same port.
392
+ # @return [Array<String>]
393
+ #
394
+ # @!attribute [rw] storage_virtual_machine_arn
395
+ # Specifies the ARN of the storage virtual machine (SVM) on your file
396
+ # system where you're copying data to or from.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] subdirectory
400
+ # Specifies the junction path (also known as a mount point) in the SVM
401
+ # volume where you're copying data to or from (for example, `/vol1`).
402
+ #
403
+ # <note markdown="1"> Don't specify a junction path in the SVM's root volume. For more
404
+ # information, see [Managing FSx for ONTAP storage virtual
405
+ # machines][1] in the *Amazon FSx for NetApp ONTAP User Guide*.
406
+ #
407
+ # </note>
408
+ #
409
+ #
410
+ #
411
+ # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html
412
+ # @return [String]
413
+ #
414
+ # @!attribute [rw] tags
415
+ # Specifies labels that help you categorize, filter, and search for
416
+ # your Amazon Web Services resources. We recommend creating at least a
417
+ # name tag for your location.
418
+ # @return [Array<Types::TagListEntry>]
419
+ #
420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxOntapRequest AWS API Documentation
421
+ #
422
+ class CreateLocationFsxOntapRequest < Struct.new(
423
+ :protocol,
424
+ :security_group_arns,
425
+ :storage_virtual_machine_arn,
426
+ :subdirectory,
427
+ :tags)
428
+ SENSITIVE = []
429
+ include Aws::Structure
430
+ end
431
+
432
+ # @!attribute [rw] location_arn
433
+ # Specifies the ARN of the FSx for ONTAP file system location that you
434
+ # create.
435
+ # @return [String]
436
+ #
437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxOntapResponse AWS API Documentation
438
+ #
439
+ class CreateLocationFsxOntapResponse < Struct.new(
440
+ :location_arn)
441
+ SENSITIVE = []
442
+ include Aws::Structure
443
+ end
444
+
344
445
  # @note When making an API call, you may pass CreateLocationFsxOpenZfsRequest
345
446
  # data as a hash:
346
447
  #
@@ -352,6 +453,14 @@ module Aws::DataSync
352
453
  # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
353
454
  # },
354
455
  # },
456
+ # smb: {
457
+ # domain: "SmbDomain",
458
+ # mount_options: {
459
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
460
+ # },
461
+ # password: "SmbPassword", # required
462
+ # user: "SmbUser", # required
463
+ # },
355
464
  # },
356
465
  # security_group_arns: ["Ec2SecurityGroupArn"], # required
357
466
  # subdirectory: "FsxOpenZfsSubdirectory",
@@ -811,59 +920,53 @@ module Aws::DataSync
811
920
  # }
812
921
  #
813
922
  # @!attribute [rw] server_hostname
814
- # The name of the self-managed object storage server. This value is
815
- # the IP address or Domain Name Service (DNS) name of the object
816
- # storage server. An agent uses this hostname to mount the object
923
+ # Specifies the domain name or IP address of the object storage
924
+ # server. A DataSync agent uses this hostname to mount the object
817
925
  # storage server in a network.
818
926
  # @return [String]
819
927
  #
820
928
  # @!attribute [rw] server_port
821
- # The port that your self-managed object storage server accepts
822
- # inbound network traffic on. The server port is set by default to TCP
823
- # 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your
824
- # self-managed object storage server requires one.
929
+ # Specifies the port that your object storage server accepts inbound
930
+ # network traffic on (for example, port 443).
825
931
  # @return [Integer]
826
932
  #
827
933
  # @!attribute [rw] server_protocol
828
- # The protocol that the object storage server uses to communicate.
829
- # Valid values are HTTP or HTTPS.
934
+ # Specifies the protocol that your object storage server uses to
935
+ # communicate.
830
936
  # @return [String]
831
937
  #
832
938
  # @!attribute [rw] subdirectory
833
- # The subdirectory in the self-managed object storage server that is
834
- # used to read data from.
939
+ # Specifies the object prefix for your object storage server. If this
940
+ # is a source location, DataSync only copies objects with this prefix.
941
+ # If this is a destination location, DataSync writes all objects with
942
+ # this prefix.
835
943
  # @return [String]
836
944
  #
837
945
  # @!attribute [rw] bucket_name
838
- # The bucket on the self-managed object storage server that is used to
839
- # read data from.
946
+ # Specifies the name of the object storage bucket involved in the
947
+ # transfer.
840
948
  # @return [String]
841
949
  #
842
950
  # @!attribute [rw] access_key
843
- # Optional. The access key is used if credentials are required to
844
- # access the self-managed object storage server. If your object
845
- # storage requires a user name and password to authenticate, use
846
- # `AccessKey` and `SecretKey` to provide the user name and password,
847
- # respectively.
951
+ # Specifies the access key (for example, a user name) if credentials
952
+ # are required to authenticate with the object storage server.
848
953
  # @return [String]
849
954
  #
850
955
  # @!attribute [rw] secret_key
851
- # Optional. The secret key is used if credentials are required to
852
- # access the self-managed object storage server. If your object
853
- # storage requires a user name and password to authenticate, use
854
- # `AccessKey` and `SecretKey` to provide the user name and password,
855
- # respectively.
956
+ # Specifies the secret key (for example, a password) if credentials
957
+ # are required to authenticate with the object storage server.
856
958
  # @return [String]
857
959
  #
858
960
  # @!attribute [rw] agent_arns
859
- # The Amazon Resource Name (ARN) of the agents associated with the
860
- # self-managed object storage server location.
961
+ # Specifies the Amazon Resource Names (ARNs) of the DataSync agents
962
+ # that can securely connect with your location.
861
963
  # @return [Array<String>]
862
964
  #
863
965
  # @!attribute [rw] tags
864
- # The key-value pair that represents the tag that you want to add to
865
- # the location. The value can be an empty string. We recommend using
866
- # tags to name your resources.
966
+ # Specifies the key-value pair that represents a tag that you want to
967
+ # add to the resource. Tags can help you manage, filter, and search
968
+ # for your resources. We recommend creating a name tag for your
969
+ # location.
867
970
  # @return [Array<Types::TagListEntry>]
868
971
  #
869
972
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationObjectStorageRequest AWS API Documentation
@@ -885,8 +988,8 @@ module Aws::DataSync
885
988
  # CreateLocationObjectStorageResponse
886
989
  #
887
990
  # @!attribute [rw] location_arn
888
- # The Amazon Resource Name (ARN) of the agents associated with the
889
- # self-managed object storage server location.
991
+ # Specifies the ARN of the object storage system location that you
992
+ # create.
890
993
  # @return [String]
891
994
  #
892
995
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationObjectStorageResponse AWS API Documentation
@@ -1065,8 +1168,8 @@ module Aws::DataSync
1065
1168
  # files and folders in the SMB share.
1066
1169
  #
1067
1170
  # For information about choosing a user name that ensures sufficient
1068
- # permissions to files, folders, and metadata, see
1069
- # [user](create-smb-location.html#SMBuser).
1171
+ # permissions to files, folders, and metadata, see the [User
1172
+ # setting](create-smb-location.html#SMBuser) for SMB locations.
1070
1173
  # @return [String]
1071
1174
  #
1072
1175
  # @!attribute [rw] domain
@@ -1471,8 +1574,8 @@ module Aws::DataSync
1471
1574
  # @return [String]
1472
1575
  #
1473
1576
  # @!attribute [rw] in_transit_encryption
1474
- # Whether DataSync uses TLS encryption when transferring data to or
1475
- # from your Amazon EFS file system.
1577
+ # Describes whether DataSync uses Transport Layer Security (TLS)
1578
+ # encryption when copying data to or from the Amazon EFS file system.
1476
1579
  # @return [String]
1477
1580
  #
1478
1581
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfsResponse AWS API Documentation
@@ -1538,6 +1641,72 @@ module Aws::DataSync
1538
1641
  include Aws::Structure
1539
1642
  end
1540
1643
 
1644
+ # @note When making an API call, you may pass DescribeLocationFsxOntapRequest
1645
+ # data as a hash:
1646
+ #
1647
+ # {
1648
+ # location_arn: "LocationArn", # required
1649
+ # }
1650
+ #
1651
+ # @!attribute [rw] location_arn
1652
+ # Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file
1653
+ # system location that you want information about.
1654
+ # @return [String]
1655
+ #
1656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxOntapRequest AWS API Documentation
1657
+ #
1658
+ class DescribeLocationFsxOntapRequest < Struct.new(
1659
+ :location_arn)
1660
+ SENSITIVE = []
1661
+ include Aws::Structure
1662
+ end
1663
+
1664
+ # @!attribute [rw] creation_time
1665
+ # The time that the location was created.
1666
+ # @return [Time]
1667
+ #
1668
+ # @!attribute [rw] location_arn
1669
+ # The ARN of the FSx for ONTAP file system location.
1670
+ # @return [String]
1671
+ #
1672
+ # @!attribute [rw] location_uri
1673
+ # The uniform resource identifier (URI) of the FSx for ONTAP file
1674
+ # system location.
1675
+ # @return [String]
1676
+ #
1677
+ # @!attribute [rw] protocol
1678
+ # Specifies the data transfer protocol that DataSync uses to access
1679
+ # your Amazon FSx file system.
1680
+ # @return [Types::FsxProtocol]
1681
+ #
1682
+ # @!attribute [rw] security_group_arns
1683
+ # The security groups that DataSync uses to access your FSx for ONTAP
1684
+ # file system.
1685
+ # @return [Array<String>]
1686
+ #
1687
+ # @!attribute [rw] storage_virtual_machine_arn
1688
+ # The ARN of the storage virtual machine (SVM) on your FSx for ONTAP
1689
+ # file system where you're copying data to or from.
1690
+ # @return [String]
1691
+ #
1692
+ # @!attribute [rw] fsx_filesystem_arn
1693
+ # The ARN of the FSx for ONTAP file system.
1694
+ # @return [String]
1695
+ #
1696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxOntapResponse AWS API Documentation
1697
+ #
1698
+ class DescribeLocationFsxOntapResponse < Struct.new(
1699
+ :creation_time,
1700
+ :location_arn,
1701
+ :location_uri,
1702
+ :protocol,
1703
+ :security_group_arns,
1704
+ :storage_virtual_machine_arn,
1705
+ :fsx_filesystem_arn)
1706
+ SENSITIVE = []
1707
+ include Aws::Structure
1708
+ end
1709
+
1541
1710
  # @note When making an API call, you may pass DescribeLocationFsxOpenZfsRequest
1542
1711
  # data as a hash:
1543
1712
  #
@@ -1818,8 +1987,8 @@ module Aws::DataSync
1818
1987
  # }
1819
1988
  #
1820
1989
  # @!attribute [rw] location_arn
1821
- # The Amazon Resource Name (ARN) of the self-managed object storage
1822
- # server location that was described.
1990
+ # The Amazon Resource Name (ARN) of the object storage system location
1991
+ # that you want information about.
1823
1992
  # @return [String]
1824
1993
  #
1825
1994
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorageRequest AWS API Documentation
@@ -1833,42 +2002,34 @@ module Aws::DataSync
1833
2002
  # DescribeLocationObjectStorageResponse
1834
2003
  #
1835
2004
  # @!attribute [rw] location_arn
1836
- # The Amazon Resource Name (ARN) of the self-managed object storage
1837
- # server location to describe.
2005
+ # The ARN of the object storage system location.
1838
2006
  # @return [String]
1839
2007
  #
1840
2008
  # @!attribute [rw] location_uri
1841
- # The URL of the source self-managed object storage server location
1842
- # that was described.
2009
+ # The URL of the object storage system location.
1843
2010
  # @return [String]
1844
2011
  #
1845
2012
  # @!attribute [rw] access_key
1846
- # Optional. The access key is used if credentials are required to
1847
- # access the self-managed object storage server. If your object
1848
- # storage requires a user name and password to authenticate, use
1849
- # `AccessKey` and `SecretKey` to provide the user name and password,
1850
- # respectively.
2013
+ # The access key (for example, a user name) required to authenticate
2014
+ # with the object storage server.
1851
2015
  # @return [String]
1852
2016
  #
1853
2017
  # @!attribute [rw] server_port
1854
- # The port that your self-managed object storage server accepts
1855
- # inbound network traffic on. The server port is set by default to TCP
1856
- # 80 (HTTP) or TCP 443 (HTTPS).
2018
+ # The port that your object storage server accepts inbound network
2019
+ # traffic on (for example, port 443).
1857
2020
  # @return [Integer]
1858
2021
  #
1859
2022
  # @!attribute [rw] server_protocol
1860
- # The protocol that the object storage server uses to communicate.
1861
- # Valid values are HTTP or HTTPS.
2023
+ # The protocol that your object storage server uses to communicate.
1862
2024
  # @return [String]
1863
2025
  #
1864
2026
  # @!attribute [rw] agent_arns
1865
- # The Amazon Resource Name (ARN) of the agents associated with the
1866
- # self-managed object storage server location.
2027
+ # The ARNs of the DataSync agents that can securely connect with your
2028
+ # location.
1867
2029
  # @return [Array<String>]
1868
2030
  #
1869
2031
  # @!attribute [rw] creation_time
1870
- # The time that the self-managed object storage server agent was
1871
- # created.
2032
+ # The time that the location was created.
1872
2033
  # @return [Time]
1873
2034
  #
1874
2035
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorageResponse AWS API Documentation
@@ -2397,8 +2558,8 @@ module Aws::DataSync
2397
2558
  include Aws::Structure
2398
2559
  end
2399
2560
 
2400
- # Represents the protocol that DataSync uses to access your Amazon FSx
2401
- # for OpenZFS file system.
2561
+ # Specifies the data transfer protocol that DataSync uses to access your
2562
+ # Amazon FSx file system.
2402
2563
  #
2403
2564
  # @note When making an API call, you may pass FsxProtocol
2404
2565
  # data as a hash:
@@ -2409,23 +2570,39 @@ module Aws::DataSync
2409
2570
  # version: "AUTOMATIC", # accepts AUTOMATIC, NFS3, NFS4_0, NFS4_1
2410
2571
  # },
2411
2572
  # },
2573
+ # smb: {
2574
+ # domain: "SmbDomain",
2575
+ # mount_options: {
2576
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
2577
+ # },
2578
+ # password: "SmbPassword", # required
2579
+ # user: "SmbUser", # required
2580
+ # },
2412
2581
  # }
2413
2582
  #
2414
2583
  # @!attribute [rw] nfs
2415
- # Represents the Network File System (NFS) protocol that DataSync uses
2416
- # to access your FSx for OpenZFS file system.
2584
+ # Specifies the Network File System (NFS) protocol configuration that
2585
+ # DataSync uses to access your FSx for OpenZFS file system or FSx for
2586
+ # ONTAP file system's storage virtual machine (SVM).
2417
2587
  # @return [Types::FsxProtocolNfs]
2418
2588
  #
2589
+ # @!attribute [rw] smb
2590
+ # Specifies the Server Message Block (SMB) protocol configuration that
2591
+ # DataSync uses to access your FSx for ONTAP file system's SVM.
2592
+ # @return [Types::FsxProtocolSmb]
2593
+ #
2419
2594
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocol AWS API Documentation
2420
2595
  #
2421
2596
  class FsxProtocol < Struct.new(
2422
- :nfs)
2597
+ :nfs,
2598
+ :smb)
2423
2599
  SENSITIVE = []
2424
2600
  include Aws::Structure
2425
2601
  end
2426
2602
 
2427
- # Represents the Network File System (NFS) protocol that DataSync uses
2428
- # to access your Amazon FSx for OpenZFS file system.
2603
+ # Specifies the Network File System (NFS) protocol configuration that
2604
+ # DataSync uses to access your Amazon FSx for OpenZFS or Amazon FSx for
2605
+ # NetApp ONTAP file system.
2429
2606
  #
2430
2607
  # @note When making an API call, you may pass FsxProtocolNfs
2431
2608
  # data as a hash:
@@ -2437,8 +2614,7 @@ module Aws::DataSync
2437
2614
  # }
2438
2615
  #
2439
2616
  # @!attribute [rw] mount_options
2440
- # Represents the mount options that are available for DataSync to
2441
- # access an NFS location.
2617
+ # Specifies how DataSync can access a location using the NFS protocol.
2442
2618
  # @return [Types::NfsMountOptions]
2443
2619
  #
2444
2620
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocolNfs AWS API Documentation
@@ -2449,6 +2625,55 @@ module Aws::DataSync
2449
2625
  include Aws::Structure
2450
2626
  end
2451
2627
 
2628
+ # Specifies the Server Message Block (SMB) protocol configuration that
2629
+ # DataSync uses to access your Amazon FSx for NetApp ONTAP file system.
2630
+ # For more information, see [Accessing FSx for ONTAP file systems][1].
2631
+ #
2632
+ #
2633
+ #
2634
+ # [1]: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access
2635
+ #
2636
+ # @note When making an API call, you may pass FsxProtocolSmb
2637
+ # data as a hash:
2638
+ #
2639
+ # {
2640
+ # domain: "SmbDomain",
2641
+ # mount_options: {
2642
+ # version: "AUTOMATIC", # accepts AUTOMATIC, SMB2, SMB3
2643
+ # },
2644
+ # password: "SmbPassword", # required
2645
+ # user: "SmbUser", # required
2646
+ # }
2647
+ #
2648
+ # @!attribute [rw] domain
2649
+ # Specifies the fully qualified domain name (FQDN) of the Microsoft
2650
+ # Active Directory that your storage virtual machine (SVM) belongs to.
2651
+ # @return [String]
2652
+ #
2653
+ # @!attribute [rw] mount_options
2654
+ # Specifies how DataSync can access a location using the SMB protocol.
2655
+ # @return [Types::SmbMountOptions]
2656
+ #
2657
+ # @!attribute [rw] password
2658
+ # Specifies the password of a user who has permission to access your
2659
+ # SVM.
2660
+ # @return [String]
2661
+ #
2662
+ # @!attribute [rw] user
2663
+ # Specifies a user who has permission to access your SVM.
2664
+ # @return [String]
2665
+ #
2666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/FsxProtocolSmb AWS API Documentation
2667
+ #
2668
+ class FsxProtocolSmb < Struct.new(
2669
+ :domain,
2670
+ :mount_options,
2671
+ :password,
2672
+ :user)
2673
+ SENSITIVE = [:password]
2674
+ include Aws::Structure
2675
+ end
2676
+
2452
2677
  # The NameNode of the Hadoop Distributed File System (HDFS). The
2453
2678
  # NameNode manages the file system's namespace. The NameNode performs
2454
2679
  # operations such as opening, closing, and renaming files and
@@ -2900,8 +3125,7 @@ module Aws::DataSync
2900
3125
  include Aws::Structure
2901
3126
  end
2902
3127
 
2903
- # Represents the mount options that are available for DataSync to access
2904
- # an NFS location.
3128
+ # Specifies how DataSync can access a location using the NFS protocol.
2905
3129
  #
2906
3130
  # @note When making an API call, you may pass NfsMountOptions
2907
3131
  # data as a hash:
@@ -2911,26 +3135,28 @@ module Aws::DataSync
2911
3135
  # }
2912
3136
  #
2913
3137
  # @!attribute [rw] version
2914
- # The specific NFS version that you want DataSync to use to mount your
2915
- # NFS share. If the server refuses to use the version specified, the
2916
- # sync will fail. If you don't specify a version, DataSync defaults
2917
- # to `AUTOMATIC`. That is, DataSync automatically selects a version
2918
- # based on negotiation with the NFS server.
3138
+ # Specifies the NFS version that you want DataSync to use when
3139
+ # mounting your NFS share. If the server refuses to use the version
3140
+ # specified, the task fails.
3141
+ #
3142
+ # You can specify the following options:
3143
+ #
3144
+ # * `AUTOMATIC` (default): DataSync chooses NFS version 4.1.
2919
3145
  #
2920
- # You can specify the following NFS versions:
3146
+ # * `NFS3`\: Stateless protocol version that allows for asynchronous
3147
+ # writes on the server.
2921
3148
  #
2922
- # * <b> <a href="https://tools.ietf.org/html/rfc1813">NFSv3</a> </b> -
2923
- # stateless protocol version that allows for asynchronous writes on
2924
- # the server.
3149
+ # * `NFSv4_0`\: Stateful, firewall-friendly protocol version that
3150
+ # supports delegations and pseudo file systems.
2925
3151
  #
2926
- # * <b> <a href="https://tools.ietf.org/html/rfc3530">NFSv4.0</a> </b>
2927
- # - stateful, firewall-friendly protocol version that supports
2928
- # delegations and pseudo file systems.
3152
+ # * `NFSv4_1`\: Stateful protocol version that supports sessions,
3153
+ # directory delegations, and parallel data processing. NFS version
3154
+ # 4.1 also includes all features available in version 4.0.
2929
3155
  #
2930
- # * <b> <a href="https://tools.ietf.org/html/rfc5661">NFSv4.1</a> </b>
2931
- # - stateful protocol version that supports sessions, directory
2932
- # delegations, and parallel data processing. Version 4.1 also
2933
- # includes all features available in version 4.0.
3156
+ # <note markdown="1"> DataSync currently only supports NFS version 3 with Amazon FSx for
3157
+ # NetApp ONTAP locations.
3158
+ #
3159
+ # </note>
2934
3160
  # @return [String]
2935
3161
  #
2936
3162
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/NfsMountOptions AWS API Documentation
@@ -3005,20 +3231,20 @@ module Aws::DataSync
3005
3231
  # metadata have been transferred. For more information, see [Configure
3006
3232
  # task settings][1].
3007
3233
  #
3008
- # Default value: POINT\_IN\_TIME\_CONSISTENT.
3234
+ # Default value: `POINT_IN_TIME_CONSISTENT`
3009
3235
  #
3010
- # ONLY\_FILES\_TRANSFERRED (recommended): Perform verification only on
3236
+ # `ONLY_FILES_TRANSFERRED` (recommended): Perform verification only on
3011
3237
  # files that were transferred.
3012
3238
  #
3013
- # POINT\_IN\_TIME\_CONSISTENT: Scan the entire source and entire
3239
+ # `POINT_IN_TIME_CONSISTENT`\: Scan the entire source and entire
3014
3240
  # destination at the end of the transfer to verify that source and
3015
3241
  # destination are fully synchronized. This option isn't supported
3016
3242
  # when transferring to S3 Glacier Flexible Retrieval or S3 Glacier
3017
3243
  # Deep Archive storage classes.
3018
3244
  #
3019
- # NONE: No additional verification is done at the end of the transfer,
3020
- # but all data transmissions are integrity-checked with checksum
3021
- # verification during the transfer.
3245
+ # `NONE`\: No additional verification is done at the end of the
3246
+ # transfer, but all data transmissions are integrity-checked with
3247
+ # checksum verification during the transfer.
3022
3248
  #
3023
3249
  #
3024
3250
  #
@@ -3046,58 +3272,59 @@ module Aws::DataSync
3046
3272
  # @!attribute [rw] atime
3047
3273
  # A file metadata value that shows the last time a file was accessed
3048
3274
  # (that is, when the file was read or written to). If you set `Atime`
3049
- # to BEST\_EFFORT, DataSync attempts to preserve the original `Atime`
3275
+ # to `BEST_EFFORT`, DataSync attempts to preserve the original `Atime`
3050
3276
  # attribute on all source files (that is, the version before the
3051
- # PREPARING phase). However, `Atime`'s behavior is not fully standard
3052
- # across platforms, so DataSync can only do this on a best-effort
3053
- # basis.
3277
+ # `PREPARING` phase). However, `Atime`'s behavior is not fully
3278
+ # standard across platforms, so DataSync can only do this on a
3279
+ # best-effort basis.
3054
3280
  #
3055
- # Default value: BEST\_EFFORT.
3281
+ # Default value: `BEST_EFFORT`
3056
3282
  #
3057
- # BEST\_EFFORT: Attempt to preserve the per-file `Atime` value
3283
+ # `BEST_EFFORT`\: Attempt to preserve the per-file `Atime` value
3058
3284
  # (recommended).
3059
3285
  #
3060
- # NONE: Ignore `Atime`.
3286
+ # `NONE`\: Ignore `Atime`.
3061
3287
  #
3062
- # <note markdown="1"> If `Atime` is set to BEST\_EFFORT, `Mtime` must be set to PRESERVE.
3288
+ # <note markdown="1"> If `Atime` is set to `BEST_EFFORT`, `Mtime` must be set to
3289
+ # `PRESERVE`.
3063
3290
  #
3064
- # If `Atime` is set to NONE, `Mtime` must also be NONE.
3291
+ # If `Atime` is set to `NONE`, `Mtime` must also be `NONE`.
3065
3292
  #
3066
3293
  # </note>
3067
3294
  # @return [String]
3068
3295
  #
3069
3296
  # @!attribute [rw] mtime
3070
3297
  # A value that indicates the last time that a file was modified (that
3071
- # is, a file was written to) before the PREPARING phase. This option
3298
+ # is, a file was written to) before the `PREPARING` phase. This option
3072
3299
  # is required for cases when you need to run the same task more than
3073
3300
  # one time.
3074
3301
  #
3075
3302
  # Default Value: `PRESERVE`
3076
3303
  #
3077
- # PRESERVE: Preserve original `Mtime` (recommended)
3304
+ # `PRESERVE`\: Preserve original `Mtime` (recommended)
3078
3305
  #
3079
- # NONE: Ignore `Mtime`.
3306
+ # `NONE`\: Ignore `Mtime`.
3080
3307
  #
3081
- # <note markdown="1"> If `Mtime` is set to PRESERVE, `Atime` must be set to BEST\_EFFORT.
3308
+ # <note markdown="1"> If `Mtime` is set to `PRESERVE`, `Atime` must be set to
3309
+ # `BEST_EFFORT`.
3082
3310
  #
3083
- # If `Mtime` is set to NONE, `Atime` must also be set to NONE.
3311
+ # If `Mtime` is set to `NONE`, `Atime` must also be set to `NONE`.
3084
3312
  #
3085
3313
  # </note>
3086
3314
  # @return [String]
3087
3315
  #
3088
3316
  # @!attribute [rw] uid
3089
- # The POSIX user ID (UID) of the file's owner. This option should
3090
- # only be set for NFS, EFS, and S3 locations. To learn more about what
3091
- # metadata is copied by DataSync, see [Metadata Copied by
3092
- # DataSync][1].
3317
+ # The POSIX user ID (UID) of the file's owner.
3318
+ #
3319
+ # For more information, see [Metadata copied by DataSync][1].
3093
3320
  #
3094
- # Default value: INT\_VALUE. This preserves the integer value of the
3321
+ # Default value: `INT_VALUE`. This preserves the integer value of the
3095
3322
  # ID.
3096
3323
  #
3097
- # INT\_VALUE: Preserve the integer value of UID and group ID (GID)
3324
+ # `INT_VALUE`\: Preserve the integer value of UID and group ID (GID)
3098
3325
  # (recommended).
3099
3326
  #
3100
- # NONE: Ignore UID and GID.
3327
+ # `NONE`\: Ignore UID and GID.
3101
3328
  #
3102
3329
  #
3103
3330
  #
@@ -3105,18 +3332,17 @@ module Aws::DataSync
3105
3332
  # @return [String]
3106
3333
  #
3107
3334
  # @!attribute [rw] gid
3108
- # The POSIX group ID (GID) of the file's owners. This option should
3109
- # only be set for NFS, EFS, and S3 locations. For more information
3110
- # about what metadata is copied by DataSync, see [Metadata Copied by
3111
- # DataSync][1].
3335
+ # The POSIX group ID (GID) of the file's owners.
3112
3336
  #
3113
- # Default value: INT\_VALUE. This preserves the integer value of the
3337
+ # For more information, see [Metadata copied by DataSync][1].
3338
+ #
3339
+ # Default value: `INT_VALUE`. This preserves the integer value of the
3114
3340
  # ID.
3115
3341
  #
3116
- # INT\_VALUE: Preserve the integer value of user ID (UID) and GID
3342
+ # `INT_VALUE`\: Preserve the integer value of user ID (UID) and GID
3117
3343
  # (recommended).
3118
3344
  #
3119
- # NONE: Ignore UID and GID.
3345
+ # `NONE`\: Ignore UID and GID.
3120
3346
  #
3121
3347
  #
3122
3348
  #
@@ -3132,11 +3358,12 @@ module Aws::DataSync
3132
3358
  # Amazon S3 storage classes in DataSync ][1] in the *DataSync User
3133
3359
  # Guide*.
3134
3360
  #
3135
- # Default value: PRESERVE.
3361
+ # Default value: `PRESERVE`
3136
3362
  #
3137
- # PRESERVE: Ignore such destination files (recommended).
3363
+ # `PRESERVE`\: Ignore such destination files (recommended).
3138
3364
  #
3139
- # REMOVE: Delete destination files that aren’t present in the source.
3365
+ # `REMOVE`\: Delete destination files that aren’t present in the
3366
+ # source.
3140
3367
  #
3141
3368
  #
3142
3369
  #
@@ -3155,26 +3382,26 @@ module Aws::DataSync
3155
3382
  #
3156
3383
  # </note>
3157
3384
  #
3158
- # Default value: NONE.
3385
+ # Default value: `NONE`
3159
3386
  #
3160
- # NONE: Ignore special devices (recommended).
3387
+ # `NONE`\: Ignore special devices (recommended).
3161
3388
  #
3162
- # PRESERVE: Preserve character and block device metadata. This option
3163
- # isn't currently supported for Amazon EFS.
3389
+ # `PRESERVE`\: Preserve character and block device metadata. This
3390
+ # option isn't currently supported for Amazon EFS.
3164
3391
  # @return [String]
3165
3392
  #
3166
3393
  # @!attribute [rw] posix_permissions
3167
3394
  # A value that determines which users or groups can access a file for
3168
3395
  # a specific purpose such as reading, writing, or execution of the
3169
- # file. This option should only be set for NFS, EFS, and S3 locations.
3170
- # For more information about what metadata is copied by DataSync, see
3171
- # [Metadata Copied by DataSync][1].
3396
+ # file.
3397
+ #
3398
+ # For more information, see [Metadata copied by DataSync][1].
3172
3399
  #
3173
- # Default value: PRESERVE.
3400
+ # Default value: `PRESERVE`
3174
3401
  #
3175
- # PRESERVE: Preserve POSIX-style permissions (recommended).
3402
+ # `PRESERVE`\: Preserve POSIX-style permissions (recommended).
3176
3403
  #
3177
- # NONE: Ignore permissions.
3404
+ # `NONE`\: Ignore permissions.
3178
3405
  #
3179
3406
  # <note markdown="1"> DataSync can preserve extant permissions of a source location.
3180
3407
  #
@@ -3225,12 +3452,13 @@ module Aws::DataSync
3225
3452
  # location, or whether DataSync transfers all the content from the
3226
3453
  # source, without comparing to the destination location.
3227
3454
  #
3228
- # CHANGED: DataSync copies only data or metadata that is new or
3455
+ # `CHANGED`\: DataSync copies only data or metadata that is new or
3229
3456
  # different content from the source location to the destination
3230
3457
  # location.
3231
3458
  #
3232
- # ALL: DataSync copies all source location content to the destination,
3233
- # without comparing to existing content on the destination.
3459
+ # `ALL`\: DataSync copies all source location content to the
3460
+ # destination, without comparing to existing content on the
3461
+ # destination.
3234
3462
  # @return [String]
3235
3463
  #
3236
3464
  # @!attribute [rw] security_descriptor_copy_flags
@@ -3243,10 +3471,10 @@ module Aws::DataSync
3243
3471
  # handles metadata, see [How DataSync Handles Metadata and Special
3244
3472
  # Files][1].
3245
3473
  #
3246
- # Default value: OWNER\_DACL.
3474
+ # Default value: `OWNER_DACL`
3247
3475
  #
3248
- # **OWNER\_DACL**\: For each copied object, DataSync copies the
3249
- # following metadata:
3476
+ # `OWNER_DACL`\: For each copied object, DataSync copies the following
3477
+ # metadata:
3250
3478
  #
3251
3479
  # * Object owner.
3252
3480
  #
@@ -3257,7 +3485,7 @@ module Aws::DataSync
3257
3485
  # access control lists (SACLs), which are used by administrators to
3258
3486
  # log attempts to access a secured object.
3259
3487
  #
3260
- # **OWNER\_DACL\_SACL**\: For each copied object, DataSync copies the
3488
+ # `OWNER_DACL_SACL`\: For each copied object, DataSync copies the
3261
3489
  # following metadata:
3262
3490
  #
3263
3491
  # * Object owner.
@@ -3274,10 +3502,10 @@ module Aws::DataSync
3274
3502
  # permissions to files, folders, and metadata, see
3275
3503
  # [user](create-smb-location.html#SMBuser).
3276
3504
  #
3277
- # **NONE**\: None of the SMB security descriptor components are
3278
- # copied. Destination objects are owned by the user that was provided
3279
- # for accessing the destination location. DACLs and SACLs are set
3280
- # based on the destination server’s configuration.
3505
+ # `NONE`\: None of the SMB security descriptor components are copied.
3506
+ # Destination objects are owned by the user that was provided for
3507
+ # accessing the destination location. DACLs and SACLs are set based on
3508
+ # the destination server’s configuration.
3281
3509
  #
3282
3510
  #
3283
3511
  #
@@ -3414,8 +3642,7 @@ module Aws::DataSync
3414
3642
  include Aws::Structure
3415
3643
  end
3416
3644
 
3417
- # Represents the mount options that are available for DataSync to access
3418
- # an SMB location.
3645
+ # Specifies how DataSync can access a location using the SMB protocol.
3419
3646
  #
3420
3647
  # @note When making an API call, you may pass SmbMountOptions
3421
3648
  # data as a hash:
@@ -3425,10 +3652,10 @@ module Aws::DataSync
3425
3652
  # }
3426
3653
  #
3427
3654
  # @!attribute [rw] version
3428
- # The specific SMB version that you want DataSync to use to mount your
3429
- # SMB share. If you don't specify a version, DataSync defaults to
3430
- # `AUTOMATIC`. That is, DataSync automatically selects a version based
3431
- # on negotiation with the SMB server.
3655
+ # Specifies the SMB version that you want DataSync to use when
3656
+ # mounting your SMB share. If you don't specify a version, DataSync
3657
+ # defaults to `AUTOMATIC` and chooses a version based on negotiation
3658
+ # with the SMB server.
3432
3659
  # @return [String]
3433
3660
  #
3434
3661
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/SmbMountOptions AWS API Documentation
@@ -4041,8 +4268,7 @@ module Aws::DataSync
4041
4268
  # @return [Types::OnPremConfig]
4042
4269
  #
4043
4270
  # @!attribute [rw] mount_options
4044
- # Represents the mount options that are available for DataSync to
4045
- # access an NFS location.
4271
+ # Specifies how DataSync can access a location using the NFS protocol.
4046
4272
  # @return [Types::NfsMountOptions]
4047
4273
  #
4048
4274
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationNfsRequest AWS API Documentation
@@ -4201,8 +4427,7 @@ module Aws::DataSync
4201
4427
  # @return [Array<String>]
4202
4428
  #
4203
4429
  # @!attribute [rw] mount_options
4204
- # Represents the mount options that are available for DataSync to
4205
- # access an SMB location.
4430
+ # Specifies how DataSync can access a location using the SMB protocol.
4206
4431
  # @return [Types::SmbMountOptions]
4207
4432
  #
4208
4433
  # @see http://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmbRequest AWS API Documentation