# SYNOPSIS
Sparrow plugin to run aws instance.
# INSTALL
```
s6 --install aws-run-instance
```
# USAGE
## Basic usage
Cli:
To run instance you should set necessary 3 parameters:
```
s6 --plg-run aws-run-instance@subnet=net01,image=ami-bla-bla,type=t2.micro
```
The command will return JSON data upon successful instance creation. You'll grep instance ID for further work with instance.
Raku:
```
task-run "new instance", "aws-run-instance", %(
image => "ami-bla-bla-bla",
type => "t2.micro",
subnet => "subnet-bla-bla-bla",
);
```
## Setting tags
To keep track of your instances you create with sparrow plugin you can use tag.
Cli:
```
s6 --plg-run aws-run-instance@tag_key=foo,tag_value=bar
```
Raku:
```
task-run "new instance", "aws-run-instance", %(
image => "ami-bla-bla-bla",
type => "t2.micro",
subnet => "subnet-bla-bla-bla",
tag_key => "foo",
tag_vakue => "bar",
);
```
## Setting key name
To set name of the key pair, use `key` parameter:
```
s6 --plg-run aws-run-instance@key=support_account ...
```
Raku:
```
task-run "new instance", "aws-run-instance", %(
image => "ami-bla-bla-bla",
type => "t2.micro",
subnet => "subnet-bla-bla-bla",
key => "SupportAccount"
);
```
More about key pair read at the aws doc pages - [http://docs.aws.amazon.com/cli/latest/reference/ec2/run-instances.html](http://docs.aws.amazon.com/cli/latest/reference/ec2/run-instances.html)
## Assigning public IP
Set `associate_public_ip` to "on" if you want a public IP address to be assigned to the new instance in a VPC.
Example:
```
task-run "new instance", "aws-run-instance", %(
image => "ami-bla-bla-bla",
type => "t2.micro",
subnet => "subnet-bla-bla-bla",
associate_public_ip => "on"
);
```
## Adding one or more security group names
Set `sec_groups`
```
task-run "new instance", "aws-run-instance", %(
image => "ami-bla-bla-bla",
type => "t2.micro",
subnet => "subnet-bla-bla-bla",
sec_groups => "sg-12345 sg-6789 sg-121344"
);
```
# Author
Alexey Melezhik
# Prerequisites
Aws cli should be installed