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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # 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 CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::Task", "Properties" : { "[CloudWatchLogGroupArn](#cfn-datasync-task-cloudwatchloggrouparn)" : String, "[DestinationLocationArn](#cfn-datasync-task-destinationlocationarn)" : String, "[Excludes](#cfn-datasync-task-excludes)" : [ FilterRule, ... ], "[Includes](#cfn-datasync-task-includes)" : [ FilterRule, ... ], "[ManifestConfig](#cfn-datasync-task-manifestconfig)" : ManifestConfig, "[Name](#cfn-datasync-task-name)" : String, "[Options](#cfn-datasync-task-options)" : Options, "[Schedule](#cfn-datasync-task-schedule)" : TaskSchedule, "[SourceLocationArn](#cfn-datasync-task-sourcelocationarn)" : String, "[Tags](#cfn-datasync-task-tags)" : [ Tag, ... ], "[TaskMode](#cfn-datasync-task-taskmode)" : String, "[TaskReportConfig](#cfn-datasync-task-taskreportconfig)" : TaskReportConfig } } ``` ### YAML ``` Type: AWS::DataSync::Task Properties: [CloudWatchLogGroupArn](#cfn-datasync-task-cloudwatchloggrouparn): String [DestinationLocationArn](#cfn-datasync-task-destinationlocationarn): String [Excludes](#cfn-datasync-task-excludes): - FilterRule [Includes](#cfn-datasync-task-includes): - FilterRule [ManifestConfig](#cfn-datasync-task-manifestconfig): ManifestConfig [Name](#cfn-datasync-task-name): String [Options](#cfn-datasync-task-options): Options [Schedule](#cfn-datasync-task-schedule): TaskSchedule [SourceLocationArn](#cfn-datasync-task-sourcelocationarn): String [Tags](#cfn-datasync-task-tags): - Tag [TaskMode](#cfn-datasync-task-taskmode): String [TaskReportConfig](#cfn-datasync-task-taskreportconfig): TaskReportConfig ``` ## Properties `CloudWatchLogGroupArn` Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task. For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named `/aws/datasync`. For more information, see [Monitoring data transfers with CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html). *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]*:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` *Maximum*: `562` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Excludes` Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see [Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). *Required*: No *Type*: Array of [FilterRule](aws-properties-datasync-task-filterrule.md) *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Includes` Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see [Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). *Required*: No *Type*: Array of [FilterRule](aws-properties-datasync-task-filterrule.md) *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManifestConfig` The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html). *Required*: No *Type*: [ManifestConfig](aws-properties-datasync-task-manifestconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` Specifies the name of your task. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Options` Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options. *Required*: No *Type*: [Options](aws-properties-datasync-task-options.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Schedule` Specifies a schedule for when you want your task to run. For more information, see [Scheduling your task](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html). *Required*: No *Type*: [TaskSchedule](aws-properties-datasync-task-taskschedule.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceLocationArn` Specifies the ARN of your transfer's source location. *Required*: Yes *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}:location/loc-[0-9a-z]{17}$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` Specifies the tags that you want to apply to your task. *Tags* are key-value pairs that help you manage, filter, and search for your DataSync resources. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-task-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TaskMode` The task mode that you're using. For more information, see [Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html). *Required*: No *Type*: String *Allowed values*: `BASIC | ENHANCED` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TaskReportConfig` The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html). *Required*: No *Type*: [TaskReportConfig](aws-properties-datasync-task-taskreportconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `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 **Topics** + [Creating an Enhanced mode task](#aws-resource-datasync-task--examples--Creating_an_Enhanced_mode_task) + [Creating a Basic mode task](#aws-resource-datasync-task--examples--Creating_a_Basic_mode_task) ### Creating an Enhanced mode task The following examples create an Enhanced mode task. For more information, see [Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html). #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Creates a DataSync task that uses Enhanced mode", "Resources": { "Task": { "Type": "AWS::DataSync::Task", "Properties": { "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "Name": "My-Enhanced-mode-task", "TaskMode": "ENHANCED", "Options": { "TransferMode": "CHANGED", "VerifyMode": "ONLY_FILES_TRANSFERRED", "ObjectTags": "PRESERVE", "LogLevel": "TRANSFER" } } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Creates a DataSync task that uses Enhanced mode Resources: Task: Type: AWS::DataSync::Task Properties: SourceLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3 DestinationLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2 Name: My-Enhanced-mode-task TaskMode: ENHANCED Options: TransferMode: CHANGED VerifyMode: ONLY_FILES_TRANSFERRED ObjectTags: PRESERVE LogLevel: TRANSFER ``` ### Creating a Basic mode task The following examples create a Basic mode task. For more information, see [Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html). #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Creates a DataSync task that uses Basic mode", "Resources": { "Task": { "Type": "AWS::DataSync::Task", "Properties": { "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "Name": "My-Basic-mode-task", "TaskMode": "BASIC", "Options": { "TransferMode": "CHANGED", "VerifyMode": "POINT_IN_TIME_CONSISTENT", "LogLevel": "TRANSFER" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/my-log-group-name:*" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Creates a DataSync task that uses Basic mode Resources: Task: Type: AWS::DataSync::Task Properties: SourceLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3 DestinationLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2 Name: My-Basic-mode-task TaskMode: BASIC Options: TransferMode: CHANGED VerifyMode: POINT_IN_TIME_CONSISTENT LogLevel: TRANSFER CloudWatchLogGroupArn: arn:aws:logs:us-east-2:111222333444:log-group:/my-log-group-name:* ``` # AWS::DataSync::Task Deleted The `Deleted` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReportLevel](#cfn-datasync-task-deleted-reportlevel)" : String } ``` ### YAML ``` [ReportLevel](#cfn-datasync-task-deleted-reportlevel): String ``` ## Properties `ReportLevel` Property description not available. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Destination The `Destination` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-datasync-task-destination-s3)" : TaskReportConfigDestinationS3 } ``` ### YAML ``` [S3](#cfn-datasync-task-destination-s3): TaskReportConfigDestinationS3 ``` ## Properties `S3` Property description not available. *Required*: No *Type*: [TaskReportConfigDestinationS3](aws-properties-datasync-task-taskreportconfigdestinations3.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task FilterRule Specifies which files, folders, and objects to include or exclude when transferring files from source to destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FilterType](#cfn-datasync-task-filterrule-filtertype)" : String, "[Value](#cfn-datasync-task-filterrule-value)" : String } ``` ### YAML ``` [FilterType](#cfn-datasync-task-filterrule-filtertype): String [Value](#cfn-datasync-task-filterrule-value): String ``` ## Properties `FilterType` The type of filter rule to apply. AWS DataSync only supports the SIMPLE\$1PATTERN rule type. *Required*: No *Type*: String *Allowed values*: `SIMPLE_PATTERN` *Pattern*: `^[A-Z0-9_]+$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "\$1" (that is, a pipe), for example: `/folder1|/folder2` *Required*: No *Type*: String *Pattern*: `^[^\x00]+$` *Maximum*: `409600` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task ManifestConfig Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Action](#cfn-datasync-task-manifestconfig-action)" : String, "[Format](#cfn-datasync-task-manifestconfig-format)" : String, "[Source](#cfn-datasync-task-manifestconfig-source)" : Source } ``` ### YAML ``` [Action](#cfn-datasync-task-manifestconfig-action): String [Format](#cfn-datasync-task-manifestconfig-format): String [Source](#cfn-datasync-task-manifestconfig-source): Source ``` ## Properties `Action` Specifies what DataSync uses the manifest for. *Required*: No *Type*: String *Allowed values*: `TRANSFER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Format` Specifies the file format of your manifest. For more information, see [Creating a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create). *Required*: No *Type*: String *Allowed values*: `CSV` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` Specifies the manifest that you want DataSync to use and where it's hosted. You must specify this parameter if you're configuring a new manifest on or after February 7, 2024. If you don't, you'll get a 400 status code and `ValidationException` error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see [Providing DataSync access to your manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access). *Required*: Yes *Type*: [Source](aws-properties-datasync-task-source.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task ManifestConfigSourceS3 The `ManifestConfigSourceS3` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketAccessRoleArn](#cfn-datasync-task-manifestconfigsources3-bucketaccessrolearn)" : String, "[ManifestObjectPath](#cfn-datasync-task-manifestconfigsources3-manifestobjectpath)" : String, "[ManifestObjectVersionId](#cfn-datasync-task-manifestconfigsources3-manifestobjectversionid)" : String, "[S3BucketArn](#cfn-datasync-task-manifestconfigsources3-s3bucketarn)" : String } ``` ### YAML ``` [BucketAccessRoleArn](#cfn-datasync-task-manifestconfigsources3-bucketaccessrolearn): String [ManifestObjectPath](#cfn-datasync-task-manifestconfigsources3-manifestobjectpath): String [ManifestObjectVersionId](#cfn-datasync-task-manifestconfigsources3-manifestobjectversionid): String [S3BucketArn](#cfn-datasync-task-manifestconfigsources3-s3bucketarn): String ``` ## Properties `BucketAccessRoleArn` Property description not available. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManifestObjectPath` Property description not available. *Required*: No *Type*: String *Pattern*: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManifestObjectVersionId` Property description not available. *Required*: No *Type*: String *Pattern*: `^.+$` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3BucketArn` Property description not available. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$` *Maximum*: `156` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Options Represents the options that are available to control the behavior of a [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) operation. This behavior includes preserving metadata, such as user ID (UID), group ID (GID), and file permissions; 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](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html), the default value is used. You can override the default options on each task execution by specifying an overriding `Options` value to [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Atime](#cfn-datasync-task-options-atime)" : String, "[BytesPerSecond](#cfn-datasync-task-options-bytespersecond)" : Integer, "[Gid](#cfn-datasync-task-options-gid)" : String, "[LogLevel](#cfn-datasync-task-options-loglevel)" : String, "[Mtime](#cfn-datasync-task-options-mtime)" : String, "[ObjectTags](#cfn-datasync-task-options-objecttags)" : String, "[OverwriteMode](#cfn-datasync-task-options-overwritemode)" : String, "[PosixPermissions](#cfn-datasync-task-options-posixpermissions)" : String, "[PreserveDeletedFiles](#cfn-datasync-task-options-preservedeletedfiles)" : String, "[PreserveDevices](#cfn-datasync-task-options-preservedevices)" : String, "[SecurityDescriptorCopyFlags](#cfn-datasync-task-options-securitydescriptorcopyflags)" : String, "[TaskQueueing](#cfn-datasync-task-options-taskqueueing)" : String, "[TransferMode](#cfn-datasync-task-options-transfermode)" : String, "[Uid](#cfn-datasync-task-options-uid)" : String, "[VerifyMode](#cfn-datasync-task-options-verifymode)" : String } ``` ### YAML ``` [Atime](#cfn-datasync-task-options-atime): String [BytesPerSecond](#cfn-datasync-task-options-bytespersecond): Integer [Gid](#cfn-datasync-task-options-gid): String [LogLevel](#cfn-datasync-task-options-loglevel): String [Mtime](#cfn-datasync-task-options-mtime): String [ObjectTags](#cfn-datasync-task-options-objecttags): String [OverwriteMode](#cfn-datasync-task-options-overwritemode): String [PosixPermissions](#cfn-datasync-task-options-posixpermissions): String [PreserveDeletedFiles](#cfn-datasync-task-options-preservedeletedfiles): String [PreserveDevices](#cfn-datasync-task-options-preservedevices): String [SecurityDescriptorCopyFlags](#cfn-datasync-task-options-securitydescriptorcopyflags): String [TaskQueueing](#cfn-datasync-task-options-taskqueueing): String [TransferMode](#cfn-datasync-task-options-transfermode): String [Uid](#cfn-datasync-task-options-uid): String [VerifyMode](#cfn-datasync-task-options-verifymode): String ``` ## Properties `Atime` A file metadata value that shows the last time that a file was accessed (that is, when the file was read or written to). If you set `Atime` to `BEST_EFFORT`, AWS 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`. 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*: `NONE | BEST_EFFORT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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\$11024). *Required*: No *Type*: Integer *Minimum*: `-1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Gid` The group ID (GID) of the file's owners. Default value: `INT_VALUE` `INT_VALUE`: Preserve the integer value of the user ID (UID) and group ID (GID) (recommended). `NAME`: Currently not supported. `NONE`: Ignore the UID and GID. *Required*: No *Type*: String *Allowed values*: `NONE | INT_VALUE | NAME | BOTH` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogLevel` Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn). + `BASIC` - Publishes logs with only basic information (such as transfer errors). + `TRANSFER` - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on. + `OFF` - No logs are published. *Required*: No *Type*: String *Allowed values*: `OFF | BASIC | TRANSFER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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`. 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectTags` 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. *Required*: No *Type*: String *Allowed values*: `PRESERVE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OverwriteMode` Specifies whether DataSync should modify or preserve data at the destination location. + `ALWAYS` (default) - DataSync modifies data in the destination location when source data (including metadata) has changed. If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see [Storage class considerations with Amazon S3 transfers](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). + `NEVER` - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination. *Required*: No *Type*: String *Allowed values*: `ALWAYS | NEVER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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 be set only for Network File System (NFS), Amazon EFS, and Amazon S3 locations. For more information about what metadata is copied by DataSync, see [Metadata Copied by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). Default value: `PRESERVE` `PRESERVE`: Preserve POSIX-style permissions (recommended). `NONE`: Ignore permissions. AWS DataSync can preserve extant permissions of a source location. *Required*: No *Type*: String *Allowed values*: `NONE | PRESERVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PreserveDeletedFiles` A value that specifies whether files in the destination that don't exist in the source file system are preserved. This option can affect your storage costs. 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 ](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) in the *AWS DataSync User Guide*. Default value: `PRESERVE` `PRESERVE`: Ignore destination files that aren't present in the source (recommended). `REMOVE`: Delete destination files that aren't present in the source. *Required*: No *Type*: String *Allowed values*: `PRESERVE | REMOVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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. 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html). 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 you use 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](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#SMBuser). `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TaskQueueing` Specifies whether your transfer tasks should be put into a queue during certain scenarios when [running multiple tasks](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks). This is `ENABLED` by default. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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 it to the destination location. `CHANGED`: DataSync copies only data or metadata that is new or different from the source location to the destination location. `ALL`: DataSync copies all source location content to the destination, without comparing it to existing content on the destination. *Required*: No *Type*: String *Allowed values*: `CHANGED | ALL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Uid` The user ID (UID) of the file's owner. Default value: `INT_VALUE` `INT_VALUE`: Preserve the integer value of the UID and group ID (GID) (recommended). `NAME`: Currently not supported `NONE`: Ignore the UID and GID. *Required*: No *Type*: String *Allowed values*: `NONE | INT_VALUE | NAME | BOTH` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VerifyMode` A value that determines whether a data integrity verification is performed at the end of a task execution after all data and metadata have been transferred. For more information, see [Configure task settings](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html). 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 the 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*: `POINT_IN_TIME_CONSISTENT | ONLY_FILES_TRANSFERRED | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Overrides The `Overrides` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Deleted](#cfn-datasync-task-overrides-deleted)" : Deleted, "[Skipped](#cfn-datasync-task-overrides-skipped)" : Skipped, "[Transferred](#cfn-datasync-task-overrides-transferred)" : Transferred, "[Verified](#cfn-datasync-task-overrides-verified)" : Verified } ``` ### YAML ``` [Deleted](#cfn-datasync-task-overrides-deleted): Deleted [Skipped](#cfn-datasync-task-overrides-skipped): Skipped [Transferred](#cfn-datasync-task-overrides-transferred): Transferred [Verified](#cfn-datasync-task-overrides-verified): Verified ``` ## Properties `Deleted` Property description not available. *Required*: No *Type*: [Deleted](aws-properties-datasync-task-deleted.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Skipped` Property description not available. *Required*: No *Type*: [Skipped](aws-properties-datasync-task-skipped.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Transferred` Property description not available. *Required*: No *Type*: [Transferred](aws-properties-datasync-task-transferred.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Verified` Property description not available. *Required*: No *Type*: [Verified](aws-properties-datasync-task-verified.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Skipped The `Skipped` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReportLevel](#cfn-datasync-task-skipped-reportlevel)" : String } ``` ### YAML ``` [ReportLevel](#cfn-datasync-task-skipped-reportlevel): String ``` ## Properties `ReportLevel` Property description not available. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Source The `Source` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-datasync-task-source-s3)" : ManifestConfigSourceS3 } ``` ### YAML ``` [S3](#cfn-datasync-task-source-s3): ManifestConfigSourceS3 ``` ## Properties `S3` Property description not available. *Required*: No *Type*: [ManifestConfigSourceS3](aws-properties-datasync-task-manifestconfigsources3.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-task-tag-key)" : String, "[Value](#cfn-datasync-task-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-task-tag-key): String [Value](#cfn-datasync-task-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task TaskReportConfig Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer. For more information, see [Task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Destination](#cfn-datasync-task-taskreportconfig-destination)" : Destination, "[ObjectVersionIds](#cfn-datasync-task-taskreportconfig-objectversionids)" : String, "[OutputType](#cfn-datasync-task-taskreportconfig-outputtype)" : String, "[Overrides](#cfn-datasync-task-taskreportconfig-overrides)" : Overrides, "[ReportLevel](#cfn-datasync-task-taskreportconfig-reportlevel)" : String } ``` ### YAML ``` [Destination](#cfn-datasync-task-taskreportconfig-destination): Destination [ObjectVersionIds](#cfn-datasync-task-taskreportconfig-objectversionids): String [OutputType](#cfn-datasync-task-taskreportconfig-outputtype): String [Overrides](#cfn-datasync-task-taskreportconfig-overrides): Overrides [ReportLevel](#cfn-datasync-task-taskreportconfig-reportlevel): String ``` ## Properties `Destination` Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see [Task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access). *Required*: Yes *Type*: [Destination](aws-properties-datasync-task-destination.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectVersionIds` Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you [enable versioning on your bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html). Keep in mind that setting this to `INCLUDE` can increase the duration of your task execution. *Required*: No *Type*: String *Allowed values*: `INCLUDE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputType` Specifies the type of task report that you want: + `SUMMARY_ONLY`: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration. + `STANDARD`: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more. *Required*: Yes *Type*: String *Allowed values*: `SUMMARY_ONLY | STANDARD` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Overrides` Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location. *Required*: No *Type*: [Overrides](aws-properties-datasync-task-overrides.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ReportLevel` Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. + `ERRORS_ONLY`: A report shows what DataSync was unable to transfer, skip, verify, and delete. + `SUCCESSES_AND_ERRORS`: A report shows what DataSync was able and unable to transfer, skip, verify, and delete. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task TaskReportConfigDestinationS3 The `TaskReportConfigDestinationS3` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketAccessRoleArn](#cfn-datasync-task-taskreportconfigdestinations3-bucketaccessrolearn)" : String, "[S3BucketArn](#cfn-datasync-task-taskreportconfigdestinations3-s3bucketarn)" : String, "[Subdirectory](#cfn-datasync-task-taskreportconfigdestinations3-subdirectory)" : String } ``` ### YAML ``` [BucketAccessRoleArn](#cfn-datasync-task-taskreportconfigdestinations3-bucketaccessrolearn): String [S3BucketArn](#cfn-datasync-task-taskreportconfigdestinations3-s3bucketarn): String [Subdirectory](#cfn-datasync-task-taskreportconfigdestinations3-subdirectory): String ``` ## Properties `BucketAccessRoleArn` Property description not available. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3BucketArn` Property description not available. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$` *Maximum*: `156` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subdirectory` Property description not available. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task TaskSchedule Configures your AWS DataSync task to run on a [schedule](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) (at a minimum interval of 1 hour). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ScheduleExpression](#cfn-datasync-task-taskschedule-scheduleexpression)" : String, "[Status](#cfn-datasync-task-taskschedule-status)" : String } ``` ### YAML ``` [ScheduleExpression](#cfn-datasync-task-taskschedule-scheduleexpression): String [Status](#cfn-datasync-task-taskschedule-status): String ``` ## Properties `ScheduleExpression` Specifies your task schedule by using a cron or rate expression. Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month: `cron(0 8 * * 3#1)` Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours: `rate(12 hours)` For information about cron and rate expression syntax, see the [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html). *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\+]*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Status` Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system. DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see [TaskScheduleDetails](https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html). *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Transferred The `Transferred` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReportLevel](#cfn-datasync-task-transferred-reportlevel)" : String } ``` ### YAML ``` [ReportLevel](#cfn-datasync-task-transferred-reportlevel): String ``` ## Properties `ReportLevel` Property description not available. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Verified The `Verified` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReportLevel](#cfn-datasync-task-verified-reportlevel)" : String } ``` ### YAML ``` [ReportLevel](#cfn-datasync-task-verified-reportlevel): String ``` ## Properties `ReportLevel` Property description not available. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)