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

Syntax (vb)

Public Interface CfnTask.ITaskReportConfigProperty

Remarks

For more information, see Task reports .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html

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

object

Remarks

For more information, see Task reports .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-destination

Type union: either IResolvable or CfnTask.IDestinationProperty

ObjectVersionIds

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

string? ObjectVersionIds { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-objectversionids

OutputType

Specifies the type of task report that you want:.

string OutputType { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-outputtype

Overrides

Customizes the reporting level for aspects of your task report.

object? Overrides { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-overrides

Type union: either IResolvable or CfnTask.IOverridesProperty

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.

string? ReportLevel { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-reportlevel