aws-flow-utils

The aws-flow-utils utility can be used to generate application skeletons suitable for running locally or hosted on Amazon EC2 using Elastic Beanstalk. It is provided with the AWS Flow Framework for Ruby beginning with version 2.4.0.

Basic syntax:

aws-flow-utils -c TYPE -n APPNAME [OPTIONS]

At the minimum, you must specify the type of application to create (either local or eb) and give it a name. If you specify eb, then aws-flow-utils will create an application that you can deploy using Elastic Beanstalk. For more information about deploying a workflow using Elastic Beanstalk, see Deploying Workflows with Elastic Beanstalk.

Options Reference#

There are a number of arguments that you can specify when running aws-flow-utils:

Option Description
-c, --command TYPE

Required. Create a project of the specified TYPE. You can specify either:

  • local to build a locally-executable Amazon SWF application.
  • eb to build an Amazon SWF application configured for use with AWS Elastic Beanstalk.

Note

on Windows, local will create an activity worker that sets number_of_forks_per_worker in the resulting :filename:`worker.json` file to zero, turning forking off. For more information, see Using the Framework on Microsoft Windows.
-n, --name NAME Required. Set the name of the application.
-r, --region REGION

Optional. Set the AWS Region. If this argument is not specified, the default value is taken from the environment variable AWS_REGION.

If AWS_REGION is not set, then this argument is required.

-p, --path PATH Optional. Set the location where the application will be created. The default is in the local directory (.).
-a, --act_path PATH Optional. Sets the path to an activity class that will be copied into your project. If this argument is not specified, then an empty activity.rb file will be generated that you can fill in yourself.
-w, --wf_path PATH Optional. A path to a workflow class that will be copied into your project.
-A, --activities x,y,z Optional. Set the names of activity classes within the file set using the --act_path argument. This argument is only necessary if your activity classes are not based on the Activities class.
-W, --workflows x,y,z Optional. Set the names of workflow classes within the file set using the --wf_path option. This option is only necessary if your workflow classes are not based on the Workflows class.

Tip

There's no need to memorize this list; you can use aws-flow-utils --help to get a list of the command syntax and available options.

On this page: