AWS AppFlow Connector 1.0.0.0
The AWS AppFlow Connector lets you list, import, and run AWS AppFlow flows.
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 AppFlow Connector.
- AWS Utilities 1.0.0.1 or later. This will be installed or updated automatically if necessary when you install the AWS AppFlow Connector.
- An AWS Connection.
- Privileges Required to Use the AWS AppFlow Connector.
Contents
| Object Type | Name | Description |
|---|---|---|
| Folder | GLOBAL.Redwood.REDWOOD.AWS.REDWOOD.AppFlow | Integration Connector with AWS AppFlow (1.0.0.0) |
| Constraint Definition | REDWOOD.Redwood_AWS_AppFlow_Constraint | Constraint for AWS AppFlow Flow in the specified region |
| Job Definition | REDWOOD.Redwood_AWS_AppFlow_ImportFlows | Imports AWS AppFlow Flows |
| Job Definition | REDWOOD.Redwood_AWS_AppFlow_ListFlows | Lists AWS AppFlow Flows |
| Job Definition | REDWOOD.Redwood_AWS_AppFlow_StartFlow | Starts an AWS AppFlow Flow |
| Job Definition Type | REDWOOD.Redwood_AWS_AppFlow | AWS AppFlow Definition Type |
| Library | REDWOOD.Redwood_AWS_AppFlow | Library for AWS AppFlow Connector |
Setup
To install the AWS AppFlow Connector:
-
Click its tile in the Catalog, select the version you want, and then click Install <version number>.
-
Create an AWS Connection.
Job Definitions
Redwood_AWS_AppFlow_ListFlows
Returns a list of AWS AppFlow Flows in RTX format.
Note: Both scheduled and on-demand Flows are listed, even though you will most likely only want to run on-demand Flows.
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. | String | In |
|
|
| Parameters | flowName
|
Flow Name Filter | A filter that lets you specify which AWS AppFlow Flows should be included. If this field is blank, all available AWS AppFlow Flows are listed. Wildcards * and ? are supported. | String | In |
|
|
| Parameters | listing
|
Flow Listing | A link to the generated RTX file. | Table | Out |
|
|
Redwood_AWS_AppFlow_ImportFlows
Lets you import on-demand AWS AppFlow Flows as Job Definitions.
Note: Only on-demand Flows can be imported.
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. | String | In |
|
|
| Parameters | flowName
|
Flow Name Filter | A filter that lets you specify which AWS AppFlow Flows should be imported. If this field is blank, all available AWS AppFlow Flows are imported. 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 a Job Definition already exists for a given AWS Glue job. | String | In | N | Y=Yes, N=No |
| Generation Settings | partition
|
Partition | The Partition to create the imported Job Definitions in. | String | In |
|
QueryFilter:User.Redwood System.Partition.Partition%2e;all |
| Generation Settings | defaultQueue
|
Default Queue | The Queue to assign to the imported Job Definitions. | String | In |
|
QueryFilter:User.Redwood System.Queue.Queue%2e;all |
| Generation Settings | application
|
Application | The Folder to create the imported Job Definitions in. | String | In |
|
QueryFilter:User.Redwood System.Application.Application%2e;all |
| Generation Settings | definitionNamePrefix
|
Definition Name Prefix | Prefix for the imported Job Definition names. | String | In | CUS_AWSF_
|
|
Redwood_AWS_AppFlow_StartFlow
Lets you start an AWS AppFlow Flow. You can duplicate this Job Definition to start different Flows.
Note: Only on-demand Flows can be started.
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. | String | In |
|
|
| Parameters | flowName
|
Flow Name | The name of the AWS AppFlow Flow. | String | In |
|
|
| Parameters | executionId
|
Execution Id | The execution ID of the AWS AppFlow Flow run. | String | Out |
|
|
Procedures
Listing AWS AppFlow Flows
You can use the Redwood_AWS_AppFlow_ListFlows Job Definition to query for AWS AppFlow Flows. This Job Definition returns the list of AWS AppFlow jobs in RTX format, so that you can use it in a Workflow Definition.
To list AWS AppFlow Flows:
-
In the Redwood > AWS > AppFlow Folder, run the Redwood_AWS_AppFlow_ListJobs Job Definition.
-
Choose the Connection.
-
Choose the Region the AWS AppFlow Flows are in.
-
Optionally, to limit the results, enter a Flow Name Filter. You can use the wildcard characters ? and *.
-
Submit the Job Definition.
-
In the Monitor screen, select the Job, then look at the Detail View. Under Files, the
listing.rtxfile contains the response (if any).
Importing AWS AppFlow Flows
To import AWS AppFlow Flows as Job Definitions:
-
In the Redwood > AWS > AppFlow Folder, run the Redwood_AWS_AppFlow_ImportFlows Job Definition.
-
Choose the Connection.
-
Choose the Region the AWS AppFlow Flows are in.
-
Optionally, to limit the results, enter a Flow Name Filter. You can use the wildcard characters ? and *.
-
Switch to the Generation Settings tab.
- To indicate whether to overwrite any matching AWS AppFlow Job Definitions you've already imported, choose an option from the Overwrite Existing Definition dropdown list.
- Optionally specify a Partition, Default Queue, and Application.
- To specify a prefix to be applied to the names of the imported AWS AppFlow Job Definitions, enter a value in the Prefix field.
-
Run the Job Definition.
Starting an AWS AppFlow Flow
To start an AWS AppFlow Flow:
-
In the Redwood > AWS > AppFlow Folder, run the Redwood_AWS_AppFlow_StartFlow Job Definition.
-
Choose the Connection.
-
Choose the Region the AWS AppFlow Flow is in.
-
Enter the AWS AppFlow Flow Name.
-
Run the Job Definition.