This product is not supported for your selected Datadog site. ().

aws_datasync_task

account_id

Type: STRING

cloud_watch_log_group_arn

Type: STRING
Provider name: CloudWatchLogGroupArn
Description: The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task. For more information, see Monitoring data transfers with CloudWatch Logs.

creation_time

Type: TIMESTAMP
Provider name: CreationTime
Description: The time that the task was created.

current_task_execution_arn

Type: STRING
Provider name: CurrentTaskExecutionArn
Description: The ARN of the most recent task execution.

destination_location_arn

Type: STRING
Provider name: DestinationLocationArn
Description: The ARN of your transfer’s destination location.

destination_network_interface_arns

Type: UNORDERED_LIST_STRING
Provider name: DestinationNetworkInterfaceArns
Description: The ARNs of the network interfaces that DataSync created for your destination location.

error_code

Type: STRING
Provider name: ErrorCode
Description: If there’s an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

error_detail

Type: STRING
Provider name: ErrorDetail
Description: If there’s an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

excludes

Type: UNORDERED_LIST_STRUCT
Provider name: Excludes
Description: The exclude filters that define the files, objects, and folders in your source location that you don’t want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

  • filter_type
    Type: STRING
    Provider name: FilterType
    Description: The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.
  • value
    Type: STRING
    Provider name: Value
    Description: 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

includes

Type: UNORDERED_LIST_STRUCT
Provider name: Includes
Description: The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

  • filter_type
    Type: STRING
    Provider name: FilterType
    Description: The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.
  • value
    Type: STRING
    Provider name: Value
    Description: 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

manifest_config

Type: STRUCT
Provider name: ManifestConfig
Description: The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

  • action
    Type: STRING
    Provider name: Action
    Description: Specifies what DataSync uses the manifest for.
  • format
    Type: STRING
    Provider name: Format
    Description: Specifies the file format of your manifest. For more information, see Creating a manifest.
  • source
    Type: STRUCT
    Provider name: Source
    Description: Specifies the manifest that you want DataSync to use and where it’s hosted. You must specify this parameter if you’re configuring a new manifest on or after February 7, 2024. If you don’t, you’ll get a 400 status code and ValidationException error stating that you’re missing the IAM role for DataSync to access the S3 bucket where you’re hosting your manifest. For more information, see Providing DataSync access to your manifest.
    • s3
      Type: STRUCT
      Provider name: S3
      Description: Specifies the S3 bucket where you’re hosting your manifest.
      • bucket_access_role_arn
        Type: STRING
        Provider name: BucketAccessRoleArn
        Description: Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest.
      • manifest_object_path
        Type: STRING
        Provider name: ManifestObjectPath
        Description: Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, prefix/my-manifest.csv).
      • manifest_object_version_id
        Type: STRING
        Provider name: ManifestObjectVersionId
        Description: Specifies the object version ID of the manifest that you want DataSync to use. If you don’t set this, DataSync uses the latest version of the object.
      • s3_bucket_arn
        Type: STRING
        Provider name: S3BucketArn
        Description: Specifies the Amazon Resource Name (ARN) of the S3 bucket where you’re hosting your manifest.

name

Type: STRING
Provider name: Name
Description: The name of your task.

options

Type: STRUCT
Provider name: Options
Description: The task’s settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.

  • atime
    Type: STRING
    Provider name: Atime
    Description: Specifies whether to preserve metadata indicating the last time a file was read or written to. The behavior of Atime isn’t fully standard across platforms, so DataSync can only do this on a best-effort basis.
    • BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING steps of the task execution). This option is recommended.
    • NONE - Ignores Atime.
    If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. If Atime is set to NONE, Mtime must also be NONE.
  • bytes_per_second
    Type: INT64
    Provider name: BytesPerSecond
    Description: 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). Not applicable to Enhanced mode tasks.
  • gid
    Type: STRING
    Provider name: Gid
    Description: Specifies the POSIX group ID (GID) of the file’s owners.
    • INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.
    • NONE - Ignores UID and GID.
    For more information, see Understanding how DataSync handles file and object metadata.
  • log_level
    Type: STRING
    Provider name: LogLevel
    Description: Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn.
    • BASIC - Publishes logs with only basic information (such as transfer errors).
    • TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.
    • OFF - No logs are published.
  • mtime
    Type: STRING
    Provider name: Mtime
    Description: Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING step of your task execution. This option is required when you need to run the a task more than once.
    • PRESERVE (default) - Preserves original Mtime, which is recommended.
    • NONE - Ignores Mtime.
    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.
  • object_tags
    Type: STRING
    Provider name: ObjectTags
    Description: Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.
  • overwrite_mode
    Type: STRING
    Provider name: OverwriteMode
    Description: Specifies whether DataSync should modify or preserve data at the destination location.
    • ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed. If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
    • NEVER - DataSync doesn’t overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.
  • posix_permissions
    Type: STRING
    Provider name: PosixPermissions
    Description: 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 Understanding how DataSync handles file and object metadata.
    • PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
    • NONE - Ignores POSIX-style permissions.
    DataSync can preserve extant permissions of a source location.
  • preserve_deleted_files
    Type: STRING
    Provider name: PreserveDeletedFiles
    Description: 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.
    • PRESERVE (default) - Ignores such destination files, which is recommended.
    • REMOVE - Deletes destination files that aren’t present in the source.
    If you set this parameter to REMOVE, you can’t set TransferMode to ALL. When you transfer all data, DataSync doesn’t scan your destination location and doesn’t know what to delete.
  • preserve_devices
    Type: STRING
    Provider name: PreserveDevices
    Description: 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. DataSync can’t copy the actual contents of these devices because they’re nonterminal and don’t return an end-of-file (EOF) marker.
    • NONE (default) - Ignores special devices (recommended).
    • PRESERVE - Preserves character and block device metadata. This option currently isn’t supported for Amazon EFS.
  • security_descriptor_copy_flags
    Type: STRING
    Provider name: SecurityDescriptorCopyFlags
    Description: 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 Understanding how DataSync handles file and object metadata.
    • OWNER_DACL (default) - 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 with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).
    • 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.
  • task_queueing
    Type: STRING
    Provider name: TaskQueueing
    Description: Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is ENABLED by default.
  • transfer_mode
    Type: STRING
    Provider name: TransferMode
    Description: Specifies whether DataSync transfers only the data (including metadata) that differs between locations following an initial copy or transfers all data every time you run the task. If you’re planning on recurring transfers, you might only want to transfer what’s changed since your previous task execution.
    • CHANGED (default) - After your initial full transfer, DataSync copies only the data and metadata that differs between the source and destination location.
    • ALL - DataSync copies everything in the source to the destination without comparing differences between the locations.
  • uid
    Type: STRING
    Provider name: Uid
    Description: Specifies the POSIX user ID (UID) of the file’s owner.
    • INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.
    • NONE - Ignores UID and GID.
    For more information, see Metadata copied by DataSync.
  • verify_mode
    Type: STRING
    Provider name: VerifyMode
    Description: Specifies if and how DataSync checks the integrity of your data at the end of your transfer.
    • ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred data (including metadata) at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on that data at the destination. This is the default option for Enhanced mode tasks. 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 checks the entire source and destination to verify that both locations are fully synchronized. The is the default option for Basic mode tasks and isn’t currently supported with Enhanced mode tasks. If you use a manifest, DataSync only scans and verifies what’s listed in the manifest. 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 performs data integrity checks only during your transfer. Unlike other options, there’s no additional verification at the end of your transfer.

schedule

Type: STRUCT
Provider name: Schedule
Description: The schedule for when you want your task to run. For more information, see Scheduling your task.

  • schedule_expression
    Type: STRING
    Provider name: ScheduleExpression
    Description: Specifies your task schedule by using a cron or rate expression. Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month: cron(0 8 * * 3#1) Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours: rate(12 hours) For information about cron and rate expression syntax, see the Amazon EventBridge User Guide .
  • status
    Type: STRING
    Provider name: Status
    Description: Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system. DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.

schedule_details

Type: STRUCT
Provider name: ScheduleDetails
Description: The details about your task schedule.

  • disabled_by
    Type: STRING
    Provider name: DisabledBy
    Description: Indicates how your task schedule was disabled.
    • USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.
    • SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error.
  • disabled_reason
    Type: STRING
    Provider name: DisabledReason
    Description: Provides a reason if the task schedule is disabled. If your schedule is disabled by USER, you see a Manually disabled by user. message. If your schedule is disabled by SERVICE, you see an error message to help you understand why the task keeps failing. For information on resolving DataSync errors, see Troubleshooting issues with DataSync transfers.
  • status_update_time
    Type: TIMESTAMP
    Provider name: StatusUpdateTime
    Description: Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled.

source_location_arn

Type: STRING
Provider name: SourceLocationArn
Description: The ARN of your transfer’s source location.

source_network_interface_arns

Type: UNORDERED_LIST_STRING
Provider name: SourceNetworkInterfaceArns
Description: The ARNs of the network interfaces that DataSync created for your source location.

status

Type: STRING
Provider name: Status
Description: The status of your task. For information about what each status means, see Task statuses.

tags

Type: UNORDERED_LIST_STRING

task_arn

Type: STRING
Provider name: TaskArn
Description: The ARN of your task.

task_mode

Type: STRING
Provider name: TaskMode
Description: The task mode that you’re using. For more information, see Choosing a task mode for your data transfer.

task_report_config

Type: STRUCT
Provider name: TaskReportConfig
Description: The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

  • destination
    Type: STRUCT
    Provider name: Destination
    Description: Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.
    • s3
      Type: STRUCT
      Provider name: S3
      Description: Specifies the Amazon S3 bucket where DataSync uploads your task report.
      • bucket_access_role_arn
        Type: STRING
        Provider name: BucketAccessRoleArn
        Description: Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket.
      • s3_bucket_arn
        Type: STRING
        Provider name: S3BucketArn
        Description: Specifies the ARN of the S3 bucket where DataSync uploads your report.
      • subdirectory
        Type: STRING
        Provider name: Subdirectory
        Description: Specifies a bucket prefix for your report.
  • object_version_ids
    Type: STRING
    Provider name: ObjectVersionIds
    Description: Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.
  • output_type
    Type: STRING
    Provider name: OutputType
    Description: Specifies the type of task report that you want:
    • SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.
    • STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.
  • overrides
    Type: STRUCT
    Provider name: Overrides
    Description: Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.
    • deleted
      Type: STRUCT
      Provider name: Deleted
      Description: Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn’t in the source.
      • report_level
        Type: STRING
        Provider name: ReportLevel
        Description: Specifies whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn’t go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn’t to transfer (SUCCESSES_AND_ERRORS).
    • skipped
      Type: STRUCT
      Provider name: Skipped
      Description: Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer.
      • report_level
        Type: STRING
        Provider name: ReportLevel
        Description: Specifies whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn’t go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn’t to transfer (SUCCESSES_AND_ERRORS).
    • transferred
      Type: STRUCT
      Provider name: Transferred
      Description: Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer.
      • report_level
        Type: STRING
        Provider name: ReportLevel
        Description: Specifies whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn’t go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn’t to transfer (SUCCESSES_AND_ERRORS).
    • verified
      Type: STRUCT
      Provider name: Verified
      Description: Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer.
      • report_level
        Type: STRING
        Provider name: ReportLevel
        Description: Specifies whether your task report includes errors only or successes and errors. For example, your report might mostly include only what didn’t go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn’t to transfer (SUCCESSES_AND_ERRORS).
  • report_level
    Type: STRING
    Provider name: ReportLevel
    Description: Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.
    • ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
    • SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.