aws-sdk 1.3.9 → 1.4.0

data/lib/aws/cloud_formation/client.rb

@@ -0,0 +1,33 @@
+# 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
+    class Client < Core::Client
+
+      AWS.register_autoloads(self, 'aws/cloud_formation/client') do
+        autoload :XML, 'xml'
+      end
+
+      include Core::ConfiguredClientMethods
+
+      API_VERSION = '2010-05-15'
+
+      # @private
+      REQUEST_CLASS = CloudFormation::Request
+
+      configure_client
+
+    end
+  end
+end

data/lib/aws/cloud_formation/client/xml.rb

@@ -0,0 +1,32 @@
+# 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
+    class Client < Core::Client
+      # @private
+      module XML
+
+        include Core::ConfiguredXmlGrammars
+        extend Core::IgnoreResultElement
+
+        BaseError = Core::XmlGrammar.customize do
+          element("Error") { ignore }
+        end
+
+        define_configured_grammars
+
+      end
+    end
+  end
+end

data/lib/aws/cloud_formation/config.rb

@@ -0,0 +1,18 @@
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'CloudFormation', 'cloud_formation', 'cloudformation.us-east-1.amazonaws.com'
+
+end

data/lib/aws/cloud_formation/errors.rb

@@ -0,0 +1,26 @@
+# 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
+
+    # @private
+    module Errors
+
+      BASE_ERROR_GRAMMAR = Client::XML::BaseError
+
+      include Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/cloud_formation/request.rb

@@ -0,0 +1,30 @@
+# 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
+
+    # @private
+    class Request < Core::Http::Request
+
+      include Core::AuthorizeV4
+      include Core::AuthorizeWithSessionToken
+
+      def service
+        'cloudformation'
+      end
+
+    end
+
+  end
+end

data/lib/aws/cloud_formation/stack.rb

@@ -0,0 +1,255 @@
+# 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
+
+    # @attr_reader [String] template Returns the stack's template as a JSON 
+    #   string.
+    #
+    # @attr_reader [Time] creation_time The time the stack was created.
+    #
+    # @attr_reader [Time,nil] last_updated_time The time the stack was 
+    #   last updated.
+    #
+    # @attr_reader [String] stack_id Unique stack identifier.
+    #
+    # @attr_reader [Symbol] status The status of the stack.
+    #
+    # @attr_reader [String] status_reason Success/Failure message 
+    #   associated with the +status+.
+    #
+    # @attr_reader [Array<String>] capabilities The capabilities 
+    #   allowed in the stack.
+    #
+    # @attr_reader [String] description User defined description 
+    #   associated with the stack.
+    #
+    # @attr_reader [Boolean] disable_rollback Specifies if the stack
+    #   is rolled back due to stack creation errors.
+    #
+    # @attr_reader [Array<String>] notification_arns
+    #   SNS topic ARNs to which stack related events are published.
+    #
+    # @attr_reader [Hash] parameters Returns a hash of stack parameters.
+    #
+    # @attr_reader [Integer] timeout
+    #   The number of minutes within the stack creation should complete.
+    #
+    class Stack < Core::Resource
+
+      include StackOptions
+
+      # @private
+      def initialize name, options = {}
+        @name = name
+        super
+      end
+
+      # @return [String] Returns the stack name.
+      attr_reader :name
+
+      define_attribute_type :template
+
+      define_attribute_type :describe
+
+      ## returned by GetTemplate
+
+      template_attribute :template, :as => :template_body
+
+      alias_method :template_body, :template
+
+      ## returned by DescribeStacks
+
+      describe_attribute :creation_time, :static => true
+
+      describe_attribute :last_updated_time
+
+      describe_attribute :stack_id, :static => true
+
+      describe_attribute :status, :as => :stack_status
+
+      describe_attribute :status_reason, :as => :stack_status_reason
+
+      describe_attribute :capabilities
+
+      describe_attribute :description
+
+      describe_attribute :disable_rollback, :as => :disable_rollback?
+      
+      alias_method :disable_rollback?, :disable_rollback
+
+      describe_attribute :notification_arns
+
+      describe_attribute :output_details, :as => :outputs
+
+      protected :output_details
+
+      describe_attribute :parameters do 
+        translates_output do |params|
+          params.inject({}) do |hash,param|
+            hash.merge(param.parameter_key => param.parameter_value)
+          end
+        end
+      end
+
+      describe_attribute :timeout, :as => :timeout_in_minutes
+
+      alias_method :timeout_in_minutes, :timeout
+
+      ## attribute providers
+
+      provider(:describe_stacks) do |provider|
+        provider.find do |resp|
+          resp.stacks.find{|stack| stack.stack_name == name }
+        end
+        provider.provides *describe_attributes.keys
+      end
+
+      provider(:get_template) do |provider|
+        provider.find do |resp|
+          resp if resp.request_options[:stack_name] == name
+        end
+        provider.provides *template_attributes.keys
+      end
+
+      # @retun [Array<StackOutput>]
+      def outputs
+        output_details.collect do |o|
+          StackOutput.new(self, o.output_key, o.output_value, o.description)
+        end
+      end
+
+      # @return [StackEventCollection] Returns a collection that represents
+      #   all events for this stack.
+      def events
+        StackEventCollection.new(self)
+      end
+
+      # Returns a stack resource collection that enumerates all resources
+      # for this stack.  
+      #
+      #   stack.resources.each do |resource|
+      #     puts "#{resource.resource_type}: #{resource.physical_resource_id}"
+      #   end
+      #
+      # If you want a specific resource and you know its logical resource
+      # id, you can use this collection to return a reference to it.
+      #
+      #   resource = stack.resources['logical-resource-id']
+      #
+      # @return [StackResourceCollection]
+      #
+      def resources
+        StackResourceCollection.new(self)
+      end
+
+      # Returns a stack resource summary collection, that when enumerated
+      # yields summary hashes.  Each hash has the following keys:
+      #
+      # * +:last_updated_timestamp+
+      # * +:logical_resource_id+
+      # * +:physical_resource_id+
+      # * +:resource_status+
+      # * +:resource_status_reason+
+      # * +:resource_type+
+      #
+      # @return [StackResourceSummaryCollection]
+      #
+      def resource_summaries
+        StackResourceSummaryCollection.new(self)
+      end
+
+      # @param [Hash] options
+      #
+      # @option options [String,URI,S3::S3Object,Object] :template 
+      #   A new stack template.  This may be provided in a number of formats
+      #   including:
+      #
+      #   * a String, containing the template as a JSON document.
+      #   * a URL String pointing to the document in S3.
+      #   * a URI object pointing to the document in S3.
+      #   * an {S3::S3Object} which contains the template.
+      #   * an Object which responds to #to_json and returns the template.
+      #
+      # @option options [Hash] :parameters A hash that specifies the
+      #   input parameters of the new stack.
+      #
+      # @option options[Array<String>] :capabilities The list of capabilities
+      #   that you want to allow in the stack. If your stack contains IAM 
+      #   resources, you must specify the CAPABILITY_IAM value for this 
+      #   parameter; otherwise, this action returns an 
+      #   InsufficientCapabilities error. IAM resources are the following: 
+      #
+      #   * AWS::IAM::AccessKey
+      #   * AWS::IAM::Group
+      #   * AWS::IAM::Policy
+      #   * AWS::IAM::User
+      #   * AWS::IAM::UserToGroupAddition
+      #
+      # @return [nil]
+      #
+      def update options = {}
+        
+        client_opts = options.dup
+
+        apply_stack_name(name, client_opts)
+        apply_template(client_opts)
+        apply_parameters(client_opts)
+
+        client.update_stack(client_opts)
+
+        nil
+      end
+
+      # @return (see CloudFormation#estimate_template_cost)
+      def estimate_template_cost
+        cloud_formation = CloudFormation.new(:config => config)  
+        cloud_formation.estimate_template_cost(template, parameters)
+      end
+
+      # Deletes the current stack.
+      # @return [nil]
+      def delete
+        client.delete_stack(:stack_name => name)
+        nil
+      end
+
+      # @return [Boolean]
+      def exists?
+        begin
+          client.describe_stacks(resource_options)
+          true
+        rescue Errors::ValidationError
+          false
+        end
+      end
+
+      protected
+
+      def resource_identifiers
+        [[:stack_name, name]]
+      end
+
+      def get_resource attribute
+        if attribute.name == :template
+          client.get_template(resource_options)
+        else
+          client.describe_stacks(resource_options)
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_formation/stack_collection.rb

@@ -0,0 +1,206 @@
+# 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
+    class StackCollection
+
+      include Core::Collection::Simple
+      include StackOptions
+
+      # @private
+      def initialize options = {}
+        @status_filter = options[:status_filter]
+        super
+      end
+
+      # Creates a new stack.
+      #
+      # @example Creating a stack with a template string.
+      #
+      #   template = <<-JSON
+      #    {
+      #      "AWSTemplateFormatVersion" : "2010-09-09",
+      #      "Description": "A simple template",
+      #      "Resources": {
+      #        "web": {
+      #          "Type": "AWS::EC2::Instance",
+      #          "Properties": {
+      #            "ImageId": "ami-41814f28"
+      #          }
+      #        }
+      #      }
+      #   }
+      #   JSON
+      #   stack = cfm.stacks.create('stack-name', template)
+      #
+      # @example Creating a stack from an S3 object.
+      #
+      #   template = AWS::S3.new.buckets['templates'].objects['template-1']
+      #   stack = cfm.stacks.create('stack-name', template)
+      #
+      # @example Creating a stack with 3 parameters.
+      #
+      #   template = <<-JSON
+      #   {
+      #     "AWSTemplateFormatVersion" : "2010-09-09",
+      #     "Description": "A simple template",
+      #     "Parameters" : {
+      #       "KeyName" : {
+      #         "Description" : "Name of a KeyPair to use with SSH.",
+      #         "Type" : "String"
+      #       },
+      #       "SecurityGroup" : {
+      #         "Description" : "The security group to launch in.",
+      #         "Type" : "String"
+      #       },
+      #       "InstanceType" : {
+      #         "Description" : "The size of instance to launch.",
+      #         "Type" : "String"
+      #       }
+      #     },
+      #     "Resources": {
+      #       "web": {
+      #         "Type": "AWS::EC2::Instance",
+      #         "Properties": {
+      #           "InstanceType": { "Ref" : "InstanceType" },
+      #           "SecurityGroups" : [ {"Ref" : "SecurityGroup"} ],
+      #           "KeyName": { "Ref" : "KeyName" },
+      #           "ImageId": "ami-41814f28"
+      #         }
+      #       }
+      #     }
+      #   }
+      #   JSON
+      #
+      #   stack = cfm.stacks.create('name', template, :parameters => {
+      #     'KeyName' => 'key-pair-name',
+      #     'SecurityGroup' => 'security-group-name',
+      #     'InstanceType' => 'm1.large',
+      #   })
+      # 
+      # @param [String] stack_name
+      #
+      # @param [String,URI,S3::S3Object,Object] template The stack template.
+      #   This may be provided in a number of formats including:
+      #
+      #   * a String, containing the template as a JSON document.
+      #   * a URL String pointing to the document in S3.
+      #   * a URI object pointing to the document in S3.
+      #   * an {S3::S3Object} which contains the template.
+      #   * an Object which responds to #to_json and returns the template.
+      #
+      # @param [Hash] options
+      #
+      # @option options [Array<String>] :capabilities The list of capabilities
+      #   that you want to allow in the stack. If your stack contains IAM 
+      #   resources, you must specify the CAPABILITY_IAM value for this 
+      #   parameter; otherwise, this action returns an 
+      #   InsufficientCapabilities error. IAM resources are the following: 
+      #
+      #   * AWS::IAM::AccessKey
+      #   * AWS::IAM::Group
+      #   * AWS::IAM::Policy
+      #   * AWS::IAM::User
+      #   * AWS::IAM::UserToGroupAddition
+      #
+      # @option options [Boolean] :disable_rollback (false)
+      #   Set to true to disable rollback on stack creation failures.
+      #
+      # @option options [Object] :notify One or more SNS topics ARN
+      #   string or {SNS::Topic} objects.  This param may be passed
+      #   as a single value or as an array. CloudFormation will publish 
+      #   stack related events to these topics.
+      #
+      # @option options [Hash] :parameters A hash that specifies the
+      #   input parameters of the new stack.
+      #
+      # @option options [Integer] :timeout The number of minutes 
+      #   that may pass before the stack creation fails.  If 
+      #   +:disable_rollback+ is false, the stack will be rolled back.
+      #
+      # @return [Stack]
+      #
+      def create stack_name, template, options = {}
+
+        client_opts = options.dup
+        client_opts[:template] = template
+
+        apply_stack_name(stack_name, client_opts)
+        apply_template(client_opts)
+        apply_disable_rollback(client_opts)
+        apply_notification_arns(client_opts)
+        apply_parameters(client_opts)
+        apply_timeout(client_opts)
+
+        resp = client.create_stack(client_opts)
+
+        Stack.new(stack_name, :config => config, :stack_id => resp.stack_id)
+
+      end
+
+      def [] stack_name
+        Stack.new(stack_name, :config => config)
+      end
+
+      # Limits the stacks that are enumerated.
+      #
+      #   cloud_formation.stacks.with_status(:create_complete).each do |stack|
+      #     puts stack.name
+      #   end
+      # 
+      # @param [Symbol,String] status_filter A status to filter stacks with.
+      #   Valid values include:
+      #   * +:create_in_progress+
+      #   * +:create_failed+
+      #   * +:create_complete+
+      #   * +:rollback_in_progress+
+      #   * +:rollback_failed+
+      #   * +:rollback_complete+
+      #   * +:delete_in_progress+
+      #   * +:delete_failed+
+      #   * +:delete_complete+
+      #   * +:update_in_progress+
+      #   * +:update_complete_cleanup_in_progress+
+      #   * +:update_complete+
+      #   * +:update_rollback_in_progress+
+      #   * +:update_rollback_failed+
+      #   * +:update_rollback_complete_cleanup_in_progress+
+      #   * +:update_rollback_complete+
+      #
+      # @return [StackCollection] Returns a new stack collection that
+      #   filters the stacks returned by the given status.
+      #
+      def with_status status_filter
+        StackCollection.new(:status_filter => status_filter, :config => config)
+      end
+
+      protected
+
+      def _each_item options = {}
+        client.describe_stacks.stacks.each do |summary|
+
+          stack = Stack.new_from(
+            :describe_stacks, 
+            summary, 
+            summary.stack_name, 
+            :config => config)
+
+          yield(stack)
+
+        end
+      end
+
+    end
+  end
+end