aws-sdk 1.3.9 → 1.4.0

data/lib/aws/cloud_formation/stack_event.rb

@@ -0,0 +1,75 @@
+# 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
+
+    # = Stack Event
+    #
+    # You can get stack events from a {Stack} object.
+    #
+    #   stack = cfm.stacks['stack-name']
+    #   stack.events.each do |event|
+    #     puts "#{event.timestamp}: #{event.resource_status}"
+    #   end
+    #
+    #
+    class StackEvent
+
+      # @private
+      def initialize stack, details
+        @stack = stack
+        details.each_pair do |attr_name,attr_value|
+          instance_variable_set("@#{attr_name}", attr_value)
+        end
+      end
+
+      # @return [Stack] stack The stack this event belongs to.
+      attr_reader :stack
+
+      # @return [String] event_id The unique ID of this event.
+      attr_reader :event_id
+
+      # @return [String] The logical name of the resource specified 
+      #   in the template.
+      attr_reader :logical_resource_id
+
+      # @return [String] The name or unique identifier associated with the 
+      #   physical instance of the resource.
+      attr_reader :physical_resource_id
+
+      # @return [String] BLOB of the properties used to create the resource.
+      attr_reader :resource_properties
+
+      # @return [Symbol] Current status of the resource.  
+      attr_reader :resource_status
+
+      # @return [String,nil] Success/failure message associated with the 
+      #   resource.
+      attr_reader :resource_status_reason
+
+      # @return [String] Type of the resource (e.g. 'AWS::EC2::Instance').
+      attr_reader :resource_type
+
+      # @return [String] The unique ID name of the instance of the stack.
+      attr_reader :stack_id
+
+      # @return [String] The name associated with a stack.
+      attr_reader :stack_name
+
+      # @return [Time] When the status was last updated.
+      attr_reader :timestamp
+
+    end
+  end
+end

data/lib/aws/cloud_formation/stack_event_collection.rb

@@ -0,0 +1,47 @@
+# 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 StackEventCollection
+
+      include Core::Collection::Simple
+
+      # @param [Stack] stack
+      # @param [Hash] options
+      def initialize stack, options = {}
+        @stack = stack
+        super
+      end
+
+      # @return [Stack]
+      attr_reader :stack
+
+      protected
+
+      def _each_item options = {}
+        options[:stack_name] = stack.name
+        resp = client.describe_stack_events(options)
+        resp.stack_events.each do |details|
+
+          event = StackEvent.new(stack, details.to_hash)
+
+          yield(event)
+
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_formation/stack_options.rb

@@ -0,0 +1,72 @@
+# 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
+
+    # This module provide option helpers for methods operation on stacks.
+    # @private
+    module StackOptions
+
+      protected
+
+      def apply_stack_name stack_name, options
+        options[:stack_name] = stack_name
+      end
+
+      def apply_template opts
+        if template = opts.delete(:template)
+          case template
+          when String 
+            if template.match(/http/)
+              opts[:template_url] = template
+            else
+              opts[:template_body] = template
+            end
+          when URI then opts[:template_url] = template.to_s
+          when S3::S3Object then opts[:template_body] = template.read
+          else 
+            opts[:template_body] = template.to_json
+          end
+        end
+      end
+
+      def apply_disable_rollback options
+        options[:disable_rollback] = options[:disable_rollback] == true
+      end
+
+      def apply_notification_arns options
+        if arns = options.delete(:notify)
+          options[:notification_arns] = Array(arns).collect do |topic|
+            topic.is_a?(SNS::Topic) ? topic.arn : topic
+          end
+        end
+      end
+
+      def apply_parameters options
+        if params = options[:parameters] and params.is_a?(Hash)
+          options[:parameters] = params.inject([]) do |list,(key,value)|
+            list << { :parameter_key => key.to_s, :parameter_value => value }
+          end
+        end
+      end
+
+      def apply_timeout options
+        if timeout = options.delete(:timeout)
+          options[:timeout_in_minutes] = timeout
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_formation/stack_output.rb

@@ -0,0 +1,53 @@
+# 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 StackOutput
+      
+      # @param [Stack] stack
+      # @param [String] key
+      # @param [String] value
+      # @param [String] description
+      def initialize stack, key, value, description
+        @stack = stack
+        @key = key
+        @value = value
+        @description = description
+      end
+
+      # @return [Stack]
+      attr_reader :stack
+
+      # @return [String]
+      attr_reader :key
+
+      # @return [String]
+      attr_reader :value
+
+      # @return [String]
+      attr_reader :description
+
+      # @private
+      def eql? other
+        other.is_a?(StackOutput) and
+        other.stack == stack and
+        other.key == key and
+        other.value == value and
+        other.description == description
+      end
+      alias_method :==, :eql?
+
+    end
+  end
+end

data/lib/aws/cloud_formation/stack_resource.rb

@@ -0,0 +1,117 @@
+# 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,nil] description
+    #   User defined description associated with the resource.
+    #
+    # @attr_reader [String] physical_resource_id
+    #   The name or unique identifier that corresponds to a physical instance
+    #   ID of a resource supported by AWS CloudFormation.
+    #
+    # @attr_reader [Symbol] resource_status 
+    #   Current status of the resource.
+    #
+    # @attr_reader [String,nil] resource_status_reason
+    #   Success/failure message associated with the resource.
+    #
+    # @attr_reader [String] resource_type
+    #   Type of the resource (e.g. 'AWS::EC2::Instance')
+    #
+    # @attr_reader [String] stack_name
+    #   The name associated with the stack.
+    #
+    # @attr_reader [String] stack_id
+    #   Unique identifier of the stack.
+    #
+    # @attr_reader [Time] last_updated_timestamp
+    #   When the status was last updated.
+    #
+    # @attr_reader [String,nil] metadata
+    #   The JSON format content of the Metadata attribute declared for the 
+    #   resource.
+    #
+    class StackResource < Core::Resource
+
+      # @private
+      def initialize stack, logical_resource_id, options = {}
+        @stack = stack
+        @logical_resource_id = logical_resource_id
+        super
+      end
+
+      # @return [Stack]
+      attr_reader :stack
+
+      # @return [String] The logical name of the resource specified in 
+      #   the template.
+      attr_reader :logical_resource_id
+
+      define_attribute_type :common # return by both describe stack resource methods
+
+      define_attribute_type :detail # returned by DescribeStackResource (singular)
+
+      common_attribute :description, :static => true
+
+      common_attribute :physical_resource_id, :static => true
+
+      common_attribute :resource_status
+
+      common_attribute :resource_status_reason
+
+      common_attribute :resource_type, :static => true
+
+      common_attribute :stack_name, :static => true
+
+      common_attribute :stack_id, :static => true
+
+      # provided by DescribeStackResource
+
+      detail_attribute :last_updated_timestamp
+
+      detail_attribute :metadata
+
+      # this operation returns all attributes
+      populates_from(:describe_stack_resource) do |resp|
+        resp.stack_resource_detail if 
+          resp.stack_resource_detail.logical_resource_id == logical_resource_id
+      end
+
+      # This method provides ALL attributes except :metadata.  The
+      # :last_updated_timestamp attribute is also provided by 
+      # a differnt name (:timestamp instead of :last_updated_timestamp).
+      provider(:describe_stack_resources) do |provider|
+        provider.find do |resp|
+          resp.stack_resources.find do |resource|
+            resource.logical_resource_id == logical_resource_id
+          end
+        end
+        provider.provides *common_attributes.keys
+        provider.provides :last_updated_timestamp, :get_as => :timestamp
+      end
+
+      protected
+
+      def resource_identifiers
+        [[:stack_name, stack.name], [:logical_resource_id, logical_resource_id]]
+      end
+
+      def get_resource attribute = nil
+        client.describe_stack_resource(resource_options)  
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_formation/stack_resource_collection.rb

@@ -0,0 +1,84 @@
+# 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
+
+    # = StackResourceCollection 
+    #
+    # This collection represents the resources for a single {Stack}.
+    # You can enumerate resources, or request a specific resource
+    # by its logical resource id.
+    #
+    # = Other Ways to Get Resource Details
+    #
+    # If you want to get a {StackResource} by its physical resource
+    # id, then you should use {CloudFormation#get_resource}.
+    #
+    # You can also take a look at {Stack#resource_summaries} for
+    # light-weight hashes of stack resource details.
+    #
+    # @example Enumerating stack resources
+    #
+    #   # enumerating all resources for a stack
+    #   stack.resources.each do |resource|
+    #     puts resource.resource_type + " " + resource.physical_resource_id
+    #   end
+    # 
+    # @example Getting a stack resource by its logical resource id
+    #
+    #   resource = stack.resources['web']
+    #
+    class StackResourceCollection
+
+      include Core::Collection::Simple
+      include StackOptions
+
+      # @param [Stack] stack
+      # @param [Hash] options
+      def initialize stack, options = {}
+        @stack = stack
+        super
+      end
+
+      # @return [Stack]
+      attr_reader :stack
+
+      # @param [String] logical_resource_id
+      # @return [StackResource] Returns a stack resource with the given
+      #   logical resource id.
+      def [] logical_resource_id 
+        StackResource.new(stack, logical_resource_id)
+      end
+
+      protected
+
+      def _each_item options = {}
+        options[:stack_name] = stack.name
+        response = client.describe_stack_resources(options)
+        response.stack_resources.each do |details|
+
+          stack_resource = StackResource.new_from(
+            :describe_stack_resources, 
+            details,
+            self, 
+            details.logical_resource_id)
+
+          yield(stack_resource)
+
+        end
+      end
+
+    end
+  end
+end