[ aws . datasync ]

create-task

Description

Configures a task, which defines where and how DataSync transfers your data.

A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).

See also: AWS API Documentation

Synopsis

  create-task
--source-location-arn <value>
--destination-location-arn <value>
[--cloud-watch-log-group-arn <value>]
[--name <value>]
[--options <value>]
[--excludes <value>]
[--schedule <value>]
[--tags <value>]
[--includes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--source-location-arn (string)

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

--destination-location-arn (string)

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

--cloud-watch-log-group-arn (string)

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

--name (string)

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

--options (structure)

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 .

VerifyMode -> (string)

Specifies how and when DataSync checks the integrity of your data during a transfer.

Default value: POINT_IN_TIME_CONSISTENT

ONLY_FILES_TRANSFERRED (recommended): DataSync calculates the checksum of transferred files and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on those files at the destination.

We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations .

POINT_IN_TIME_CONSISTENT : At the end of the transfer, DataSync scans the entire source and destination to verify that both locations are fully synchronized.

You can’t use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations .

NONE : DataSync doesn’t run additional verification at the end of the transfer. All data transmissions are still integrity-checked with checksum verification during the transfer.

OverwriteMode -> (string)

Specifies whether data at the destination location should be overwritten or preserved. If set to NEVER , a destination file for example will not be replaced by a source file (even if the destination file differs from the source file). If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your Amazon S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync .

Atime -> (string)

Specifies whether to preserve metadata indicating the last time a file was read or written to. If you set Atime to BEST_EFFORT , DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase of the task execution).

Note

The behavior of Atime isn’t fully standard across platforms, so DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT

BEST_EFFORT : Attempt to preserve the per-file Atime value (recommended).

NONE : Ignore Atime .

Note

If Atime is set to BEST_EFFORT , Mtime must be set to PRESERVE .

If Atime is set to NONE , Mtime must also be NONE .

Mtime -> (string)

Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution. This option is required when you need to run the a task more than once.

Default Value: PRESERVE

PRESERVE : Preserve original Mtime (recommended)

NONE : Ignore Mtime .

Note

If Mtime is set to PRESERVE , Atime must be set to BEST_EFFORT .

If Mtime is set to NONE , Atime must also be set to NONE .

Uid -> (string)

Specifies the POSIX user ID (UID) of the file’s owner.

For more information, see Metadata copied by DataSync .

Default value: INT_VALUE . This preserves the integer value of the ID.

INT_VALUE : Preserve the integer value of UID and group ID (GID) (recommended).

NONE : Ignore UID and GID.

Gid -> (string)

Specifies the POSIX group ID (GID) of the file’s owners.

For more information, see Metadata copied by DataSync .

Default value: INT_VALUE . This preserves the integer value of the ID.

INT_VALUE : Preserve the integer value of user ID (UID) and GID (recommended).

NONE : Ignore UID and GID.

PreserveDeletedFiles -> (string)

Specifies whether files in the destination location that don’t exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync .

Default value: PRESERVE

PRESERVE : Ignore such destination files (recommended).

REMOVE : Delete destination files that aren’t present in the source.

PreserveDevices -> (string)

Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

Note

DataSync can’t copy the actual contents of these devices because they’re nonterminal and don’t return an end-of-file (EOF) marker.

Default value: NONE

NONE : Ignore special devices (recommended).

PRESERVE : Preserve character and block device metadata. This option currently isn’t supported for Amazon EFS.

PosixPermissions -> (string)

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

For more information, see Metadata copied by DataSync .

Default value: PRESERVE

PRESERVE : Preserve POSIX-style permissions (recommended).

NONE : Ignore permissions.

Note

DataSync can preserve extant permissions of a source location.

BytesPerSecond -> (long)

Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024 ).

TaskQueueing -> (string)

Specifies whether tasks should be queued before executing the tasks. The default is ENABLED , which means the tasks will be queued.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions .

LogLevel -> (string)

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn .

If you set LogLevel to OFF , no logs are published. BASIC publishes logs on errors for individual files transferred. TRANSFER publishes logs for every file or object that is transferred and integrity checked.

TransferMode -> (string)

Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what’s in the destination).

CHANGED : DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL : DataSync copies all source location content to the destination (without comparing what’s in the destination).

SecurityDescriptorCopyFlags -> (string)

Specifies which components of the SMB security descriptor are copied from source to destination objects.

This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata .

Default value: OWNER_DACL

OWNER_DACL : For each copied object, DataSync copies the following metadata:

• The object owner.

• NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. DataSync won’t copy NTFS system access control lists (SACLs) with this option.

OWNER_DACL_SACL : For each copied object, DataSync copies the following metadata:

• The object owner.

• NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

• SACLs, which are used by administrators to log attempts to access a secured object. Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user .

NONE : None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.

ObjectTags -> (string)

Specifies whether object tags are preserved when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

Default Value: PRESERVE

Shorthand Syntax:

VerifyMode=string,OverwriteMode=string,Atime=string,Mtime=string,Uid=string,Gid=string,PreserveDeletedFiles=string,PreserveDevices=string,PosixPermissions=string,BytesPerSecond=long,TaskQueueing=string,LogLevel=string,TransferMode=string,SecurityDescriptorCopyFlags=string,ObjectTags=string

JSON Syntax:

{
  "VerifyMode": "POINT_IN_TIME_CONSISTENT"|"ONLY_FILES_TRANSFERRED"|"NONE",
  "OverwriteMode": "ALWAYS"|"NEVER",
  "Atime": "NONE"|"BEST_EFFORT",
  "Mtime": "NONE"|"PRESERVE",
  "Uid": "NONE"|"INT_VALUE"|"NAME"|"BOTH",
  "Gid": "NONE"|"INT_VALUE"|"NAME"|"BOTH",
  "PreserveDeletedFiles": "PRESERVE"|"REMOVE",
  "PreserveDevices": "NONE"|"PRESERVE",
  "PosixPermissions": "NONE"|"PRESERVE",
  "BytesPerSecond": long,
  "TaskQueueing": "ENABLED"|"DISABLED",
  "LogLevel": "OFF"|"BASIC"|"TRANSFER",
  "TransferMode": "CHANGED"|"ALL",
  "SecurityDescriptorCopyFlags": "NONE"|"OWNER_DACL"|"OWNER_DACL_SACL",
  "ObjectTags": "PRESERVE"|"NONE"
}

--excludes (list)

Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync .

(structure)

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

FilterType -> (string)

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

Value -> (string)

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by “|” (that is, a pipe), for example: /folder1|/folder2

Shorthand Syntax:

FilterType=string,Value=string ...

JSON Syntax:

[
  {
    "FilterType": "SIMPLE_PATTERN",
    "Value": "string"
  }
  ...
]

--schedule (structure)

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 .

ScheduleExpression -> (string)

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

Shorthand Syntax:

ScheduleExpression=string

JSON Syntax:

{
  "ScheduleExpression": "string"
}

--tags (list)

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.

(structure)

A key-value pair representing a single tag that’s been applied to an Amazon Web Services resource.

Key -> (string)

The key for an Amazon Web Services resource tag.

Value -> (string)

The value for an Amazon Web Services resource tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--includes (list)

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync .

(structure)

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

FilterType -> (string)

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

Value -> (string)

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by “|” (that is, a pipe), for example: /folder1|/folder2

Shorthand Syntax:

FilterType=string,Value=string ...

JSON Syntax:

[
  {
    "FilterType": "SIMPLE_PATTERN",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json

• text

• table

• yaml

• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on

• off

• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64

• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

TaskArn -> (string)

The Amazon Resource Name (ARN) of the task.