Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateTaskRequest

CreateTaskRequest

Hierarchy

Index

Properties

Optional CloudWatchLogGroupArn

CloudWatchLogGroupArn: undefined | string

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

DestinationLocationArn

DestinationLocationArn: string | undefined

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

Optional Excludes

Excludes: FilterRule[]

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Optional Includes

Includes: FilterRule[]

A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

Optional Name

Name: undefined | string

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

Optional Options

Options: Options

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

Optional Schedule

Schedule: TaskSchedule

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.

SourceLocationArn

SourceLocationArn: string | undefined

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

Optional Tags

Tags: TagListEntry[]

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.