1
0
Fork 0
mirror of https://github.com/fog/fog-aws.git synced 2022-11-09 13:50:52 -05:00
Module for the 'fog' gem to support Amazon Web Services http://aws.amazon.com/
Find a file
2016-01-20 09:59:43 -07:00
gemfiles code climate test coverage 2015-01-05 10:30:43 -08:00
lib/fog Added ap-northeast-2 to the fog mocks. Also added mime-types to the gemfile because the specs for fog-aws won't actually run without it. 2016-01-19 10:29:59 -07:00
tests mock instance stop and start properly 2015-09-22 14:28:41 -04:00
.gitignore get signin token for federation 2015-01-29 12:44:50 -05:00
.travis.yml add codeclimate 2015-01-05 09:11:37 -08:00
CHANGELOG.md 0.7.6 changelog 2015-08-26 14:38:19 -07:00
CONTRIBUTING.md update OS bits 2015-01-12 10:38:23 -06:00
CONTRIBUTORS.md update OS bits 2015-01-12 10:38:23 -06:00
fog-aws.gemspec Add support for AWS Lambda service 2015-06-23 09:53:53 -03:00
Gemfile Removing the mime-types gem from Gemfile since upstream already has this change. 2016-01-20 09:59:43 -07:00
LICENSE.md update OS bits 2015-01-12 10:38:23 -06:00
Rakefile working tests 2015-01-02 09:42:20 -08:00
README.md Fix repository URL in README.md 2015-04-17 18:36:56 +09:00

Fog::Aws

Gem Version Build Status Dependency Status Test Coverage Code Climate

Installation

Add this line to your application's Gemfile:

gem 'fog-aws'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fog-aws

Usage

Before you can use fog-aws, you must require it in your application:

require 'fog/aws'

Since it's a bad practice to have your credentials in source code, you should load them from default fog configuration file: ~/.fog. This file could look like this:

default:
  aws_access_key_id:     <YOUR_ACCESS_KEY_ID>
  aws_secret_access_key: <YOUR_SECRET_ACCESS_KEY>

Connecting to EC2 service

ec2 = Fog::Compute.new :provider => 'AWS', :region => 'us-west-2'

You can review all the requests available with this service using #requests method:

ec2.requests # => [:allocate_address, :assign_private_ip_addresses, :associate_address, ...]

Launch an EC2 on-demand instance:

response = ec2.run_instances(
  "ami-23ebb513",
  1,
  1,
  "InstanceType"  => "t1.micro",
  "SecurityGroup" => "ssh",
  "KeyName"       => "miguel"
)
instance_id = response.body["instancesSet"].first["instanceId"] # => "i-02db5af4"
instance = ec2.servers.get(instance_id)
instance.wait_for { ready? }
puts instance.public_ip_address # => "356.300.501.20"

Terminate an EC2 instance:

instance = ec2.servers.get("i-02db5af4")
instance.destroy

Fog::AWS is more than EC2 since it supports many services provided by AWS. The best way to learn and to know about how many services are supported is to take a look at the source code. To review the tests directory and to play with the library in irb can be very helpful resources as well.

Contributing

  1. Fork it ( https://github.com/fog/fog-aws/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request