ApiAwsDataSyncTaskArgs Data Model

Options to be used for creating an AWS DataSync task. Equivalent of com.amazonaws.services.datasync.model.CreateTaskRequest, but it might not contain every possible option.

Properties
name data type description
sourceLocation ApiAwsS3Location MANDATORY - Specifies the source location from where the DataSync task will replicate. Once the DataSync task has been created, the source location cannot be modified.
destinationLocation ApiAwsS3Location MANDATORY - Specifies the destination location where DataSync task will replicate to. Once the DataSync task has been created, the destination location cannot be modified.
name string The name of the AWS DataSync task. If not given, then DataSync will give a name to it.
excludeFilters array of string Specifies exclude filters that define the files, objects, and folders in the source location that DataSync won't transfer. For more information and examples, see: Specifying what DataSync transfers by using filters .

Note that:

  • DataSync first will scan the whole sourceLocation, and only after that will apply filters.
  • It can be different between DataSync task executions.
includeFilters array of string Specifies include filters that define the files, objects, and folders in the source location that DataSync will transfer. For more information and examples, see: Specifying what DataSync transfers by using filters .

Note that:

  • DataSync first will scan the whole sourceLocation, and only after that will apply filters.
  • It can be different between DataSync task executions.
tags map of string Specifies the tags to be associated with this DataSync task.

Tags are like labels that can help manage, filter, and search for AWS resources. Having it as a Map provides more flexibility and categorization, for instance: 

   "tags": {
     "Project": "BDR",
     "Environment": "Test",
     "Owner": "QE"
   }
options ApiAwsDataSyncTaskOptions Specifies the task's settings, such as preserving file metadata, verifying data integrity, among other options. It can be different between DataSync task executions.
schedule ApiAwsDataSyncTaskSchedule Specifies a schedule when DataSync runs the task. For more information, see Scheduling your task .

Example

{
  "sourceLocation" : {
    "s3Path" : "...",
    "iamRoleArn" : "..."
  },
  "destinationLocation" : {
    "s3Path" : "...",
    "iamRoleArn" : "..."
  },
  "name" : "...",
  "excludeFilters" : [ "...", "..." ],
  "includeFilters" : [ "...", "..." ],
  "tags" : {
    "property1" : "...",
    "property2" : "..."
  },
  "options" : {
    "transferMode" : "ALL",
    "verifyMode" : "ONLY_FILES_TRANSFERRED",
    "overwriteMode" : "NEVER",
    "preserveAtime" : true,
    "preserveMtime" : true,
    "preserveUserId" : true,
    "preserveGroupId" : true,
    "preserveDeletedFiles" : true,
    "preserveDevices" : true,
    "preservePosixPermissions" : true,
    "preserveObjectTags" : true,
    "bytesPerSecond" : 12345,
    "taskQueueing" : true
  },
  "schedule" : {
    "scheduleExpression" : "..."
  }
}