Package software.amazon.awscdk.services.datasync

Interface CfnTask.TaskReportConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTask.TaskReportConfigProperty.Jsii$Proxy

Enclosing class:

CfnTask

@Stability(Stable)
public static interface CfnTask.TaskReportConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 TaskReportConfigProperty taskReportConfigProperty = TaskReportConfigProperty.builder()
         .destination(DestinationProperty.builder()
                 .s3(S3Property.builder()
                         .bucketAccessRoleArn("bucketAccessRoleArn")
                         .s3BucketArn("s3BucketArn")
                         .subdirectory("subdirectory")
                         .build())
                 .build())
         .outputType("outputType")
         // the properties below are optional
         .objectVersionIds("objectVersionIds")
         .overrides(OverridesProperty.builder()
                 .deleted(DeletedProperty.builder()
                         .reportLevel("reportLevel")
                         .build())
                 .skipped(SkippedProperty.builder()
                         .reportLevel("reportLevel")
                         .build())
                 .transferred(TransferredProperty.builder()
                         .reportLevel("reportLevel")
                         .build())
                 .verified(VerifiedProperty.builder()
                         .reportLevel("reportLevel")
                         .build())
                 .build())
         .reportLevel("reportLevel")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTask.TaskReportConfigProperty.Builder	A builder for CfnTask.TaskReportConfigProperty
static final class	CfnTask.TaskReportConfigProperty.Jsii$Proxy	An implementation for CfnTask.TaskReportConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnTask.TaskReportConfigProperty.Builder	builder()
Object	getDestination()	Specifies the Amazon S3 bucket where DataSync uploads your task report.
default String	getObjectVersionIds()	Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
String	getOutputType()	Specifies the type of task report that you want:.
default Object	getOverrides()	Customizes the reporting level for aspects of your task report.
default String	getReportLevel()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestination

@Stability(Stable)
@NotNull
Object getDestination()

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

For more information, see Task reports .

See Also:

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

getOutputType

@Stability(Stable)
@NotNull
String getOutputType()

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.

See Also:

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

getObjectVersionIds

@Stability(Stable)
@Nullable
default String getObjectVersionIds()

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.

See Also:

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

getOverrides

@Stability(Stable)
@Nullable
default Object getOverrides()

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.

See Also:

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

getReportLevel

@Stability(Stable)
@Nullable
default String getReportLevel()

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.

See Also:

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

builder

@Stability(Stable)
static CfnTask.TaskReportConfigProperty.Builder builder()

Returns:

a CfnTask.TaskReportConfigProperty.Builder of CfnTask.TaskReportConfigProperty