interface CfnTaskProps

Language	Type name
.NET	`Amazon.CDK.AWS.DataSync.CfnTaskProps`
Java	`software.amazon.awscdk.services.datasync.CfnTaskProps`
Python	`aws_cdk.aws_datasync.CfnTaskProps`
TypeScript	`@aws-cdk/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 * as datasync from '@aws-cdk/aws-datasync';
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',
  }],
  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',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
destinationLocationArn	`string`	The Amazon Resource Name (ARN) of an AWS storage resource's location.
sourceLocationArn	`string`	The Amazon Resource Name (ARN) of the source location for the task.
cloudWatchLogGroupArn?	`string`	The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
excludes?	`IResolvable` `\|` `IResolvable` `\|` `FilterRuleProperty[]`	Specifies a list of filter rules that exclude specific data during your transfer.
includes?	`IResolvable` `\|` `IResolvable` `\|` `FilterRuleProperty[]`	Specifies a list of filter rules that include specific data during your transfer.
name?	`string`	The name of a task.
options?	`IResolvable` `\|` `OptionsProperty`	Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.
schedule?	`IResolvable` `\|` `TaskScheduleProperty`	Specifies a schedule used to periodically transfer files from a source to a destination location.
tags?	`CfnTag[]`	Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

destinationLocationArn

Type: string

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

sourceLocationArn

Type: string

The Amazon Resource Name (ARN) of the source location for the task.

cloudWatchLogGroupArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS DataSync User Guide.

For more information about these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide .

excludes?

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

Specifies a list of filter rules that exclude specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

includes?

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

Specifies a list of filter rules that include specific data during your transfer.

For more information and examples, see Filtering data transferred by DataSync .

name?

Type: string (optional)

The name of a task.

This value is a text reference that is used to identify the task in the console.

options?

Type: IResolvable | OptionsProperty (optional)

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution ). For more information, see StartTaskExecution .

schedule?

Type: IResolvable | TaskScheduleProperty (optional)

Specifies a schedule used to periodically transfer files from a source to a destination location.

The schedule should be specified in UTC time. For more information, see Scheduling your task .

tags?

Type: CfnTag[] (optional)

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

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