ApiAwsDataSyncTaskOptions Data Model

Options to be used for the AWS DataSync task. Equivalent of com.amazonaws.services.datasync.model.Options, but it might not contain every possible option.

Properties
name data type description
transferMode TransferMode Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's on the destination). For available options see: TransferMode

DEFAULT: CHANGED

verifyMode VerifyMode Specifies how and when DataSync checks the integrity of the data during a transfer. For available verification modes see: VerifyMode

DEFAULT: POINT_IN_TIME_CONSISTENT

overwriteMode OverwriteMode Specifies whether DataSync should modify or preserve data at the destination location. For available overwrite modes see: OverwriteMode

DEFAULT: ALWAYS

preserveAtime boolean Specifies whether to preserve metadata indicating the last time a file was read or written to. The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

DEFAULT: true
This must be set to the same value as preserveMtime.

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

DEFAULT: true
This must be set to the same value as preserveAtime.

preserveUserId boolean Specifies whether to preserve the POSIX user ID (UID) of the file's owner.

DEFAULT: true

preserveGroupId boolean Specifies whether to preserve the POSIX group ID (GID) of the file's owner.

DEFAULT: true

preserveDeletedFiles boolean Specifies whether files in the destination location, that don't exist in the source, should be preserved.

This option can affect the Amazon S3 storage cost. If the task deletes objects, then it might incur minimum storage duration charges for certain storage classes. For detailed information, see: Considerations when working with Amazon S3 storage classes in DataSync.

Note that if this parameter is set to false, then transferMode cannot be set to ALL. When transferring all data, then DataSync doesn't scan the destination location and doesn't know what to delete.

DEFAULT: true

preserveDevices boolean 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.

DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.

DEFAULT: false

preservePosixPermissions boolean Specifies whether DataSync should preserve POSIX-style permissions (which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file).

DEFAULT: true

preserveObjectTags boolean Specifies whether to preserve object tags when transferring between object storage systems.

DEFAULT: true

bytesPerSecond number 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).

DEFAULT: null

taskQueueing boolean Specifies whether the transfer tasks should be put into a queue during certain scenarios when running multiple tasks . Note that this does NOT have effect if DataSync task was created between S3 regions. DataSync task agents needed only if transferring from/to on-prem or other cloud provider.

DEFAULT: true

Example

{
  "transferMode" : "CHANGED",
  "verifyMode" : "POINT_IN_TIME_CONSISTENT",
  "overwriteMode" : "ALWAYS",
  "preserveAtime" : true,
  "preserveMtime" : true,
  "preserveUserId" : true,
  "preserveGroupId" : true,
  "preserveDeletedFiles" : true,
  "preserveDevices" : true,
  "preservePosixPermissions" : true,
  "preserveObjectTags" : true,
  "bytesPerSecond" : 12345,
  "taskQueueing" : true
}