interface CfnTaskProps

Language	Type name
.NET	`Amazon.CDK.AWS.DataSync.CfnTaskProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnTaskProps`
Java	`software.amazon.awscdk.services.datasync.CfnTaskProps`
Python	`aws_cdk.aws_datasync.CfnTaskProps`
TypeScript	`aws-cdk-lib` » `aws_datasync` » `CfnTaskProps`

Properties for defining a CfnTask.

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 cfnTaskProps: datasync.CfnTaskProps = {
  destinationLocationArn: 'destinationLocationArn',
  sourceLocationArn: 'sourceLocationArn',

  // the properties below are optional
  cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
  excludes: [{
    filterType: 'filterType',
    value: 'value',
  }],
  includes: [{
    filterType: 'filterType',
    value: 'value',
  }],
  manifestConfig: {
    source: {
      s3: {
        bucketAccessRoleArn: 'bucketAccessRoleArn',
        manifestObjectPath: 'manifestObjectPath',
        manifestObjectVersionId: 'manifestObjectVersionId',
        s3BucketArn: 's3BucketArn',
      },
    },

    // the properties below are optional
    action: 'action',
    format: 'format',
  },
  name: 'name',
  options: {
    atime: 'atime',
    bytesPerSecond: 123,
    gid: 'gid',
    logLevel: 'logLevel',
    mtime: 'mtime',
    objectTags: 'objectTags',
    overwriteMode: 'overwriteMode',
    posixPermissions: 'posixPermissions',
    preserveDeletedFiles: 'preserveDeletedFiles',
    preserveDevices: 'preserveDevices',
    securityDescriptorCopyFlags: 'securityDescriptorCopyFlags',
    taskQueueing: 'taskQueueing',
    transferMode: 'transferMode',
    uid: 'uid',
    verifyMode: 'verifyMode',
  },
  schedule: {
    scheduleExpression: 'scheduleExpression',
    status: 'status',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  taskMode: 'taskMode',
  taskReportConfig: {
    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',
  },
};

Properties

Name	Type	Description
destinationLocationArn	`string`	The Amazon Resource Name (ARN) of an AWS storage resource's location.
sourceLocationArn	`string`	Specifies the ARN of your transfer's source location.
cloudWatchLogGroupArn?	`string`	Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
excludes?	`IResolvable` `\|` `IResolvable` `\|` `FilterRuleProperty[]`	Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.
includes?	`IResolvable` `\|` `IResolvable` `\|` `FilterRuleProperty[]`	Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.
manifestConfig?	`IResolvable` `\|` `ManifestConfigProperty`	The configuration of the manifest that lists the files or objects that you want DataSync to transfer.
name?	`string`	Specifies the name of your task.
options?	`IResolvable` `\|` `OptionsProperty`	Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
schedule?	`IResolvable` `\|` `TaskScheduleProperty`	Specifies a schedule for when you want your task to run.
tags?	`CfnTag[]`	Specifies the tags that you want to apply to your task.
taskMode?	`string`	Specifies one of the following task modes for your data transfer:.
taskReportConfig?	`IResolvable` `\|` `TaskReportConfigProperty`	Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

destinationLocationArn

Type: string

The Amazon Resource Name (ARN) of an AWS storage resource's location.

sourceLocationArn

Type: string

Specifies the ARN of your transfer's source location.

cloudWatchLogGroupArn?

Type: string (optional)

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named /aws/datasync .

For more information, see Monitoring data transfers with CloudWatch Logs .

excludes?

Type: IResolvable | IResolvable | FilterRuleProperty[] (optional)

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.

For more information and examples, see Specifying what DataSync transfers by using filters .

includes?

Type: IResolvable | IResolvable | FilterRuleProperty[] (optional)

Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.

For more information and examples, see Specifying what DataSync transfers by using filters .

manifestConfig?

Type: IResolvable | ManifestConfigProperty (optional)

The configuration of the manifest that lists the files or objects that you want DataSync to transfer.

For more information, see Specifying what DataSync transfers by using a manifest .

name?

Type: string (optional)

Specifies the name of your task.

options?

Type: IResolvable | OptionsProperty (optional)

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.

schedule?

Type: IResolvable | TaskScheduleProperty (optional)

Specifies a schedule for when you want your task to run.

For more information, see Scheduling your task .

tags?

Type: CfnTag[] (optional)

Specifies the tags that you want to apply to your task.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

taskMode?

Type: string (optional)

Specifies one of the following task modes for your data transfer:.

ENHANCED - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.

To create an Enhanced mode task, the IAM role that you use to call the CreateTask operation must have the iam:CreateServiceLinkedRole permission.

BASIC (default) - Transfer files or objects between AWS storage and all other supported DataSync locations. Basic mode tasks are subject to quotas on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.

For more information, see Understanding task mode differences .

taskReportConfig?

Type: IResolvable | TaskReportConfigProperty (optional)

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

For more information, see Monitoring your DataSync transfers with task reports .

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.