aws-cdk-lib.aws_datasync.CfnTask.TaskReportConfigProperty

TaskReportConfigProperty Struct

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 .

Source

Generated code

Type last changed

v2.95.0 · 7 Sep 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datasync as datasync } from 'aws-cdk-lib';
const taskReportConfigProperty: datasync.CfnTask.TaskReportConfigProperty = {
  destination: {
    s3: {
      bucketAccessRoleArn: 'bucketAccessRoleArn',
      s3BucketArn: 's3BucketArn',
      subdirectory: 'subdirectory',
    },
  },
  outputType: 'outputType',

  // the properties below are optional
  objectVersionIds: 'objectVersionIds',
  overrides: {
    deleted: {
      reportLevel: 'reportLevel',
    },
    skipped: {
      reportLevel: 'reportLevel',
    },
    transferred: {
      reportLevel: 'reportLevel',
    },
    verified: {
      reportLevel: 'reportLevel',
    },
  },
  reportLevel: 'reportLevel',
};

Properties

destinationIResolvable | CfnTask.DestinationPropertydestinationtyping.Union[IResolvable, DestinationProperty]destinationIResolvableDestinationIResolvableDestinationinterface{}required#

Specifies the Amazon S3 bucket where DataSync uploads your task report.

For more information, see Task reports .

objectVersionIdsstringobject_version_idsstrobjectVersionIdsStringObjectVersionIdsstringObjectVersionIds*string#

Specifies whether your task report includes the new version of each object transferred into an S3 bucket.

notes

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.

outputTypestringoutput_typestroutputTypeStringOutputTypestringOutputType*stringrequired#

Specifies the type of task report that you want:.

notes

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

overridesIResolvable | CfnTask.OverridesPropertyoverridestyping.Union[IResolvable, OverridesProperty]overridesIResolvableOverridesIResolvableOverridesinterface{}#

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.

reportLevelstringreport_levelstrreportLevelStringReportLevelstringReportLevel*string#

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.