AWS::DataSync::Task Options - AWS CloudFormation

AWS::DataSync::Task Options

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Atime" : String, "BytesPerSecond" : Integer, "Gid" : String, "LogLevel" : String, "Mtime" : String, "OverwriteMode" : String, "PosixPermissions" : String, "PreserveDeletedFiles" : String, "PreserveDevices" : String, "SecurityDescriptorCopyFlags" : String, "TaskQueueing" : String, "TransferMode" : String, "Uid" : String, "VerifyMode" : String }

YAML

Atime: String BytesPerSecond: Integer Gid: String LogLevel: String Mtime: String OverwriteMode: String PosixPermissions: String PreserveDeletedFiles: String PreserveDevices: String SecurityDescriptorCopyFlags: String TaskQueueing: String TransferMode: String Uid: String VerifyMode: String

Properties

Atime

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

Note

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

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

Required: No

Type: String

Allowed values: BEST_EFFORT | NONE

Update requires: No interruption

BytesPerSecond

A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

Required: No

Type: Integer

Update requires: No interruption

Gid

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

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NAME: Currently not supported

NONE: Ignore UID and GID.

Required: No

Type: String

Allowed values: BOTH | INT_VALUE | NAME | NONE

Update requires: No interruption

LogLevel

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

Required: No

Type: String

Allowed values: BASIC | OFF | TRANSFER

Update requires: No interruption

Mtime

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

Note

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.

Required: No

Type: String

Allowed values: NONE | PRESERVE

Update requires: No interruption

OverwriteMode

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the AWS DataSync User Guide.

Required: No

Type: String

Allowed values: ALWAYS | NEVER

Update requires: No interruption

PosixPermissions

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

Note

AWS DataSync can preserve extant permissions of a source location.

Required: No

Type: String

Allowed values: NONE | PRESERVE

Update requires: No interruption

PreserveDeletedFiles

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your 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 in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

Required: No

Type: String

Allowed values: PRESERVE | REMOVE

Update requires: No interruption

PreserveDevices

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.

Note

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

Required: No

Type: String

Allowed values: NONE | PRESERVE

Update requires: No interruption

SecurityDescriptorCopyFlags

A value that 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. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.

Default value: OWNER_DACL.

OWNER_DACL: For each copied object, DataSync copies the following metadata:

  • Object owner.

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

When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.

OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:

  • Object owner.

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

  • NTFS system access control lists (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 that ensures sufficient permissions to files, folders, and metadata, see user.

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.

Required: No

Type: String

Allowed values: NONE | OWNER_DACL | OWNER_DACL_SACL

Update requires: No interruption

TaskQueueing

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.

Required: No

Type: String

Allowed values: DISABLED | ENABLED

Update requires: No interruption

TransferMode

A value that 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.

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.

Required: No

Type: String

Allowed values: ALL | CHANGED

Update requires: No interruption

Uid

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

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NAME: Currently not supported

NONE: Ignore UID and GID.

Required: No

Type: String

Allowed values: BOTH | INT_VALUE | NAME | NONE

Update requires: No interruption

VerifyMode

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

Required: No

Type: String

Allowed values: NONE | ONLY_FILES_TRANSFERRED | POINT_IN_TIME_CONSISTENT

Update requires: No interruption