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.

Syntax

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

JSON

{
  "Destination" : Destination,
  "ObjectVersionIds" : String,
  "OutputType" : String,
  "Overrides" : Overrides,
  "ReportLevel" : String
}

YAML

  Destination: 
    Destination
  ObjectVersionIds: String
  OutputType: String
  Overrides: 
    Overrides
  ReportLevel: String

Properties

Destination

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

Required: Yes

Type: Destination

Update requires: No interruption

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. 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

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

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

Update requires: No interruption

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