View a markdown version of this page

AWS::DataSync::TaskExecution - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DataSync::TaskExecution

The AWS::DataSync::TaskExecution resource Property description not available. for DataSync.

Syntax

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

JSON

{
  "Type" : "AWS::DataSync::TaskExecution",
  "Properties" : {
      "Tags" : [ Tag, ... ],
      "TaskArn" : String
    }
}

YAML

Type: AWS::DataSync::TaskExecution
Properties:
  Tags: 
    - Tag
  TaskArn: String

Properties

Tags

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: Replacement

TaskArn

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$

Maximum: 128

Update requires: Replacement

Return values

Ref

Fn::GetAtt

BytesCompressed

The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.

BytesTransferred

The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.

BytesWritten

The number of logical bytes that DataSync actually writes to the destination location.

EstimatedBytesToTransfer

The number of logical bytes that DataSync expects to write to the destination location.

EstimatedFilesToDelete

The number of files, objects, and directories that DataSync expects to delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

Note

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in EstimatedFoldersToDelete.

EstimatedFilesToTransfer

The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.

How this gets calculated depends primarily on your task’s transfer mode configuration:

  • If TranserMode is set to CHANGED - The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:

    • Anything that's added or modified at the source location.

    • Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to NEVER).

    • (Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to REMOVE).

  • If TranserMode is set to ALL - The calculation is based only on the items that DataSync finds at the source location.

Note

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in EstimatedFoldersToTransfer.

FilesDeleted

The number of files, objects, and directories that DataSync actually deletes in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

Note

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersDeleted.

FilesPrepared

The number of files or objects that DataSync will attempt to transfer after comparing your source and destination locations.

Note

Applies only to Enhanced mode tasks.

This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.

FilesSkipped

The number of files, objects, and directories that DataSync skips during your transfer.

Note

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersSkipped.

FilesTransferred

The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.

If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution.

Note

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersTransferred.

FilesVerified

The number of files, objects, and directories that DataSync verifies during your transfer.

Note

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersVerified.

StartTime

The time that DataSync sends the request to start the task execution. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.

Status

The status of the task execution.

For detailed information about task execution statuses, see Task execution statuses.

TaskExecutionArn

The ARN of the task execution that you wanted information about. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

TaskMode

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.