Class: Aws::DataSync::Types::Options

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-datasync/types.rb

Overview

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

Each option has a default value. Unless you need to, you don’t have to configure any option before calling [StartTaskExecution].

You also can override your task options for each task execution. For example, you might want to adjust the ‘LogLevel` for an individual execution.

[1]: docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#atime ⇒ String

Specifies whether to preserve metadata indicating the last time a file was read or written to.

<note markdown=“1”> The behavior of ‘Atime` isn’t fully standard across platforms, so DataSync can only do this on a best-effort basis.

</note>

  • ‘BEST_EFFORT` (default) - DataSync attempts to preserve the original `Atime` attribute on all source files (that is, the version before the `PREPARING` steps of the task execution). This option is recommended.

  • ‘NONE` - Ignores `Atime`.

<note markdown=“1”> If ‘Atime` is set to `BEST_EFFORT`, `Mtime` must be set to `PRESERVE`.

If `Atime` is set to `NONE`, `Mtime` must also be `NONE`.

</note>

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#bytes_per_second ⇒ Integer

Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to ‘1048576` (`=1024*1024`).

<note markdown=“1”> Not applicable to [Enhanced mode tasks].

</note>

[1]: docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html

Returns:

  • (Integer) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#gid ⇒ String

Specifies the POSIX group ID (GID) of the file’s owners.

  • ‘INT_VALUE` (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.

  • ‘NONE` - Ignores UID and GID.

For more information, see [Understanding how DataSync handles file and object metadata].

[1]: docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#log_level ⇒ String

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn].

  • ‘BASIC` - Publishes logs with only basic information (such as transfer errors).

  • ‘TRANSFER` - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.

  • ‘OFF` - No logs are published.

[1]: docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#mtime ⇒ String

Specifies whether to preserve metadata indicating the last time that a file was written to before the ‘PREPARING` step of your task execution. This option is required when you need to run the a task more than once.

  • ‘PRESERVE` (default) - Preserves original `Mtime`, which is recommended.

  • ‘NONE` - Ignores `Mtime`.

<note markdown=“1”> If ‘Mtime` is set to `PRESERVE`, `Atime` must be set to `BEST_EFFORT`.

If `Mtime` is set to `NONE`, `Atime` must also be set to `NONE`.

</note>

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#object_tags ⇒ String

Specifies whether you want DataSync to ‘PRESERVE` object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value.

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#overwrite_mode ⇒ String

Specifies whether DataSync should modify or preserve data at the destination location.

  • ‘ALWAYS` (default) - DataSync modifies data in the destination location when source data (including metadata) has changed.

    If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see [Storage class considerations with Amazon S3 transfers].

  • ‘NEVER` - DataSync doesn’t overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.

[1]: docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#posix_permissions ⇒ String

Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

For more information, see [Understanding how DataSync handles file and object metadata].

  • ‘PRESERVE` (default) - Preserves POSIX-style permissions, which is recommended.

  • ‘NONE` - Ignores POSIX-style permissions.

<note markdown=“1”> DataSync can preserve extant permissions of a source location.

</note>

[1]: docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#preserve_deleted_files ⇒ String

Specifies whether files in the destination location that don’t exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see [Considerations when working with Amazon S3 storage classes in DataSync].

  • ‘PRESERVE` (default) - Ignores such destination files, which is recommended.

  • ‘REMOVE` - Deletes destination files that aren’t present in the source.

<note markdown=“1”> If you set this parameter to ‘REMOVE`, you can’t set ‘TransferMode` to `ALL`. When you transfer all data, DataSync doesn’t scan your destination location and doesn’t know what to delete.

</note>

[1]: docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#preserve_devices ⇒ String

Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

<note markdown=“1”> DataSync can’t copy the actual contents of these devices because they’re nonterminal and don’t return an end-of-file (EOF) marker.

</note>

  • ‘NONE` (default) - Ignores special devices (recommended).

  • ‘PRESERVE` - Preserves character and block device metadata. This option currently isn’t supported for Amazon EFS.

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#security_descriptor_copy_flags ⇒ String

Specifies which components of the SMB security descriptor are copied from source to destination objects.

This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see [Understanding how DataSync handles file and object metadata].

  • ‘OWNER_DACL` (default) - For each copied object, DataSync copies the following metadata:

    • The object owner.

    • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

      DataSync won’t copy NTFS system access control lists (SACLs) with this option.

  • ‘OWNER_DACL_SACL` - For each copied object, DataSync copies the following metadata:

    • The object owner.

    • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

    • SACLs, which are used by administrators to log attempts to access a secured object.

      Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user with the right permissions, see required permissions for [SMB], [FSx for Windows File Server], or [FSx for ONTAP] (depending on the type of location in your transfer).

  • ‘NONE` - None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.

[1]: docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html [2]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions [3]: docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions [4]: docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#task_queueing ⇒ String

Specifies whether your transfer tasks should be put into a queue during certain scenarios when [running multiple tasks]. This is ‘ENABLED` by default.

[1]: docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#transfer_mode ⇒ String

Specifies whether DataSync transfers only the data (including metadata) that differs between locations following an initial copy or transfers all data every time you run the task. If you’re planning on recurring transfers, you might only want to transfer what’s changed since your previous task execution.

  • ‘CHANGED` (default) - After your initial full transfer, DataSync copies only the data and metadata that differs between the source and destination location.

  • ‘ALL` - DataSync copies everything in the source to the destination without comparing differences between the locations.

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#uid ⇒ String

Specifies the POSIX user ID (UID) of the file’s owner.

  • ‘INT_VALUE` (default) - Preserves the integer value of UID and group ID (GID), which is recommended.

  • ‘NONE` - Ignores UID and GID.

For more information, see [Metadata copied by DataSync].

[1]: docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end

#verify_mode ⇒ String

Specifies if and how DataSync checks the integrity of your data at the end of your transfer.

  • ‘ONLY_FILES_TRANSFERRED` (recommended) - DataSync calculates the checksum of transferred data (including metadata) at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on that data at the destination.

    <note markdown=“1”> This is the default option for [Enhanced mode tasks].

    </note>

    We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see [Storage class considerations with Amazon S3 locations].

  • ‘POINT_IN_TIME_CONSISTENT` - At the end of the transfer, DataSync checks the entire source and destination to verify that both locations are fully synchronized.

    <note markdown=“1”> The is the default option for [Basic mode tasks] and isn’t currently supported with Enhanced mode tasks.

    </note>

    If you use a [manifest], DataSync only scans and verifies what’s listed in the manifest.

    You can’t use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see [Storage class considerations with Amazon S3 locations].

  • ‘NONE` - DataSync performs data integrity checks only during your transfer. Unlike other options, there’s no additional verification at the end of your transfer.

[1]: docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html [2]: docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes [3]: docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
 
# File 'lib/aws-sdk-datasync/types.rb', line 4782

class Options < Struct.new(
  :verify_mode,
  :overwrite_mode,
  :atime,
  :mtime,
  :uid,
  :gid,
  :preserve_deleted_files,
  :preserve_devices,
  :posix_permissions,
  :bytes_per_second,
  :task_queueing,
  :log_level,
  :transfer_mode,
  :security_descriptor_copy_flags,
  :object_tags)
  SENSITIVE = []
  include Aws::Structure
end