aws-sdk-euca 1.8.5

data/lib/aws/cloud_formation/stack_collection.rb

@@ -0,0 +1,209 @@
+# Copyright 2011-2013 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::WithNextToken
+      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 next_token, options = {}
+        options[:next_token] = next_token if next_token
+        resp = client.describe_stacks(options)
+        resp[:stacks].each do |summary|
+
+          stack = Stack.new_from(
+            :describe_stacks,
+            summary,
+            summary[:stack_name],
+            :config => config)
+
+          yield(stack)
+
+        end
+        resp[:next_token]
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_formation/stack_event.rb

@@ -0,0 +1,75 @@
+# Copyright 2011-2013 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-2013 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.data[:stack_events].each do |details|
+
+          event = StackEvent.new(stack, details)
+
+          yield(event)
+
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_formation/stack_options.rb

@@ -0,0 +1,72 @@
+# Copyright 2011-2013 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-2013 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