TaskOptions

data class TaskOptions(val atime: String? = null, val bytesPerSecond: Int? = null, val gid: String? = null, val logLevel: String? = null, val mtime: String? = null, val overwriteMode: String? = null, val posixPermissions: String? = null, val preserveDeletedFiles: String? = null, val preserveDevices: String? = null, val securityDescriptorCopyFlags: String? = null, val taskQueueing: String? = null, val transferMode: String? = null, val uid: String? = null, val verifyMode: String? = null)

Constructors

Link copied to clipboard
constructor(atime: String? = null, bytesPerSecond: Int? = null, gid: String? = null, logLevel: String? = null, mtime: String? = null, overwriteMode: String? = null, posixPermissions: String? = null, preserveDeletedFiles: String? = null, preserveDevices: String? = null, securityDescriptorCopyFlags: String? = null, taskQueueing: String? = null, transferMode: String? = null, uid: String? = null, verifyMode: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val atime: String? = null

A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.

Link copied to clipboard
val bytesPerSecond: Int? = null

Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).

Link copied to clipboard
val gid: String? = null

Group identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).

Link copied to clipboard
val logLevel: String? = null

Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: OFF, BASIC, TRANSFER. Default: OFF.

Link copied to clipboard
val mtime: String? = null

A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.

Link copied to clipboard
val overwriteMode: String? = null

Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: ALWAYS, NEVER. Default: ALWAYS.

Link copied to clipboard

Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: NONE, PRESERVE. Default: PRESERVE.

Link copied to clipboard

Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.

Link copied to clipboard
val preserveDevices: String? = null

Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).

Link copied to clipboard

Determines 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 Amazon FSx for Windows File Server locations. Valid values: NONE, OWNER_DACL, OWNER_DACL_SACL.

Link copied to clipboard
val taskQueueing: String? = null

Determines whether tasks should be queued before executing the tasks. Valid values: ENABLED, DISABLED. Default ENABLED.

Link copied to clipboard
val transferMode: String? = null

Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Valid values: CHANGED, ALL. Default: CHANGED

Link copied to clipboard
val uid: String? = null

User identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).

Link copied to clipboard
val verifyMode: String? = null

Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED. Default: POINT_IN_TIME_CONSISTENT.