Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-datasync-task.json
Parent schema serverless-framework-configuration
Type: object

Properties

DestinationLocationArn string | Aws_CF_FunctionString required

The ARN of an AWS storage resource's location.

SourceLocationArn string | Aws_CF_FunctionString required

The ARN of the source location for the task.

Excludes FilterRule[]
minItems=0maxItems=1
Includes FilterRule[]
minItems=0maxItems=1
Tags Tag[]

An array of key-value pairs to apply to this resource.

maxItems=50uniqueItems=true
CloudWatchLogGroupArn string | Aws_CF_FunctionString

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

Name string | Aws_CF_FunctionString

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

Options object

Represents the options that are available to control the behavior of a StartTaskExecution operation.

15 nested properties
Atime string | Aws_CF_FunctionString

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).

BytesPerSecond integer

A value that limits the bandwidth used by AWS DataSync.

format=int64min=-1
Gid string | Aws_CF_FunctionString

The group ID (GID) of the file's owners.

LogLevel string | Aws_CF_FunctionString

A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.

Mtime string | Aws_CF_FunctionString

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

OverwriteMode string | Aws_CF_FunctionString

A value that determines whether files at the destination should be overwritten or preserved when copying files.

PosixPermissions string | Aws_CF_FunctionString

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

PreserveDeletedFiles string | Aws_CF_FunctionString

A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

PreserveDevices string | Aws_CF_FunctionString

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

SecurityDescriptorCopyFlags string | Aws_CF_FunctionString

A value that determines which components of the SMB security descriptor are copied during transfer.

TaskQueueing string | Aws_CF_FunctionString

A value that determines whether tasks should be queued before executing the tasks.

TransferMode string | Aws_CF_FunctionString

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

Uid string | Aws_CF_FunctionString

The user ID (UID) of the file's owner.

VerifyMode string | Aws_CF_FunctionString

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

ObjectTags string | Aws_CF_FunctionString

A value that determines whether object tags should be read from the source object store and written to the destination object store.

Schedule object

Specifies the schedule you want your task to use for repeated executions.

1 nested properties
ScheduleExpression string | Aws_CF_FunctionString required

A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location

Definitions

FilterRule object

Specifies which files folders and objects to include or exclude when transferring files from source to destination.

FilterType string | Aws_CF_FunctionString

The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.

Value string | Aws_CF_FunctionString

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|".

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key for an AWS resource tag.

Value string | Aws_CF_FunctionString required

The value for an AWS resource tag.

TaskSchedule object

Specifies the schedule you want your task to use for repeated executions.

ScheduleExpression string | Aws_CF_FunctionString required

A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location

Options object

Represents the options that are available to control the behavior of a StartTaskExecution operation.

Atime string | Aws_CF_FunctionString

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).

BytesPerSecond integer

A value that limits the bandwidth used by AWS DataSync.

format=int64min=-1
Gid string | Aws_CF_FunctionString

The group ID (GID) of the file's owners.

LogLevel string | Aws_CF_FunctionString

A value that determines the types of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide.

Mtime string | Aws_CF_FunctionString

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

OverwriteMode string | Aws_CF_FunctionString

A value that determines whether files at the destination should be overwritten or preserved when copying files.

PosixPermissions string | Aws_CF_FunctionString

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

PreserveDeletedFiles string | Aws_CF_FunctionString

A value that specifies whether files in the destination that don't exist in the source file system should be preserved.

PreserveDevices string | Aws_CF_FunctionString

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

SecurityDescriptorCopyFlags string | Aws_CF_FunctionString

A value that determines which components of the SMB security descriptor are copied during transfer.

TaskQueueing string | Aws_CF_FunctionString

A value that determines whether tasks should be queued before executing the tasks.

TransferMode string | Aws_CF_FunctionString

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

Uid string | Aws_CF_FunctionString

The user ID (UID) of the file's owner.

VerifyMode string | Aws_CF_FunctionString

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

ObjectTags string | Aws_CF_FunctionString

A value that determines whether object tags should be read from the source object store and written to the destination object store.

SourceNetworkInterfaceArns string[]

The Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.

DestinationNetworkInterfaceArns string[]

The Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.