2.233.0

interface TaskReportConfigProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.DataSync.Mixins.CfnTaskPropsMixin.TaskReportConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdatasync/mixins#CfnTaskPropsMixin_TaskReportConfigProperty
Javasoftware.amazon.awscdk.mixins.preview.services.datasync.mixins.CfnTaskPropsMixin.TaskReportConfigProperty
Pythonaws_cdk.mixins_preview.aws_datasync.mixins.CfnTaskPropsMixin.TaskReportConfigProperty
TypeScript @aws-cdk/mixins-preview » aws_datasync » mixins » CfnTaskPropsMixin » TaskReportConfigProperty

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 .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as datasync_mixins } from '@aws-cdk/mixins-preview/aws-datasync';
const taskReportConfigProperty: datasync_mixins.CfnTaskPropsMixin.TaskReportConfigProperty = {
  destination: {
    s3: {
      bucketAccessRoleArn: 'bucketAccessRoleArn',
      s3BucketArn: 's3BucketArn',
      subdirectory: 'subdirectory',
    },
  },
  objectVersionIds: 'objectVersionIds',
  outputType: 'outputType',
  overrides: {
    deleted: {
      reportLevel: 'reportLevel',
    },
    skipped: {
      reportLevel: 'reportLevel',
    },
    transferred: {
      reportLevel: 'reportLevel',
    },
    verified: {
      reportLevel: 'reportLevel',
    },
  },
  reportLevel: 'reportLevel',
};

Properties

NameTypeDescription
destination?IResolvable | DestinationPropertySpecifies the Amazon S3 bucket where DataSync uploads your task report.
objectVersionIds?stringSpecifies whether your task report includes the new version of each object transferred into an S3 bucket.
outputType?stringSpecifies the type of task report that you want:.
overrides?IResolvable | OverridesPropertyCustomizes the reporting level for aspects of your task report.
reportLevel?stringSpecifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

destination?

Type: IResolvable | DestinationProperty (optional)

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

objectVersionIds?

Type: string (optional)

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

outputType?

Type: string (optional)

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

overrides?

Type: IResolvable | OverridesProperty (optional)

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

reportLevel?

Type: string (optional)

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

← PreviousNext →