AWS::DataSync::Task - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::DataSync::Task

The AWS::DataSync::Task resource specifies a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.

Syntax

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

JSON

{
  "Type" : "AWS::DataSync::Task",
  "Properties" : {
      "CloudWatchLogGroupArn" : String,
      "DestinationLocationArn" : String,
      "Excludes" : [ FilterRule, ... ],
      "Includes" : [ FilterRule, ... ],
      "ManifestConfig" : ManifestConfig,
      "Name" : String,
      "Options" : Options,
      "Schedule" : TaskSchedule,
      "SourceLocationArn" : String,
      "Tags" : [ Tag, ... ],
      "TaskReportConfig" : TaskReportConfig
    }
}

Properties

CloudWatchLogGroupArn

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS DataSync User Guide.

For more information about these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]*:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

Maximum: 562

Update requires: No interruption

DestinationLocationArn

The Amazon Resource Name (ARN) of an AWS storage resource's location.

Required: Yes

Type: String

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

Maximum: 128

Update requires: Replacement

Excludes

Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Required: No

Type: Array of FilterRule

Minimum: 0

Maximum: 1

Update requires: No interruption

Includes

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Required: No

Type: Array of FilterRule

Minimum: 0

Maximum: 1

Update requires: No interruption

ManifestConfig

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

Required: No

Type: ManifestConfig

Update requires: No interruption

Name

The name of a task. This value is a text reference that is used to identify the task in the console.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

Options

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.

Required: No

Type: Options

Update requires: No interruption

Schedule

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

Required: No

Type: TaskSchedule

Update requires: No interruption

SourceLocationArn

The Amazon Resource Name (ARN) of the source location for the task.

Required: Yes

Type: String

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

Maximum: 128

Update requires: Replacement

Tags

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

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: No interruption

TaskReportConfig

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

Required: No

Type: TaskReportConfig

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the location resource ARN. For example:

arn:aws:datasync:us-east-2:111222333444:task/task-07db7abfc326c50s3

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

DestinationNetworkInterfaceArns

The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet.

SourceNetworkInterfaceArns

The ARNs of the source ENIs that were created for your subnet.

Status

The status of the task that was described.

TaskArn

The ARN of the task.

Examples

DataSync Task

The following example specifies a DataSync task using a source and destination location.

JSON


{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Specifies a DataSync task",
    "Resources": {
        "Task": {
            "Type": "AWS::DataSync::Task",
            "Properties": {
                "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3",
                "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-18ec8bcgd437d61t4"
            }
        }
    }
}

YAML


AWSTemplateFormatVersion: 2010-09-09
Description: Specifies a DataSync task
Resources:
  Task:
    Type: AWS::DataSync::Task
    Properties:
      SourceLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3
      DestinationLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-18ec8bcgd437d61t4