aws-sdk-autoscaling 1.2.0 → 1.3.0

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

@@ -4221,7 +4221,7 @@ module Aws::AutoScaling
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-autoscaling'
-      context[:gem_version] = '1.2.0'
+      context[:gem_version] = '1.3.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-autoscaling/instance.rb

@@ -43,7 +43,7 @@ module Aws::AutoScaling
     # The Availability Zone for the instance.
     # @return [String]
     def availability_zone
-      data.availability_zone
+      data[:availability_zone]
     end
 
     # The lifecycle state for the instance. For more information, see [Auto
@@ -54,7 +54,7 @@ module Aws::AutoScaling
     # [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html
     # @return [String]
     def lifecycle_state
-      data.lifecycle_state
+      data[:lifecycle_state]
     end
 
     # The last reported health status of this instance. "Healthy" means
@@ -63,21 +63,21 @@ module Aws::AutoScaling
     # should terminate and replace it.
     # @return [String]
     def health_status
-      data.health_status
+      data[:health_status]
     end
 
     # The launch configuration used to launch the instance. This value is
     # not available if you attached the instance to the Auto Scaling group.
     # @return [String]
     def launch_configuration_name
-      data.launch_configuration_name
+      data[:launch_configuration_name]
     end
 
     # Indicates whether the instance is protected from termination by Auto
     # Scaling when scaling in.
     # @return [Boolean]
     def protected_from_scale_in
-      data.protected_from_scale_in
+      data[:protected_from_scale_in]
     end
 
     # @!endgroup
@@ -115,6 +115,101 @@ module Aws::AutoScaling
       !!@data
     end
 
+    # @deprecated Use [Aws::AutoScaling::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
@@ -268,9 +363,9 @@ module Aws::AutoScaling
 
     # @return [LaunchConfiguration, nil]
     def launch_configuration
-      if data.launch_configuration_name
+      if data[:launch_configuration_name]
         LaunchConfiguration.new(
-          name: data.launch_configuration_name,
+          name: data[:launch_configuration_name],
           client: @client
         )
       else

data/lib/aws-sdk-autoscaling/launch_configuration.rb

@@ -34,25 +34,25 @@ module Aws::AutoScaling
     # The Amazon Resource Name (ARN) of the launch configuration.
     # @return [String]
     def launch_configuration_arn
-      data.launch_configuration_arn
+      data[:launch_configuration_arn]
     end
 
     # The ID of the Amazon Machine Image (AMI).
     # @return [String]
     def image_id
-      data.image_id
+      data[:image_id]
     end
 
     # The name of the key pair.
     # @return [String]
     def key_name
-      data.key_name
+      data[:key_name]
     end
 
     # The security groups to associate with the instances.
     # @return [Array<String>]
     def security_groups
-      data.security_groups
+      data[:security_groups]
     end
 
     # The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances
@@ -65,7 +65,7 @@ module Aws::AutoScaling
     # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
     # @return [String]
     def classic_link_vpc_id
-      data.classic_link_vpc_id
+      data[:classic_link_vpc_id]
     end
 
     # The IDs of one or more security groups for the VPC specified in
@@ -79,78 +79,78 @@ module Aws::AutoScaling
     # [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html
     # @return [Array<String>]
     def classic_link_vpc_security_groups
-      data.classic_link_vpc_security_groups
+      data[:classic_link_vpc_security_groups]
     end
 
     # The user data available to the instances.
     # @return [String]
     def user_data
-      data.user_data
+      data[:user_data]
     end
 
     # The instance type for the instances.
     # @return [String]
     def instance_type
-      data.instance_type
+      data[:instance_type]
     end
 
     # The ID of the kernel associated with the AMI.
     # @return [String]
     def kernel_id
-      data.kernel_id
+      data[:kernel_id]
     end
 
     # The ID of the RAM disk associated with the AMI.
     # @return [String]
     def ramdisk_id
-      data.ramdisk_id
+      data[:ramdisk_id]
     end
 
     # A block device mapping, which specifies the block devices for the
     # instance.
     # @return [Array<Types::BlockDeviceMapping>]
     def block_device_mappings
-      data.block_device_mappings
+      data[:block_device_mappings]
     end
 
     # Controls whether instances in this group are launched with detailed
     # (`true`) or basic (`false`) monitoring.
     # @return [Types::InstanceMonitoring]
     def instance_monitoring
-      data.instance_monitoring
+      data[:instance_monitoring]
     end
 
     # The price to bid when launching Spot Instances.
     # @return [String]
     def spot_price
-      data.spot_price
+      data[:spot_price]
     end
 
     # The name or Amazon Resource Name (ARN) of the instance profile
     # associated with the IAM role for the instance.
     # @return [String]
     def iam_instance_profile
-      data.iam_instance_profile
+      data[:iam_instance_profile]
     end
 
     # The creation date and time for the launch configuration.
     # @return [Time]
     def created_time
-      data.created_time
+      data[:created_time]
     end
 
     # Controls whether the instance is optimized for EBS I/O (`true`) or not
     # (`false`).
     # @return [Boolean]
     def ebs_optimized
-      data.ebs_optimized
+      data[:ebs_optimized]
     end
 
     # \[EC2-VPC\] Indicates whether to assign a public IP address to each
     # instance.
     # @return [Boolean]
     def associate_public_ip_address
-      data.associate_public_ip_address
+      data[:associate_public_ip_address]
     end
 
     # The tenancy of the instance, either `default` or `dedicated`. An
@@ -158,7 +158,7 @@ module Aws::AutoScaling
     # hardware and can only be launched into a VPC.
     # @return [String]
     def placement_tenancy
-      data.placement_tenancy
+      data[:placement_tenancy]
     end
 
     # @!endgroup
@@ -196,6 +196,101 @@ module Aws::AutoScaling
       !!@data
     end
 
+    # @deprecated Use [Aws::AutoScaling::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-autoscaling/lifecycle_hook.rb

@@ -45,7 +45,7 @@ module Aws::AutoScaling
     # DescribeLifecycleHookTypes.
     # @return [String]
     def lifecycle_transition
-      data.lifecycle_transition
+      data[:lifecycle_transition]
     end
 
     # The ARN of the target that Auto Scaling sends notifications to when an
@@ -53,21 +53,21 @@ module Aws::AutoScaling
     # notification target can be either an SQS queue or an SNS topic.
     # @return [String]
     def notification_target_arn
-      data.notification_target_arn
+      data[:notification_target_arn]
     end
 
     # The ARN of the IAM role that allows the Auto Scaling group to publish
     # to the specified notification target.
     # @return [String]
     def role_arn
-      data.role_arn
+      data[:role_arn]
     end
 
     # Additional information that you want to include any time Auto Scaling
     # sends a message to the notification target.
     # @return [String]
     def notification_metadata
-      data.notification_metadata
+      data[:notification_metadata]
     end
 
     # The maximum time, in seconds, that can elapse before the lifecycle
@@ -76,7 +76,7 @@ module Aws::AutoScaling
     # by calling RecordLifecycleActionHeartbeat.
     # @return [Integer]
     def heartbeat_timeout
-      data.heartbeat_timeout
+      data[:heartbeat_timeout]
     end
 
     # The maximum time, in seconds, that an instance can remain in a
@@ -85,7 +85,7 @@ module Aws::AutoScaling
     # smaller.
     # @return [Integer]
     def global_timeout
-      data.global_timeout
+      data[:global_timeout]
     end
 
     # Defines the action the Auto Scaling group should take when the
@@ -94,7 +94,7 @@ module Aws::AutoScaling
     # `CONTINUE`.
     # @return [String]
     def default_result
-      data.default_result
+      data[:default_result]
     end
 
     # @!endgroup
@@ -135,6 +135,101 @@ module Aws::AutoScaling
       !!@data
     end
 
+    # @deprecated Use [Aws::AutoScaling::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