{"id":35257,"date":"2016-06-20T11:11:16","date_gmt":"2016-06-20T05:41:16","guid":{"rendered":"http:\/\/www.tothenew.com\/blog\/?p=35257"},"modified":"2016-06-20T12:34:35","modified_gmt":"2016-06-20T07:04:35","slug":"aws-sdk-ruby-csv-ec2","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/aws-sdk-ruby-csv-ec2\/","title":{"rendered":"Utilizing AWS Ruby SDK to get AWS EC2 details in a CSV file"},"content":{"rendered":"

Over the years, Amazon has been integrating its web services with various programming languages to make it easier for developers<\/a> to utilize\u00a0various AWS resources effectively. It has made specific tools for popular programming languages like Ruby, Python, Java, .NET etc.<\/p>\n

Talking about Ruby, it is a dynamic, reflective, object-oriented, general-purpose programming language. It was designed and developed in the mid-1990s by Yukihiro “Matz” Matsumoto in Japan.<\/p>\n

AWS(Amazon Web Services) SDK<\/strong> for Ruby gives APIs for accessing and building applications over the services provided by AWS. With their\u00a0simple to use SDK, one can perform various operations on AWS resources.
\n\"Screenshot<\/p>\n

Use case<\/h2>\n

This blog shows how to use AWS SDK using Ruby to get AWS EC2 details, which can help to automate<\/a> the creation\u00a0of an inventory file and help save time to a great extent. This way, EC2 details will be fetched and stored in a CSV file which can be easily interpreted.<\/p>\n

Requirements<\/h2>\n
    \n
  • Ruby(v2.2+)<\/li>\n
  • AWS Account (Access Key Id, Secret Key)<\/li>\n
  • Version2 of AWS SDK<\/li>\n<\/ul>\n

     <\/p>\n

    Steps To Follow<\/strong><\/h2>\n

    Download gems<\/strong>:
    \nRubyGems is a package manager for the Ruby programming language that provides a standard format for distributing Ruby programs and libraries (in a self-contained format called a “gem”).<\/p>\n

    [sourcecode language=”ruby”]gem install aws-sdk[\/sourcecode]<\/p>\n

    Create a “<file_name>.rb” file for writing ruby script and to compile and run use “ruby <file_name>.rb”<\/p>\n

    Making a Connection with AWS Account:<\/strong><\/p>\n

    [sourcecode language=”ruby”]require ‘aws-sdk’
    \nrequire ‘rubygems’
    \nAws.config.update({
    \nregion: ‘us-east-1’,
    \ncredentials: Aws::Credentials.new(‘aws_access_key_id’, ‘aws_secret_access_key’)
    \n})[\/sourcecode]<\/p>\n

    Creating an EC2 object:<\/strong>
    \nCreating an EC2 Object by using the Aws object after the connection.
    \nThis object will be used later to fetch EC2 details.<\/p>\n

    [sourcecode language=”ruby”]ec2 = Aws::EC2::Client.new
    \nputs ec2[\/sourcecode]<\/p>\n

    \"client\"
    \nAn EC2 client response is received, this means object is created successfully.<\/p>\n

    Methods allowed on ec2 object:<\/strong>
    \nThis gives a list of operations that can be performed on the EC2 object:<\/p>\n

    [sourcecode language=”ruby”]puts ec2.operation_names[\/sourcecode]<\/p>\n

    \"operation_names\"<\/p>\n

    Using method describe_instances:<\/strong>
    \nUsing describe_instances method to get various details of the EC2 object.<\/p>\n

    [sourcecode language=”ruby”]eresp= ec2.describe_instances
    \nputs eresp[\/sourcecode]<\/p>\n

    \"seahorse_client\"
    \nThe above operation returned a Seahorse Client Response object which has two methods:
    \n1.) reservations
    \n2.) next_token<\/p>\n

    Check if the operation was successful by using the method \u201csuccessful?\u201d on the response:<\/strong><\/p>\n

    [sourcecode language=”ruby”]puts eresp.successful?[\/sourcecode]<\/p>\n

    \"eresp_success\"<\/p>\n

    Using “reservations” method on the received response:<\/strong>
    \nEach instance in the AWS Account gets its own Reservation structure which contains all the details of the instance.<\/p>\n

    [sourcecode language=”ruby”]puts eresp.reservations[\/sourcecode]<\/p>\n

    It returns an array of ruby structures.\"array<\/p>\n

    Iterating over the array and fetching data from the structure:<\/strong>
    \nThe first element of the array can be iterated\/traversed by either using any of the two ways discussed below or by applying for-each loop discussed later.<\/p>\n

    [sourcecode language=”ruby”]eresp.reservations.first
    \neresp.reservations[0][\/sourcecode]<\/p>\n

    Fetching the data:<\/strong>
    \nFetching reservation_id from the reservation:<\/p>\n

    [sourcecode language=”ruby”]puts eresp[:reservations][0][:reservation_id][\/sourcecode]<\/p>\n

    \"reservation_id\"<\/p>\n

    Two different ways to obtain the tag value:<\/p>\n

    [sourcecode language=”ruby”]puts eresp.reservations.first.instances[0].tags[0].value
    \nputs eresp[:reservations][0][:instances][0][:tags][0][:value][\/sourcecode]<\/p>\n

    \"tags-value\"<\/p>\n

    Fetching Data using for-each loop:<\/strong><\/p>\n

    [sourcecode language=”ruby”]eresp[:reservations].each do |reservation|
    \nreservation[:instances].each do |instance|
    \ninstance[:tags].each do |tag|
    \nputs tag[:value]
    \nend
    \nputs instance[:private_ip_address]
    \nputs instance[:image_id]
    \nputs instance[:state][:name]
    \nputs instance[:instance_type]
    \nend
    \nend[\/sourcecode]<\/p>\n

    \"data_fetched\"<\/p>\n

    Putting data in a CSV file:<\/strong>
    \nPutting all the fetched data in a CSV file (test.csv) using File class and using its new() method, ‘a+’ to append data to the file.<\/p>\n

    [sourcecode language=”ruby”]eresp[:reservations].each do |reservation|
    \nreservation[:instances].each do |instance|
    \ninstance[:tags].each do |tag|
    \nfile=File.new(‘test.csv’,’a+’)
    \nfile.write tag[:value] + "\\t"
    \nfile.write instance[:private_ip_address] + "\\t"
    \nfile.write instance[:image_id] + "\\t"
    \nfile.write instance[:state][:name] + "\\t"
    \nfile.write instance[:instance_type] + "\\t"
    \nfile.write instance[:architecture] + "\\t"
    \nfile.write instance[:hypervisor] + "\\t"
    \nfile.write instance[:client_token] + "\\t"
    \nfile.write instance[:key_name] + "\\t"
    \nfile.write instance[:root_device_type] + "\\t"
    \nfile.write instance[:state][:name] + "\\t"
    \nfile.write instance[:virtualization_type] + "\\t"
    \nfile.puts
    \nend
    \nend
    \nend[\/sourcecode]<\/p>\n

    \"data_in_csv\"<\/p>\n

    Hope this blog gave you a kick-start on using AWS Ruby SDK. I will be coming up with more such blogs soon.<\/p>\n","protected":false},"excerpt":{"rendered":"

    Over the years, Amazon has been integrating its web services with various programming languages to make it easier for developers to utilize\u00a0various AWS resources effectively. It has made specific tools for popular programming languages like Ruby, Python, Java, .NET etc. Talking about Ruby, it is a dynamic, reflective, object-oriented, general-purpose programming language. It was designed […]<\/p>\n","protected":false},"author":913,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":3},"categories":[1174,2348],"tags":[248,1547,3528,3527,3442,3524,3526,3525,3523,980,3522],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/35257"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/913"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=35257"}],"version-history":[{"count":0,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/35257\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=35257"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=35257"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=35257"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}