aws-sdk-cloudformation 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85424f14f330bcd6d5e5fd5ca0763f77ea037d7c
-  data.tar.gz: 7b72bd7db1a793944bdf0b69b0deec1d5dba6a21
+  metadata.gz: 002d893fc2c977f2d7750ad13111bc530072310a
+  data.tar.gz: 046dd6819b7db08e45900e2db4a3b96260985ae9
 SHA512:
-  metadata.gz: 7755584faa0a5003331cdc36ea3b2751c7725c43cdc47145acde421717c30edf793888d849e80037eb29780199f01c82f448f961b6677ec7d691923cd6233888
-  data.tar.gz: d715a24ac1d7ddbeb598cc87e0c3ecd0bfdc2d5374724746b506c5820f4b292e49b9ce1fd6a3d96d00c44485d9d240a8a720a09aff56e885ef50aadc66deaa99
+  metadata.gz: 9f262c161decee207e2c683d749eda6b70e41aad372f61c2c0239175da975a3f19edd7ba452c2952a6a2948b0b5b83d823aa3227a0a18da60f1a7db22ad3b580
+  data.tar.gz: f86d200de56fc44573b16fa074971d1a721fc71775af0f1dcb0115c2f9bfb6f89b8742fb6ea7ce2d7e5827b281081ccead91e8905d4a940ac92cb0cb7ab3ba28

data/lib/aws-sdk-cloudformation.rb

@@ -47,6 +47,6 @@ require_relative 'aws-sdk-cloudformation/customizations'
 # @service
 module Aws::CloudFormation
 
-  GEM_VERSION = '1.0.0'
+  GEM_VERSION = '1.1.0'
 
 end

data/lib/aws-sdk-cloudformation/client.rb

@@ -3203,7 +3203,7 @@ module Aws::CloudFormation
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudformation'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.1.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-cloudformation/event.rb

@@ -34,26 +34,26 @@ module Aws::CloudFormation
     # The unique ID name of the instance of the stack.
     # @return [String]
     def stack_id
-      data.stack_id
+      data[:stack_id]
     end
 
     # The name associated with a stack.
     # @return [String]
     def stack_name
-      data.stack_name
+      data[:stack_name]
     end
 
     # The logical name of the resource specified in the template.
     # @return [String]
     def logical_resource_id
-      data.logical_resource_id
+      data[:logical_resource_id]
     end
 
     # The name or unique identifier associated with the physical instance of
     # the resource.
     # @return [String]
     def physical_resource_id
-      data.physical_resource_id
+      data[:physical_resource_id]
     end
 
     # Type of resource. (For more information, go to [ AWS Resource Types
@@ -64,31 +64,31 @@ module Aws::CloudFormation
     # [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
     # @return [String]
     def resource_type
-      data.resource_type
+      data[:resource_type]
     end
 
     # Time the status was updated.
     # @return [Time]
     def timestamp
-      data.timestamp
+      data[:timestamp]
     end
 
     # Current status of the resource.
     # @return [String]
     def resource_status
-      data.resource_status
+      data[:resource_status]
     end
 
     # Success/failure message associated with the resource.
     # @return [String]
     def resource_status_reason
-      data.resource_status_reason
+      data[:resource_status_reason]
     end
 
     # BLOB of the properties used to create the resource.
     # @return [String]
     def resource_properties
-      data.resource_properties
+      data[:resource_properties]
     end
 
     # The token passed to the operation that generated this event.
@@ -108,7 +108,7 @@ module Aws::CloudFormation
     # `Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002`.
     # @return [String]
     def client_request_token
-      data.client_request_token
+      data[:client_request_token]
     end
 
     # @!endgroup
@@ -141,6 +141,101 @@ module Aws::CloudFormation
       !!@data
     end
 
+    # @deprecated Use [Aws::CloudFormation::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @deprecated
     # @api private
     def identifiers

data/lib/aws-sdk-cloudformation/stack.rb

@@ -34,38 +34,38 @@ module Aws::CloudFormation
     # Unique identifier of the stack.
     # @return [String]
     def stack_id
-      data.stack_id
+      data[:stack_id]
     end
 
     # The unique ID of the change set.
     # @return [String]
     def change_set_id
-      data.change_set_id
+      data[:change_set_id]
     end
 
     # A user-defined description associated with the stack.
     # @return [String]
     def description
-      data.description
+      data[:description]
     end
 
     # A list of `Parameter` structures.
     # @return [Array<Types::Parameter>]
     def parameters
-      data.parameters
+      data[:parameters]
     end
 
     # The time at which the stack was created.
     # @return [Time]
     def creation_time
-      data.creation_time
+      data[:creation_time]
     end
 
     # The time the stack was last updated. This field will only be returned
     # if the stack has been updated at least once.
     # @return [Time]
     def last_updated_time
-      data.last_updated_time
+      data[:last_updated_time]
     end
 
     # The rollback triggers for AWS CloudFormation to monitor during stack
@@ -73,19 +73,19 @@ module Aws::CloudFormation
     # period afterwards.
     # @return [Types::RollbackConfiguration]
     def rollback_configuration
-      data.rollback_configuration
+      data[:rollback_configuration]
     end
 
     # Current status of the stack.
     # @return [String]
     def stack_status
-      data.stack_status
+      data[:stack_status]
     end
 
     # Success/failure message associated with the stack status.
     # @return [String]
     def stack_status_reason
-      data.stack_status_reason
+      data[:stack_status_reason]
     end
 
     # Boolean to enable or disable rollback on stack creation failures:
@@ -95,31 +95,31 @@ module Aws::CloudFormation
     # * `false`\: enable rollback
     # @return [Boolean]
     def disable_rollback
-      data.disable_rollback
+      data[:disable_rollback]
     end
 
     # SNS topic ARNs to which stack related events are published.
     # @return [Array<String>]
     def notification_arns
-      data.notification_arns
+      data[:notification_arns]
     end
 
     # The amount of time within which stack creation should complete.
     # @return [Integer]
     def timeout_in_minutes
-      data.timeout_in_minutes
+      data[:timeout_in_minutes]
     end
 
     # The capabilities allowed in the stack.
     # @return [Array<String>]
     def capabilities
-      data.capabilities
+      data[:capabilities]
     end
 
     # A list of output structures.
     # @return [Array<Types::Output>]
     def outputs
-      data.outputs
+      data[:outputs]
     end
 
     # The Amazon Resource Name (ARN) of an AWS Identity and Access
@@ -128,13 +128,13 @@ module Aws::CloudFormation
     # make calls on your behalf.
     # @return [String]
     def role_arn
-      data.role_arn
+      data[:role_arn]
     end
 
     # A list of `Tag`s that specify information about the stack.
     # @return [Array<Types::Tag>]
     def tags
-      data.tags
+      data[:tags]
     end
 
     # @!endgroup
@@ -203,6 +203,101 @@ module Aws::CloudFormation
       })
     end
 
+    # @deprecated Use [Aws::CloudFormation::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Actions
 
     # @example Request syntax with placeholder values

data/lib/aws-sdk-cloudformation/stack_resource.rb

@@ -42,14 +42,14 @@ module Aws::CloudFormation
     # Unique identifier of the stack.
     # @return [String]
     def stack_id
-      data.stack_id
+      data[:stack_id]
     end
 
     # The name or unique identifier that corresponds to a physical instance
     # ID of a resource supported by AWS CloudFormation.
     # @return [String]
     def physical_resource_id
-      data.physical_resource_id
+      data[:physical_resource_id]
     end
 
     # Type of resource. ((For more information, go to [ AWS Resource Types
@@ -60,31 +60,31 @@ module Aws::CloudFormation
     # [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
     # @return [String]
     def resource_type
-      data.resource_type
+      data[:resource_type]
     end
 
     # Time the status was updated.
     # @return [Time]
     def last_updated_timestamp
-      data.last_updated_timestamp
+      data[:last_updated_timestamp]
     end
 
     # Current status of the resource.
     # @return [String]
     def resource_status
-      data.resource_status
+      data[:resource_status]
     end
 
     # Success/failure message associated with the resource.
     # @return [String]
     def resource_status_reason
-      data.resource_status_reason
+      data[:resource_status_reason]
     end
 
     # User defined description associated with the resource.
     # @return [String]
     def description
-      data.description
+      data[:description]
     end
 
     # The content of the `Metadata` attribute declared for the resource. For
@@ -96,7 +96,7 @@ module Aws::CloudFormation
     # [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html
     # @return [String]
     def metadata
-      data.metadata
+      data[:metadata]
     end
 
     # @!endgroup
@@ -137,6 +137,101 @@ module Aws::CloudFormation
       !!@data
     end
 
+    # @deprecated Use [Aws::CloudFormation::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Associations
 
     # @return [Stack]

data/lib/aws-sdk-cloudformation/stack_resource_summary.rb

@@ -43,7 +43,7 @@ module Aws::CloudFormation
     # ID of the resource.
     # @return [String]
     def physical_resource_id
-      data.physical_resource_id
+      data[:physical_resource_id]
     end
 
     # Type of resource. (For more information, go to [ AWS Resource Types
@@ -54,25 +54,25 @@ module Aws::CloudFormation
     # [1]: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
     # @return [String]
     def resource_type
-      data.resource_type
+      data[:resource_type]
     end
 
     # Time the status was updated.
     # @return [Time]
     def last_updated_timestamp
-      data.last_updated_timestamp
+      data[:last_updated_timestamp]
     end
 
     # Current status of the resource.
     # @return [String]
     def resource_status
-      data.resource_status
+      data[:resource_status]
     end
 
     # Success/failure message associated with the resource.
     # @return [String]
     def resource_status_reason
-      data.resource_status_reason
+      data[:resource_status_reason]
     end
 
     # @!endgroup
@@ -105,6 +105,101 @@ module Aws::CloudFormation
       !!@data
     end
 
+    # @deprecated Use [Aws::CloudFormation::Client] #wait_until instead
+    #
+    # Waiter polls an API operation until a resource enters a desired
+    # state.
+    #
+    # @note The waiting operation is performed on a copy. The original resource remains unchanged
+    #
+    # ## Basic Usage
+    #
+    # Waiter will polls until it is successful, it fails by
+    # entering a terminal state, or until a maximum number of attempts
+    # are made.
+    #
+    #     # polls in a loop until condition is true
+    #     resource.wait_until(options) {|resource| condition}
+    #
+    # ## Example
+    #
+    #     instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. The waiting condition is set
+    # by passing a block to {#wait_until}:
+    #
+    #     # poll for ~25 seconds
+    #     resource.wait_until(max_attempts:5,delay:5) {|resource|...}
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     # poll for 1 hour, instead of a number of attempts
+    #     proc = Proc.new do |attempts, response|
+    #       throw :failure if Time.now - started_at > 3600
+    #     end
+    #
+    #       # disable max attempts
+    #     instance.wait_until(before_wait:proc, max_attempts:nil) {...}
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is successful, it returns the Resource. When a waiter
+    # fails, it raises an error.
+    #
+    #     begin
+    #       resource.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    #
+    # @yield param [Resource] resource to be used in the waiting condition
+    #
+    # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    #   yet successful.
+    #
+    # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [NotImplementedError] Raised when the resource does not
+    #
+    # @option options [Integer] :max_attempts (10) Maximum number of
+    # attempts
+    # @option options [Integer] :delay (10) Delay between each
+    # attempt in seconds
+    # @option options [Proc] :before_attempt (nil) Callback
+    # invoked before each attempt
+    # @option options [Proc] :before_wait (nil) Callback
+    # invoked before each wait
+    # @return [Resource] if the waiter was successful
+    def wait_until(options = {}, &block)
+      self_copy = self.dup
+      attempts = 0
+      options[:max_attempts] = 10 unless options.key?(:max_attempts)
+      options[:delay] ||= 10
+      options[:poller] = Proc.new do
+        attempts += 1
+        if block.call(self_copy)
+          [:success, self_copy]
+        else
+          self_copy.reload unless attempts == options[:max_attempts]
+          :retry
+        end
+      end
+      Aws::Waiters::Waiter.new(options).wait({})
+    end
+
     # @!group Associations
 
     # @return [StackResource]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudformation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -61,7 +61,9 @@ files:
 homepage: http://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-cloudformation
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-cloudformation/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: