Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 5.77 KB

.header.md

File metadata and controls

46 lines (37 loc) · 5.77 KB

AWS DataSync Task Terraform sub-module

Creates a Datasync Task. A task describes a DataSync transfer. It identifies a source and destination location along with details about how to copy data between those locations. You also can specify how a task treats metadata, deleted files, and permissions.

DataSync Task

To configure one or more AWS DataSync Tasks use the datasync_tasks variable. It is a list that supports objects with the following attributes.

  • destination_location_arn - (Required) Amazon Resource Name (ARN) of destination DataSync Location.
  • source_location_arn - (Required) Amazon Resource Name (ARN) of source DataSync Location.
  • cloudwatch_log_group_arn - (Optional) Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
  • excludes - (Optional) Filter rules that determines which files to exclude from a task.
  • includes - (Optional) Filter rules that determines which files to include in a task.
  • name - (Optional) Name of the DataSync Task.
  • options - (Optional) Configuration map containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
  • schedule - (Optional) Specifies a schedule used to periodically transfer files from a source to a destination location.
  • tags - (Optional) Key-value pairs of resource tags to assign to the DataSync Task.

Options

  • atime - (Optional) A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.
  • bytes_per_second - (Optional) Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited). gid - (Optional) Group identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
  • log_level - (Optional) Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: OFF, BASIC, TRANSFER. Default: OFF. mtime - (Optional) A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.
  • object_tags - (Optional) Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: PRESERVE, NONE. Default value: PRESERVE.
  • overwrite_mode - (Optional) Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: ALWAYS, NEVER. Default: ALWAYS.
  • posix_permissions - (Optional) Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: NONE, PRESERVE. Default: PRESERVE.
  • preserve_deleted_files - (Optional) Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.
  • preserve_devices - (Optional) Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).
  • security_descriptor_copy_flags - (Optional) Determines 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 Amazon FSx for Windows File Server locations. Valid values: NONE, OWNER_DACL, OWNER_DACL_SACL. Default: OWNER_DACL.
  • task_queueing - (Optional) Determines whether tasks should be queued before executing the tasks. Valid values: ENABLED, DISABLED. Default ENABLED. transfer_mode - (Optional) 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. Valid values: CHANGED, ALL. Default: CHANGED
  • uid - (Optional) User identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
  • verify_mode - (Optional) Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED. Default: POINT_IN_TIME_CONSISTENT.

Schedule

  • schedule_expression - (Required) Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

Excludes

  • filter_type - (Optional) The type of filter rule to apply. Valid values: SIMPLE_PATTERN. value - (Optional) A single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

Includes

  • filter_type - (Optional) The type of filter rule to apply. Valid values: SIMPLE_PATTERN. value - (Optional) A single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2