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',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

task_report_config_property = datasync.CfnTask.TaskReportConfigProperty(
    destination=datasync.CfnTask.DestinationProperty(
        s3=datasync.CfnTask.S3Property(
            bucket_access_role_arn="bucketAccessRoleArn",
            s3_bucket_arn="s3BucketArn",
            subdirectory="subdirectory"
        )
    ),
    output_type="outputType",

    # the properties below are optional
    object_version_ids="objectVersionIds",
    overrides=datasync.CfnTask.OverridesProperty(
        deleted=datasync.CfnTask.DeletedProperty(
            report_level="reportLevel"
        ),
        skipped=datasync.CfnTask.SkippedProperty(
            report_level="reportLevel"
        ),
        transferred=datasync.CfnTask.TransferredProperty(
            report_level="reportLevel"
        ),
        verified=datasync.CfnTask.VerifiedProperty(
            report_level="reportLevel"
        )
    ),
    report_level="reportLevel"
)

// 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();

// Install: dotnet add package Amazon.CDK.Lib
// 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"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

taskReportConfigProperty := &TaskReportConfigProperty{
	Destination: &DestinationProperty{
		S3: &S3Property{
			BucketAccessRoleArn: jsii.String("bucketAccessRoleArn"),
			S3BucketArn: jsii.String("s3BucketArn"),
			Subdirectory: jsii.String("subdirectory"),
		},
	},
	OutputType: jsii.String("outputType"),

	// the properties below are optional
	ObjectVersionIds: jsii.String("objectVersionIds"),
	Overrides: &OverridesProperty{
		Deleted: &DeletedProperty{
			ReportLevel: jsii.String("reportLevel"),
		},
		Skipped: &SkippedProperty{
			ReportLevel: jsii.String("reportLevel"),
		},
		Transferred: &TransferredProperty{
			ReportLevel: jsii.String("reportLevel"),
		},
		Verified: &VerifiedProperty{
			ReportLevel: jsii.String("reportLevel"),
		},
	},
	ReportLevel: jsii.String("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 .

objectVersionIds?optionalstringobject_version_ids?optionalstrobjectVersionIds?optionalStringObjectVersionIds?optionalstringObjectVersionIds?optional*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.

overrides?optionalIResolvable | CfnTask.OverridesPropertyoverrides?optionaltyping.Union[IResolvable, OverridesProperty]overrides?optionalIResolvableOverrides?optionalIResolvableOverrides?optionalinterface{}#

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.

reportLevel?optionalstringreport_level?optionalstrreportLevel?optionalStringReportLevel?optionalstringReportLevel?optional*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.