Options

class Options

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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val atime: Atime?

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

Link copied to clipboard

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

Link copied to clipboard
val gid: Gid?

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

Link copied to clipboard

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

Link copied to clipboard
val mtime: Mtime?

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val uid: Uid?

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: Options.Builder.() -> Unit = {}): Options
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String