AWS::DataSync::Task

DataSync Task

Resource schema for AWS::DataSync::Task.

Properties

12 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`DestinationLocationArn`	`string`	RequiredCreate-only
`SourceLocationArn`	`string`	RequiredCreate-only
`CloudWatchLogGroupArn`	`string`
`Excludes`	`Array<FilterRule>`
`Includes`	`Array<FilterRule>`
`ManifestConfig`	`ManifestConfig`
`Name`	`string`
`Options`	`Options`
`Schedule`	`TaskSchedule`
`Tags`	`Array<Tag>`
`TaskMode`	`string`	Create-only
`TaskReportConfig`	`TaskReportConfig`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`DestinationNetworkInterfaceArns`	`array`	-
`SourceNetworkInterfaceArns`	`array`	-
`Status`	`string`	The status of the task that was described.
`TaskArn`	`string`	The ARN of the task.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DataSync::Task

Resources:
  MyResource:
    Type: AWS::DataSync::Task
    Properties:
      DestinationLocationArn: "arn:aws:service:region:account:resource"
      SourceLocationArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

datasync:CreateTaskdatasync:DescribeTaskdatasync:ListTagsForResourcedatasync:TagResources3:ListAllMyBucketss3:ListBuckets3:GetObjects3:GetObjectVersion

read

datasync:DescribeTaskdatasync:ListTagsForResource

update

datasync:UpdateTaskdatasync:DescribeTaskdatasync:ListTagsForResourcedatasync:TagResourcedatasync:UntagResourcelogs:DescribeLogGroupsiam:PassRole

delete

datasync:DeleteTaskec2:DescribeNetworkInterfacesec2:DeleteNetworkInterfaceec2:DescribeSecurityGroupsec2:DescribeSubnetsfsx:DescribeFileSystemselasticfilesystem:DescribeFileSystemselasticfilesystem:DescribeMountTargets

list

datasync:ListTasks

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceDataSync

Properties16

Required2

TaggingSupported

Primary IDTaskArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DestinationLocationArnSourceLocationArnTaskMode

Related Resources

External Links

AWS Documentation