AWS DataSync Connector 1.0.0.0
The AWS Data Sync Connector lets you list, submit, and monitor AWS DataSync Tasks.
Prerequisites
- RunMyJobs 9.2.9 or higher.
- Connection Management Extension 1.0.0.5 or later. This will be installed or updated automatically if necessary when you install the AWS DataSync Connector.
- AWS S3 Utilities 1.0.0.1 or later. This will be installed or updated automatically if necessary when you install the AWS DataSync Connector.
- An AWS Connection.
- Privileges Required to Use the AWS DataSync Connector.
Contents
| Object Type | Name | Description |
|---|---|---|
| Folder | GLOBAL.Redwood.REDWOOD.AWS.REDWOOD.DataSync | Integration Connector with AWS DataSync (1.0.0.0). |
| Constraint Definition | REDWOOD.Redwood_AWS_DataSyncConstraint | Constraint for AWS DataSync function in the specified region. |
| Job Definition | REDWOOD.Redwood_AWS_DataSync_ImportTasks | Imports AWS DataSync Tasks. |
| Job Definition | REDWOOD.Redwood_AWS_DataSync_ListTasks | List AWS DataSync Tasks. |
| Job Definition | REDWOOD.Redwood_AWS_DataSync_SubmitTask | Submits an AWS DataSync Task. |
| Job Definition Type | REDWOOD.Redwood_AWS_DataSync | AWS DataSync Definition Type. |
| Library | REDWOOD.Redwood_AWS_DataSync | Library for AWS DataSync Connector. |
Setup
To install the AWS DataSync Connector, click its tile in the Catalog, select the version you want, and then click Install <version number>.
Job Definitions
Redwood_AWS_DataSync_ListTasks
Returns a list of AWS DataSync Tasks in the form of an RTX file.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The AWS Connection. | String | In |
|
|
| Parameters | regionName
|
Region | The name of the AWS region where the AWS DataSync Tasks are located. | String | In |
|
|
| Parameters | taskName
|
Task Name Filter | Specifies which AWS DataSync Tasks should be included. If this field is blank, all available Tasks are returned. Wildcard characters * and ? are supported. | String | In |
|
|
| Parameters | tasks
|
Tasks | The AWS DataSync Tasks matching the filters (or all DataSync Tasks, if no input filter was provided). | Table | Out |
|
|
Redwood_AWS_DataSync_ImportTasks
Lets you import AWS DataSync Tasks as Job Definitions. Imported Tasks take the form of Redwood_AWS_DataSync_SubmitTask Job Definitions with the prefix specified in the Job Name Prefix field.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The AWS Connection. | String | In |
|
|
| Parameters | regionName
|
Region | The name of the AWS region that the AWS DataSync Tasks are located in. | String | In |
|
|
| Parameters | taskName
|
Task Name Filter | Specifies which Tasks should be included. By default (if no input is provided) the job will list all available Tasks. Wildcards * and ? are supported. | String | In |
|
|
| Generation Settings | overwrite
|
Overwrite Existing Definition | If this is set to Y, if a Job Definition with the same Business Key already exists, it will be overwritten by the import. If this is set to N, the import will be skipped if the Job Definition already exists. | String | In | N | Y=Yes ,N=No |
| Generation Settings | partition
|
Partition | The Partition to create the new Job Definitions in. | String | In |
|
QueryFilter:User.Redwood System.Partition.Partition%2e;all |
| Generation Settings | defaultQueue
|
Default Queue | The default Queue to assign to the generated Job Definitions. | String | In |
|
QueryFilter:User.Redwood System.Queue.Queue%2e;all |
| Generation Settings | application
|
Application | The Application to create the new Job Definitions in. | String | In |
|
QueryFilter:User.Redwood System.Application.Application%2e;all |
| Generation Settings | prefix
|
Job Name Prefix | Prefix to be used for the new Job Definition names. | String | In | CUS_AWSD_
|
|
Redwood_AWS_DataSync_SubmitTask
Lets you submit an AWS DataSync Task and monitor it to completion. You can also cancel the executed AWS DataSync Task by killing the Job.
If you have multiple AWS DataSync Tasks to execute, you can either import them as Job Definitions all at once using Redwood_AWS_DataSync_ImportTasks, or you can manually clone and customize this Job Definition for each Task.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The AWS Connection. | String | In |
|
|
| Parameters | regionName
|
Region | The name of the AWS region where the AWS DataSync Task is located. | String | In |
|
|
| Parameters | taskARN
|
Task Reference Number | The AWS reference number of the AWS DataSync Task to execute. | String | In |
|
|
| Parameters | exclude
|
Exclusion filter | List of filter rules specifying files to be excluded by the Task (for example, /*.txt). |
String | In |
|
|
| Parameters | include
|
Inclusion filter | List of filter rules specifying files to be included in the Task (for example, /example*). |
String | In |
|
|
| Parameters | taskExecutionARN
|
Task Execution Reference Number | The reference number of the Task that is executed when the Job is run. | String | Out |
|
|