aws-sdk 1.8.5 → 1.9.0

data/lib/aws/cloud_formation/config.rb

@@ -13,6 +13,6 @@
 
 AWS::Core::Configuration.module_eval do
 
-  add_service 'CloudFormation', 'cloud_formation', 'cloudformation.us-east-1.amazonaws.com'
+  add_service 'CloudFormation', 'cloud_formation', 'cloudformation.%s.amazonaws.com'
 
 end

data/lib/aws/cloud_formation/stack.rb

@@ -15,25 +15,25 @@
 module AWS
   class CloudFormation
 
-    # @attr_reader [String] template Returns the stack's template as a JSON 
+    # @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 
+    # @attr_reader [Time,nil] last_updated_time The time the stack was
     #   last updated.
     #
     # @attr_reader [String] stack_id Unique stack identifier.
     #
     # @attr_reader [String] status The status of the stack.
     #
-    # @attr_reader [String] status_reason Success/Failure message 
-    #   associated with the +status+.
+    # @attr_reader [String] status_reason Success/Failure message
+    #   associated with the `status`.
     #
-    # @attr_reader [Array<String>] capabilities The capabilities 
+    # @attr_reader [Array<String>] capabilities The capabilities
     #   allowed in the stack.
     #
-    # @attr_reader [String] description User defined description 
+    # @attr_reader [String] description User defined description
     #   associated with the stack.
     #
     # @attr_reader [Boolean] disable_rollback Specifies if the stack
@@ -64,13 +64,13 @@ module AWS
 
       define_attribute_type :describe
 
-      ## returned by GetTemplate
+      # returned by GetTemplate
 
       template_attribute :template, :from => :template_body
 
       alias_method :template_body, :template
 
-      ## returned by DescribeStacks
+      # returned by DescribeStacks
 
       describe_attribute :creation_time, :static => true
 
@@ -96,7 +96,7 @@ module AWS
 
       protected :output_details
 
-      describe_attribute :parameters do 
+      describe_attribute :parameters do
         translates_output do |params|
           params.inject({}) do |hash,param|
             hash.merge(param[:parameter_key] => param[:parameter_value])
@@ -108,7 +108,7 @@ module AWS
 
       alias_method :timeout_in_minutes, :timeout
 
-      ## attribute providers
+      # attribute providers
 
       provider(:describe_stacks) do |provider|
         provider.find do |resp|
@@ -139,16 +139,16 @@ module AWS
       end
 
       # Returns a stack resource collection that enumerates all resources
-      # for this stack.  
+      # for this stack.
       #
-      #   stack.resources.each do |resource|
-      #     puts "#{resource.resource_type}: #{resource.physical_resource_id}"
-      #   end
+      #     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']
+      #     resource = stack.resources['logical-resource-id']
       #
       # @return [StackResourceCollection]
       #
@@ -159,12 +159,12 @@ module AWS
       # 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+
+      # * `:last_updated_timestamp`
+      # * `:logical_resource_id`
+      # * `:physical_resource_id`
+      # * `:resource_status`
+      # * `:resource_status_reason`
+      # * `:resource_type`
       #
       # @return [StackResourceSummaryCollection]
       #
@@ -174,30 +174,30 @@ module AWS
 
       # @param [Hash] options
       #
-      # @option options [String,URI,S3::S3Object,Object] :template 
+      # @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.
+      #     * 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: 
+      #   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
+      #     * AWS::IAM::AccessKey
+      #     * AWS::IAM::Group
+      #     * AWS::IAM::Policy
+      #     * AWS::IAM::User
+      #     * AWS::IAM::UserToGroupAddition
       #
       # @return [nil]
       #
@@ -215,7 +215,7 @@ module AWS
 
       # @return (see CloudFormation#estimate_template_cost)
       def estimate_template_cost
-        cloud_formation = CloudFormation.new(:config => config)  
+        cloud_formation = CloudFormation.new(:config => config)
         cloud_formation.estimate_template_cost(template, parameters)
       end
 

data/lib/aws/cloud_formation/stack_collection.rb

@@ -94,11 +94,11 @@ module AWS
       # @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.
+      #     * 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
       #
@@ -108,11 +108,11 @@ module AWS
       #   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
+      #     * 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.
@@ -127,7 +127,7 @@ module AWS
       #
       # @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.
+      #   `:disable_rollback` is false, the stack will be rolled back.
       #
       # @return [Stack]
       #
@@ -161,22 +161,23 @@ module AWS
       #
       # @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+
+      #
+      #     * `: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.

data/lib/aws/cloud_formation/stack_event.rb

@@ -14,16 +14,14 @@
 module AWS
   class CloudFormation
 
-    # = Stack Event
+    # # 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
-    #
-    #
+    #     stack = cfm.stacks['stack-name']
+    #     stack.events.each do |event|
+    #       puts "#{event.timestamp}: #{event.resource_status}"
+    #     end
     class StackEvent
 
       # @private
@@ -40,21 +38,21 @@ module AWS
       # @return [String] event_id The unique ID of this event.
       attr_reader :event_id
 
-      # @return [String] The logical name of the resource specified 
+      # @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 
+      # @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.  
+      # @return [Symbol] Current status of the resource.
       attr_reader :resource_status
 
-      # @return [String,nil] Success/failure message associated with the 
+      # @return [String,nil] Success/failure message associated with the
       #   resource.
       attr_reader :resource_status_reason
 

data/lib/aws/cloud_formation/stack_output.rb

@@ -14,7 +14,7 @@
 module AWS
   class CloudFormation
     class StackOutput
-      
+
       # @param [Stack] stack
       # @param [String] key
       # @param [String] value

data/lib/aws/cloud_formation/stack_resource.rb

@@ -21,7 +21,7 @@ module AWS
     #   The name or unique identifier that corresponds to a physical instance
     #   ID of a resource supported by AWS CloudFormation.
     #
-    # @attr_reader [Symbol] resource_status 
+    # @attr_reader [Symbol] resource_status
     #   Current status of the resource.
     #
     # @attr_reader [String,nil] resource_status_reason
@@ -40,7 +40,7 @@ module AWS
     #   When the status was last updated.
     #
     # @attr_reader [String,nil] metadata
-    #   The JSON format content of the Metadata attribute declared for the 
+    #   The JSON format content of the Metadata attribute declared for the
     #   resource.
     #
     class StackResource < Core::Resource
@@ -55,7 +55,7 @@ module AWS
       # @return [Stack]
       attr_reader :stack
 
-      # @return [String] The logical name of the resource specified in 
+      # @return [String] The logical name of the resource specified in
       #   the template.
       attr_reader :logical_resource_id
 
@@ -85,12 +85,12 @@ module AWS
 
       # this operation returns all attributes
       populates_from(:describe_stack_resource) do |resp|
-        resp.stack_resource_detail if 
+        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 
+      # :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|
@@ -109,7 +109,7 @@ module AWS
       end
 
       def get_resource attribute = nil
-        client.describe_stack_resource(resource_options)  
+        client.describe_stack_resource(resource_options)
       end
 
     end

data/lib/aws/cloud_formation/stack_resource_collection.rb

@@ -14,13 +14,13 @@
 module AWS
   class CloudFormation
 
-    # = StackResourceCollection 
+    # # 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
+    # # Other Ways to Get Resource Details
     #
     # If you want to get a {StackResource} by its physical resource
     # id, then you should use {CloudFormation#stack_resource}.
@@ -30,15 +30,14 @@ module AWS
     #
     # @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
+    #     # enumerating all resources for a stack
+    #     stack.resources.each do |resource|
+    #       puts resource.resource_type ` " " ` resource.physical_resource_id
+    #     end
     #
-    #   resource = stack.resources['web']
+    # @example Getting a stack resource by its logical resource id
     #
+    #     resource = stack.resources['web']
     class StackResourceCollection
 
       include Core::Collection::Simple
@@ -57,7 +56,7 @@ module AWS
       # @param [String] logical_resource_id
       # @return [StackResource] Returns a stack resource with the given
       #   logical resource id.
-      def [] logical_resource_id 
+      def [] logical_resource_id
         StackResource.new(stack, logical_resource_id)
       end
 
@@ -69,9 +68,9 @@ module AWS
         response.stack_resources.each do |details|
 
           stack_resource = StackResource.new_from(
-            :describe_stack_resources, 
+            :describe_stack_resources,
             details,
-            self, 
+            self,
             details.logical_resource_id)
 
           yield(stack_resource)

data/lib/aws/cloud_formation/stack_resource_summary_collection.rb

@@ -14,24 +14,24 @@
 module AWS
   class CloudFormation
 
-    # = Stack Resource Summaries
+    # # Stack Resource Summaries
     #
     # Stack summaries contain information about CloudFormation
     # stack resources.  You can enumerate these from a stack.
     #
-    #   stack = cfm.stacks['stack-name']
-    #   stack.resource_summaries.each do |summary|
-    #     puts "#{summary[:physical_resource_id]}: #{summary[:resource_status]}"
-    #   end
+    #     stack = cfm.stacks['stack-name']
+    #     stack.resource_summaries.each do |summary|
+    #       puts "#{summary[:physical_resource_id]}: #{summary[:resource_status]}"
+    #     end
     #
     # Each summary yielded is a hash with the following keys:
     #
-    # * +:logical_resource_id+
-    # * +:physical_resource_id+
-    # * +:resource_type+
-    # * +:resource_status+
-    # * +:resource_status_reason+
-    # * +:last_updated_timestamp+
+    #   * `:logical_resource_id`
+    #   * `:physical_resource_id`
+    #   * `:resource_type`
+    #   * `:resource_status`
+    #   * `:resource_status_reason`
+    #   * `:last_updated_timestamp`
     #
     class StackResourceSummaryCollection