Amazon Web Services plugin

This cloud provider plugin enables integration with Amazon Web Services.


This plugin requires to have an Amazon Web Services account. If you don't have one, you can sign up on AWS site. AWS resources will be synchronised with RapidDeploy, so an initial setup of AWS resources is required (creation of key-pairs, setting security groups).


Getting started with AWS plugin

The AWS plugin can be switched on in the Server menu on Cloud tab by selecting it from the drop down list. If the plugin is selected, that means all deployments will run on the selected instance. The AWS resources can be selected on the panel after synchronisation. To be able to synchronise, you have to provide the access and secret keys of your account and a client endpoint. All AWS objects are grouped based on the client endpoints (regions), so the created key pairs, security groups and instances are accessible in the same region.



Synchronise all your AWS resources to RapidDeploy. You will need to fill the access key, secret key and endpoint fields to perform this operation.

View instance

You can view the attributes and status of an instance selected from the instances drop down list.

View security groups

You can select multiple security groups, and check the rules specified for them.

View cloud images

List the owned AMIs with their attributes and status.

Manage addresses

Manage AWS EC2 Elastic IPs for your instances. You can allocate new addresses, and associate them with your instances so they will have permanent IPs.

Creating an instance

To create an instance, you must specify the instance attributes on the panel.

  • AMI id: you can choose on of our predefined images, or check for public images. Click on the help button next to the field to see the options.
  • Instance type: you can choose from a set of server types to get the performance you need. Click on the help button next to the field to see the type descriptions.
  • Key name: choose a key name from your previously defined keys. You will need the key file in case of using SSH deployment.
  • Security groups: choose one ore more security groups for your cloud instance. Don't forget to permit the RD Agents primary and bind ports (by default 20000, 20001) in case of using remote agent.
  • Instance name: define a name for your instance, to be able to identify it later on.

Terminate instance

Terminate the selected instance.

Start instance

Start the selected instance.

Restart instance

Restart the selected instance.

Stop instance

Stop the selected instance.

Create image

Create a snapshot from the selected instance. Specify name and description for the image. Hint: you can clone your instances by creating an image, then check the AMI name in View cloud images, then create a new instance with the snapshot AMI id.

Deploy to cloud

The deployments will run on the selected instance (selection is made on saving the Server panel). The instance's hostname will updated on the General tab. Note that AWS instances only get their hostname and ip address when they are running.

  • Start instance on deployment: check this box to start the instance on deployment. If it is checked, deployments can be made on stopped and running instances, otherwise only on running instances.

Deploying to AWS Windows servers

When deploying to AWS Windows servers using the RapidDeploy agent, you may need to add the hostname of the Windows server into the local hosts file on the RapidDeploy server. Example /etc/hosts entry:    WIN-AHJ779LMINP 

Where is the public IP address used in the server configuration in RapidDeploy and WIN-AHJ779LMINP is the Windows hostname, obtainable by running the 'hostname' command on the Windows server.

Attributes and parameters

List and description of all user interface plugin parameters.