Interface CfnTask.ITaskReportConfigProperty
Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer.
Namespace: Amazon.CDK.AWS.DataSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ITaskReportConfigProperty
Syntax (vb)
Public Interface ITaskReportConfigProperty
Remarks
For more information, see Task reports .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DataSync;
var taskReportConfigProperty = new TaskReportConfigProperty {
Destination = new DestinationProperty {
S3 = new S3Property {
BucketAccessRoleArn = "bucketAccessRoleArn",
S3BucketArn = "s3BucketArn",
Subdirectory = "subdirectory"
}
},
OutputType = "outputType",
// the properties below are optional
ObjectVersionIds = "objectVersionIds",
Overrides = new OverridesProperty {
Deleted = new DeletedProperty {
ReportLevel = "reportLevel"
},
Skipped = new SkippedProperty {
ReportLevel = "reportLevel"
},
Transferred = new TransferredProperty {
ReportLevel = "reportLevel"
},
Verified = new VerifiedProperty {
ReportLevel = "reportLevel"
}
},
ReportLevel = "reportLevel"
};
Synopsis
Properties
Destination | Specifies the Amazon S3 bucket where DataSync uploads your task report. |
ObjectVersionIds | Specifies whether your task report includes the new version of each object transferred into an S3 bucket. |
OutputType | Specifies the type of task report that you want:. |
Overrides | Customizes the reporting level for aspects of your task report. |
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. |
Properties
Destination
Specifies the Amazon S3 bucket where DataSync uploads your task report.
object Destination { get; }
Property Value
System.Object
Remarks
ObjectVersionIds
Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
virtual string ObjectVersionIds { get; }
Property Value
System.String
Remarks
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.
OutputType
Specifies the type of task report that you want:.
string OutputType { get; }
Property Value
System.String
Remarks
Overrides
Customizes the reporting level for aspects of your task report.
virtual object Overrides { get; }
Property Value
System.Object
Remarks
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.
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.
virtual string ReportLevel { get; }
Property Value
System.String