aws_sdk 3.1.5

data/lib/aws/auto_scaling/tag.rb

@@ -0,0 +1,59 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class AutoScaling
+
+    # Auto Scaling tags are hashes with two helper methods:
+    #
+    # * {#resource}
+    # * {#delete}
+    #
+    class Tag < Hash
+
+      # @private
+      def initialize options = {}
+
+        super()
+
+        @resource = 
+          case options[:resource_type]
+          when 'auto-scaling-group' 
+            group_name = options[:resource_id]
+            config = options.delete(:config)
+            Group.new(group_name, :config => config)
+          else 
+            msg = "unhandled resource type: #{options[:resource_type]}"
+            raise ArgumentError, msg
+          end
+
+        merge!(options)
+
+      end
+
+      # @return [Group] Returns the tagged resource.  Currently this is
+      #   always an Auto Scaling group.
+      def resource
+        @resource
+      end
+
+      # Deletes the tag from the resource.
+      # @return [nil]
+      def delete
+        resource.delete_tags([self])
+        nil
+      end
+
+    end
+  end
+end

data/lib/aws/auto_scaling/tag_collection.rb

@@ -0,0 +1,112 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class AutoScaling
+
+    # Provides an interface for enumerating tags defined in Auto Scaling.
+    #
+    #   auto_scaling = AWS::AutoScaling.new
+    #   auto_scaling.tags.each do |tag|
+    #      puts "#{tag.key}:#{tag.value}"
+    #   end
+    #
+    # == Filters
+    #
+    # You can filter the tags returned using {#filter}:
+    #
+    #   # returns tags with the key "role"
+    #   auto_scaling.filter(:key, 'role').to_a
+    #
+    #   # returns tags with the key "role" and value "webserver"
+    #   auto_scaling.filter(:key, 'role').filter(:value, 'webserver')to_a
+    #
+    #   # returns tags with the Auto Scaling group name "group1"
+    #   auto_scaling.filter(:auto_scaling_group, 'group1').to_a
+    #
+    #   # returns all tags that propagate at launch
+    #   auto_scaling.filter(:propagate_at_launch, true).to_a
+    #
+    # == Creating Tags
+    #
+    # You can create Auto Scaling tags when you:
+    #
+    # * [create]{GroupCollection#create} an Auto Scaling group
+    # * [update]{Group#update} an Auto Scaling group
+    #
+    # Both of these methods accept a +:tags+ option.
+    #
+    #   tags = [
+    #     { :key => 'auto-scaling-instance' },       # tag name only
+    #     { :key => 'role', :value => 'webserver' }, # tag name and value
+    #   ]
+    #
+    #   # creating a group with tags
+    #   group = auto_scaling.groups.create('group-name', :tags => tags, ...)
+    #
+    #   # updating a group's tags
+    #   group.update(:tags => tags)
+    # 
+    class TagCollection
+
+      include Core::Collection::Limitable
+
+      # @private
+      def initialize options = {}
+        @filters = options.delete(:filters) || []
+        super
+      end
+      
+      # Filters the tags by the given filter name and value(s).
+      #
+      #   # return tags with the key "role" and the value "webserver"
+      #   auto_scaling.tags.filter(:key, 'role').filer(:value, 'webserver')
+      # 
+      # @param [Symbol] name Valid filter names include:
+      #
+      #   * :key
+      #   * :value
+      #   * :propagate_at_launch
+      #   * :auto_scaling_group
+      #
+      # @param [Array<String>] values
+      #
+      # @return [TagCollection]
+      #
+      def filter name, *values
+        name = name.to_s.gsub(/_/, '-')
+        values = values.flatten.map(&:to_s)
+        filter = { :name => name, :values => values }
+        TagCollection.new(:filters => @filters + [filter], :config => config)
+      end
+
+      protected
+
+      def _each_item next_token, limit, options = {}, &block
+
+        options[:next_token] = next_token if next_token
+        options[:max_records] = limit if limit
+        options[:filters] = @filters unless @filters.empty?
+
+        resp = client.describe_tags(options)
+        resp.tags.each do |tag|
+          yield(Tag.new(tag.to_hash.merge(:config => config)))
+        end
+
+        resp.data[:next_token]
+
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_formation.rb

@@ -0,0 +1,270 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/core'
+require 'aws/cloud_formation/config'
+
+module AWS
+
+  # = AWS::CloudFormation
+  #
+  # Provides an expressive, object-oriented interface to AWS CloudFormation.
+  #
+  # == Credentials
+  #
+  # You can setup default credentials for all AWS services via
+  # AWS.config:
+  #
+  #   AWS.config(
+  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # Or you can set them directly on the CloudFormation interface:
+  #
+  #   cf = AWS::CloudFormation.new(
+  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # = Stacks
+  #
+  # This is the starting point for working with CloudFormation.
+  #
+  # == Creating a Stack
+  #
+  # You can create a CloudFormation stack with a name and a template.
+  #
+  #   template = <<-TEMPLATE
+  #   {
+  #     "AWSTemplateFormatVersion" : "2010-09-09",
+  #     "Description": "A simple template",
+  #     "Resources": {
+  #       "web": {
+  #         "Type": "AWS::EC2::Instance",
+  #         "Properties": {
+  #           "ImageId": "ami-41814f28"
+  #         }
+  #       }
+  #     }
+  #   }
+  #   TEMPLATE
+  #
+  #   cfm = AWS::CloudFormation.new
+  #   stack = cfm.stacks.create('stack-name', template)
+  #
+  # See {StackCollection#create} for more information on creating templates
+  # with capabilities and parameters.
+  #
+  # == Getting a Stack
+  # 
+  # Given a name, you can fetch a {Stack}.
+  #
+  #   stack = cfm.stacks['stack-name']
+  #
+  # == Enumerating Stacks
+  #
+  # You can enumerate stacks in two ways.  You can enumerate {Stack}
+  # objects or stack summaries (simple hashes).  You can filter the stack
+  # summary collection by a status.
+  #
+  #   # enumerating all stack objects
+  #   cfm.stacks.each do |stack|
+  #     # ...
+  #   end
+  #
+  #   # enumerating stack summaries (hashes)
+  #   cfm.stack_summaries.each do |stack_summary|
+  #     # ...
+  #   end
+  #
+  #   # filtering stack summaries by status
+  #   cfm.stack_summaries.with_status(:create_failed).each do |summary|
+  #     puts summary.to_yaml
+  #   end
+  #
+  # == Template
+  #
+  # You can fetch the template body for a stack as a JSON string.
+  #
+  #   cfm.stacks['stack-name'].template
+  #   #=> "{...}"
+  #
+  # You can update the template for a {Stack} with the {Stack#update} method:
+  #
+  #   cfm.stacks['stack-name'].update(:template => new_template)
+  #
+  # == Stack Events
+  #
+  # You can enumerate events for a stack.
+  #
+  #   stack.events.each do |event|
+  #     puts "#{event.physical_resource_id}: #{event.resource_status}"
+  #   end
+  #
+  # See {StackEvent} for a complete list of event attributes.
+  #
+  # == Stack Resources
+  #
+  # You can enumerate stack resources or request a stack resource by its
+  # logical resource id.
+  #
+  #   # enumerating stack resources
+  #   stack.resources.each do |resource|
+  #     # ...
+  #   end
+  #
+  #   # getting a resource by its logical id
+  #   res = stack.resources['logical-resource-id']
+  #   puts res.physical_resource_id
+  #
+  # If you need a stack resource, but only have its physical resource 
+  # id, then you can call {CloudFormation#stack_resource}.
+  #
+  #   stack_resource = cfm.stack_resource('physical-resource-id')
+  #
+  # == Stack Resource Summaries
+  #
+  # As an alternative to stack resources, you can enumerate stack
+  # resource summaries (hashes).
+  #
+  #   # enumerate all resources, this collection can not be filtered
+  #   stack.resource_summaries.each do |summary|
+  #     # ...
+  #   end
+  #
+  class CloudFormation
+
+    AWS.register_autoloads(self, 'aws/cloud_formation') do
+      autoload :Client, 'client'
+      autoload :Errors, 'errors'
+      autoload :Request, 'request'
+      autoload :Stack, 'stack'
+      autoload :StackCollection, 'stack_collection'
+      autoload :StackEvent, 'stack_event'
+      autoload :StackEventCollection, 'stack_event_collection'
+      autoload :StackOptions, 'stack_options'
+      autoload :StackOutput, 'stack_output'
+      autoload :StackSummaryCollection, 'stack_summary_collection'
+      autoload :StackResource, 'stack_resource'
+      autoload :StackResourceCollection, 'stack_resource_collection'
+      autoload :StackResourceSummaryCollection, 'stack_resource_summary_collection'
+    end
+
+    include Core::ServiceInterface
+    include StackOptions
+
+    # @return [StackCollection]
+    def stacks
+      StackCollection.new(:config => config)
+    end
+
+    # @return [StackSummaryCollection]
+    def stack_summaries
+      StackSummaryCollection.new(:config => config)
+    end
+
+    # Returns a stack resource with the given physical resource
+    # id.  
+    #
+    #   resource = cfm.stack_resource('i-123456789')
+    #
+    # Alternatively, you may pass a stack name and logical resource id:
+    #
+    #   resource = cfm.stack_resource('stack-name', 'logical-resource-id')
+    #
+    # @overload stack_resource(physical_resource_id)
+    #   @param [String] physical_resource_id The physical resource id
+    #     of the stack resource you want returned.
+    #
+    # @overload stack_resource(stack_name, logical_resource_id)
+    #   @param [String] stack_name
+    #   @param [String] logical_resource_id
+    #
+    # @return [StackResource] Returns the stack resource with the
+    #   given physical resource id.
+    #
+    def stack_resource *args
+
+      client_opts = {}
+
+      if args.size == 1
+        client_opts[:physical_resource_id] = args.first
+      else
+        client_opts[:stack_name] = args[0]
+        client_opts[:logical_resource_id] = args[1]
+      end
+
+      response = client.describe_stack_resources(client_opts)
+
+      details = response.stack_resources.first
+
+      StackResource.new_from(
+        :describe_stack_resource, details,
+        Stack.new(details.stack_name, :config => config),
+        details.logical_resource_id)
+
+    end
+
+    # Validates the template and returns a hash.  If the template is valid,
+    # the returned hash may/will contain the following keys (actual
+    # key list depends on the template).
+    #
+    #   * +:description+
+    #   * +:capabilities+
+    #   * +:capabilities_reason+
+    #   * +:parameters+
+    #
+    # If the template is not parseable, then a hash will the following
+    # keys will be returned:
+    #
+    #   * +:code+
+    #   * +:message+
+    #
+    # @return [Hash]
+    # 
+    def validate_template template
+      begin
+
+        client_opts = {}
+        client_opts[:template] = template
+        apply_template(client_opts)  
+        client.validate_template(client_opts).data
+
+      rescue CloudFormation::Errors::ValidationError => e
+
+        results = {}  
+        results[:code] = e.code
+        results[:message] = e.message
+        results
+
+      end
+    end
+
+    # @param (see Stack#template=)
+    #
+    # @param [Hash] parameters A hash that specifies the input 
+    #   parameters for the template.
+    #
+    # @return [String] Returns a URL to the AWS Simple Monthly Calculator 
+    #   with a query string that describes the resources required to run 
+    #   the template.
+    #
+    def estimate_template_cost template, parameters = {}
+      client_opts = {}
+      client_opts[:template] = template
+      apply_template(client_opts)  
+      apply_parameters(client_opts)  
+      client.estimate_template_cost(client_opts).url
+    end
+
+  end
+end

data/lib/aws/cloud_formation/client.rb

@@ -0,0 +1,339 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudFormation
+
+    # Client class for AWS CloudFormation.
+    class Client < Core::Client
+
+      API_VERSION = '2010-05-15'
+
+      extend Core::Client::QueryXML
+
+      # @private
+      CACHEABLE_REQUESTS = Set[
+        :describe_adjustment_types,
+        :describe_auto_scaling_groups,
+        :describe_auto_scaling_instances,
+        :describe_auto_scaling_notification_types,
+        :describe_launch_configurations,
+        :describe_metric_collection_types,
+        :describe_notification_configurations,
+        :describe_policies,
+        :describe_scaling_activities,
+        :describe_scaling_process_types,
+        :describe_scheduled_actions,
+        :describe_tags,
+      ]
+
+      ## client methods ##
+
+      # Calls the CreateStack API operation.
+      # @method create_stack(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - *required* - (String)
+      # * +:template_body+ - (String)
+      # * +:template_url+ - (String)
+      # * +:parameters+ - (Array<Hash>)
+      #   * +:parameter_key+ - (String)
+      #   * +:parameter_value+ - (String)
+      # * +:disable_rollback+ - (Boolean)
+      # * +:timeout_in_minutes+ - (Integer)
+      # * +:notification_ar_ns+ - (Array<String>)
+      # * +:capabilities+ - (Array<String>)
+      # * +:on_failure+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:stack_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :create_stack, 'CreateStack'
+
+      # Calls the CreateUploadBucket API operation.
+      # @method create_upload_bucket(options = {})
+      #
+      # === Options:
+      #
+      # This method accepts no options.
+      #
+      # === Response Structure:
+      #
+      # * +:bucket_name+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :create_upload_bucket, 'CreateUploadBucket'
+
+      # Calls the DeleteStack API operation.
+      # @method delete_stack(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - *required* - (String)
+      #
+      # === Response Structure:
+      #
+      # This method returns no response data.
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :delete_stack, 'DeleteStack'
+
+      # Calls the DescribeStackEvents API operation.
+      # @method describe_stack_events(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - (String)
+      # * +:next_token+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:stack_events+ - (Array<Hash>)
+      #   * +:stack_id+ - (String)
+      #   * +:event_id+ - (String)
+      #   * +:stack_name+ - (String)
+      #   * +:logical_resource_id+ - (String)
+      #   * +:physical_resource_id+ - (String)
+      #   * +:resource_type+ - (String)
+      #   * +:timestamp+ - (Time)
+      #   * +:resource_status+ - (String)
+      #   * +:resource_status_reason+ - (String)
+      #   * +:resource_properties+ - (String)
+      # * +:next_token+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :describe_stack_events, 'DescribeStackEvents'
+
+      # Calls the DescribeStackResource API operation.
+      # @method describe_stack_resource(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - *required* - (String)
+      # * +:logical_resource_id+ - *required* - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:stack_resource_detail+ - (Hash)
+      #   * +:stack_name+ - (String)
+      #   * +:stack_id+ - (String)
+      #   * +:logical_resource_id+ - (String)
+      #   * +:physical_resource_id+ - (String)
+      #   * +:resource_type+ - (String)
+      #   * +:last_updated_timestamp+ - (Time)
+      #   * +:resource_status+ - (String)
+      #   * +:resource_status_reason+ - (String)
+      #   * +:description+ - (String)
+      #   * +:metadata+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :describe_stack_resource, 'DescribeStackResource'
+
+      # Calls the DescribeStackResources API operation.
+      # @method describe_stack_resources(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - (String)
+      # * +:logical_resource_id+ - (String)
+      # * +:physical_resource_id+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:stack_resources+ - (Array<Hash>)
+      #   * +:stack_name+ - (String)
+      #   * +:stack_id+ - (String)
+      #   * +:logical_resource_id+ - (String)
+      #   * +:physical_resource_id+ - (String)
+      #   * +:resource_type+ - (String)
+      #   * +:timestamp+ - (Time)
+      #   * +:resource_status+ - (String)
+      #   * +:resource_status_reason+ - (String)
+      #   * +:description+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :describe_stack_resources, 'DescribeStackResources'
+
+      # Calls the DescribeStacks API operation.
+      # @method describe_stacks(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:stacks+ - (Array<Hash>)
+      #   * +:stack_id+ - (String)
+      #   * +:stack_name+ - (String)
+      #   * +:description+ - (String)
+      #   * +:parameters+ - (Array<Hash>)
+      #     * +:parameter_key+ - (String)
+      #     * +:parameter_value+ - (String)
+      #   * +:creation_time+ - (Time)
+      #   * +:last_updated_time+ - (Time)
+      #   * +:stack_status+ - (String)
+      #   * +:stack_status_reason+ - (String)
+      #   * +:disable_rollback+ - (Boolean)
+      #   * +:notification_ar_ns+ - (Array<String>)
+      #   * +:timeout_in_minutes+ - (Integer)
+      #   * +:capabilities+ - (Array<String>)
+      #   * +:outputs+ - (Array<Hash>)
+      #     * +:output_key+ - (String)
+      #     * +:output_value+ - (String)
+      #     * +:description+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :describe_stacks, 'DescribeStacks'
+
+      # Calls the EstimateTemplateCost API operation.
+      # @method estimate_template_cost(options = {})
+      #
+      # === Options:
+      #
+      # * +:template_body+ - (String)
+      # * +:template_url+ - (String)
+      # * +:parameters+ - (Array<Hash>)
+      #   * +:parameter_key+ - (String)
+      #   * +:parameter_value+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:url+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :estimate_template_cost, 'EstimateTemplateCost'
+
+      # Calls the GetTemplate API operation.
+      # @method get_template(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - *required* - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:template_body+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :get_template, 'GetTemplate'
+
+      # Calls the ListStackResources API operation.
+      # @method list_stack_resources(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - *required* - (String)
+      # * +:next_token+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:stack_resource_summaries+ - (Array<Hash>)
+      #   * +:logical_resource_id+ - (String)
+      #   * +:physical_resource_id+ - (String)
+      #   * +:resource_type+ - (String)
+      #   * +:last_updated_timestamp+ - (Time)
+      #   * +:resource_status+ - (String)
+      #   * +:resource_status_reason+ - (String)
+      # * +:next_token+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :list_stack_resources, 'ListStackResources'
+
+      # Calls the ListStacks API operation.
+      # @method list_stacks(options = {})
+      #
+      # === Options:
+      #
+      # * +:next_token+ - (String)
+      # * +:stack_status_filter+ - (Array<String>)
+      #
+      # === Response Structure:
+      #
+      # * +:stack_summaries+ - (Array<Hash>)
+      #   * +:stack_id+ - (String)
+      #   * +:stack_name+ - (String)
+      #   * +:template_description+ - (String)
+      #   * +:creation_time+ - (Time)
+      #   * +:last_updated_time+ - (Time)
+      #   * +:deletion_time+ - (Time)
+      #   * +:stack_status+ - (String)
+      #   * +:stack_status_reason+ - (String)
+      # * +:next_token+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :list_stacks, 'ListStacks'
+
+      # Calls the UpdateStack API operation.
+      # @method update_stack(options = {})
+      #
+      # === Options:
+      #
+      # * +:stack_name+ - *required* - (String)
+      # * +:template_body+ - (String)
+      # * +:template_url+ - (String)
+      # * +:parameters+ - (Array<Hash>)
+      #   * +:parameter_key+ - (String)
+      #   * +:parameter_value+ - (String)
+      # * +:capabilities+ - (Array<String>)
+      #
+      # === Response Structure:
+      #
+      # * +:stack_id+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :update_stack, 'UpdateStack'
+
+      # Calls the ValidateTemplate API operation.
+      # @method validate_template(options = {})
+      #
+      # === Options:
+      #
+      # * +:template_body+ - (String)
+      # * +:template_url+ - (String)
+      #
+      # === Response Structure:
+      #
+      # * +:parameters+ - (Array<Hash>)
+      #   * +:parameter_key+ - (String)
+      #   * +:default_value+ - (String)
+      #   * +:no_echo+ - (Boolean)
+      #   * +:description+ - (String)
+      # * +:description+ - (String)
+      # * +:capabilities+ - (Array<String>)
+      # * +:capabilities_reason+ - (String)
+      #
+      # @return [Core::Response]
+      #
+      define_client_method :validate_template, 'ValidateTemplate'
+
+      ## end client methods ##
+
+    end
+  end
+end