aws-sdk-autoscaling 1.0.0.rc1

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

@@ -0,0 +1,329 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module AutoScaling
+    class LifecycleHook
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(group_name, name, options = {})
+      #   @param [String] group_name
+      #   @param [String] name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :group_name
+      #   @option options [required, String] :name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @group_name = extract_group_name(args, options)
+        @name = extract_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def group_name
+        @group_name
+      end
+      alias :auto_scaling_group_name :group_name
+
+      # @return [String]
+      def name
+        @name
+      end
+      alias :lifecycle_hook_name :name
+
+      # The state of the EC2 instance to which you want to attach the
+      # lifecycle hook. For a list of lifecycle hook types, see
+      # DescribeLifecycleHookTypes.
+      # @return [String]
+      def lifecycle_transition
+        data.lifecycle_transition
+      end
+
+      # The ARN of the notification target that Auto Scaling uses to notify
+      # you when an instance is in the transition state for the lifecycle
+      # hook. This ARN target can be either an SQS queue or an SNS topic. The
+      # notification message sent to the target includes the following:
+      #
+      # * Lifecycle action token
+      #
+      # * User account ID
+      #
+      # * Name of the Auto Scaling group
+      #
+      # * Lifecycle hook name
+      #
+      # * EC2 instance ID
+      #
+      # * Lifecycle transition
+      #
+      # * Notification metadata
+      # @return [String]
+      def 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
+      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
+      end
+
+      # The maximum time, in seconds, that can elapse before the lifecycle
+      # hook times out. The default is 3600 seconds (1 hour). When the
+      # lifecycle hook times out, Auto Scaling performs the default action.
+      # You can prevent the lifecycle hook from timing out by calling
+      # RecordLifecycleActionHeartbeat.
+      # @return [Integer]
+      def heartbeat_timeout
+        data.heartbeat_timeout
+      end
+
+      # The maximum time, in seconds, that an instance can remain in a
+      # `Pending:Wait` or `Terminating:Wait` state. The maximum is 172800
+      # seconds (48 hours) or 100 times `HeartbeatTimeout`, whichever is
+      # smaller.
+      # @return [Integer]
+      def global_timeout
+        data.global_timeout
+      end
+
+      # Defines the action the Auto Scaling group should take when the
+      # lifecycle hook timeout elapses or if an unexpected failure occurs. The
+      # valid values are `CONTINUE` and `ABANDON`. The default value is
+      # `CONTINUE`.
+      # @return [String]
+      def default_result
+        data.default_result
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {LifecycleHook}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     lifecycle_hook.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.describe_lifecycle_hooks(
+          auto_scaling_group_name: @group_name,
+          lifecycle_hook_names: [@name]
+        )
+        @data = resp.lifecyclehooks[0]
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::LifecycleHook]
+      #   Returns the data for this {LifecycleHook}. Calls
+      #   {Client#describe_lifecycle_hooks} if {#data_loaded?} is `false`.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   lifecycle_hook.complete({
+      #     lifecycle_action_token: "LifecycleActionToken",
+      #     lifecycle_action_result: "LifecycleActionResult", # required
+      #     instance_id: "XmlStringMaxLen19",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :lifecycle_action_token
+      #   A universally unique identifier (UUID) that identifies a specific
+      #   lifecycle action associated with an instance. Auto Scaling sends this
+      #   token to the notification target you specified when you created the
+      #   lifecycle hook.
+      # @option options [required, String] :lifecycle_action_result
+      #   The action for the group to take. This parameter can be either
+      #   `CONTINUE` or `ABANDON`.
+      # @option options [String] :instance_id
+      #   The ID of the instance.
+      # @return [Types::CompleteLifecycleActionAnswer]
+      def complete(options = {})
+        options = options.merge(
+          auto_scaling_group_name: @group_name,
+          lifecycle_hook_name: @name
+        )
+        resp = @client.complete_lifecycle_action(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   lifecycle_hook.delete()
+      # @param [Hash] options ({})
+      # @return [Types::DeleteLifecycleHookAnswer]
+      def delete(options = {})
+        options = options.merge(
+          auto_scaling_group_name: @group_name,
+          lifecycle_hook_name: @name
+        )
+        resp = @client.delete_lifecycle_hook(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   lifecycle_hook.put({
+      #     lifecycle_transition: "LifecycleTransition",
+      #     role_arn: "ResourceName",
+      #     notification_target_arn: "NotificationTargetResourceName",
+      #     notification_metadata: "XmlStringMaxLen1023",
+      #     heartbeat_timeout: 1,
+      #     default_result: "LifecycleActionResult",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :lifecycle_transition
+      #   The instance state to which you want to attach the lifecycle hook. For
+      #   a list of lifecycle hook types, see DescribeLifecycleHookTypes.
+      #
+      #   This parameter is required for new lifecycle hooks, but optional when
+      #   updating existing hooks.
+      # @option options [String] :role_arn
+      #   The ARN of the IAM role that allows the Auto Scaling group to publish
+      #   to the specified notification target.
+      #
+      #   This parameter is required for new lifecycle hooks, but optional when
+      #   updating existing hooks.
+      # @option options [String] :notification_target_arn
+      #   The ARN of the notification target that Auto Scaling will use to
+      #   notify you when an instance is in the transition state for the
+      #   lifecycle hook. This target can be either an SQS queue or an SNS
+      #   topic. If you specify an empty string, this overrides the current ARN.
+      #
+      #   This operation uses the JSON format when sending notifications to an
+      #   Amazon SQS queue, and an email key/value pair format when sending
+      #   notifications to an Amazon SNS topic.
+      #
+      #   When you specify a notification target, Auto Scaling sends it a test
+      #   message. Test messages contains the following additional key/value
+      #   pair: `"Event": "autoscaling:TEST_NOTIFICATION"`.
+      # @option options [String] :notification_metadata
+      #   Contains additional information that you want to include any time Auto
+      #   Scaling sends a message to the notification target.
+      # @option options [Integer] :heartbeat_timeout
+      #   The amount of time, in seconds, that can elapse before the lifecycle
+      #   hook times out. When the lifecycle hook times out, Auto Scaling
+      #   performs the default action. You can prevent the lifecycle hook from
+      #   timing out by calling RecordLifecycleActionHeartbeat. The default is
+      #   3600 seconds (1 hour).
+      # @option options [String] :default_result
+      #   Defines the action the Auto Scaling group should take when the
+      #   lifecycle hook timeout elapses or if an unexpected failure occurs.
+      #   This parameter can be either `CONTINUE` or `ABANDON`. The default
+      #   value is `ABANDON`.
+      # @return [Types::PutLifecycleHookAnswer]
+      def put(options = {})
+        options = options.merge(
+          auto_scaling_group_name: @group_name,
+          lifecycle_hook_name: @name
+        )
+        resp = @client.put_lifecycle_hook(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   lifecycle_hook.record_heartbeat({
+      #     lifecycle_action_token: "LifecycleActionToken",
+      #     instance_id: "XmlStringMaxLen19",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :lifecycle_action_token
+      #   A token that uniquely identifies a specific lifecycle action
+      #   associated with an instance. Auto Scaling sends this token to the
+      #   notification target you specified when you created the lifecycle hook.
+      # @option options [String] :instance_id
+      #   The ID of the instance.
+      # @return [Types::RecordLifecycleActionHeartbeatAnswer]
+      def record_heartbeat(options = {})
+        options = options.merge(
+          auto_scaling_group_name: @group_name,
+          lifecycle_hook_name: @name
+        )
+        resp = @client.record_lifecycle_action_heartbeat(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [AutoScalingGroup]
+      def group
+        AutoScalingGroup.new(
+          name: @group_name,
+          client: @client
+        )
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        {
+          group_name: @group_name,
+          name: @name
+        }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_group_name(args, options)
+        value = args[0] || options.delete(:group_name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :group_name"
+        else
+          msg = "expected :group_name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_name(args, options)
+        value = args[1] || options.delete(:name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :name"
+        else
+          msg = "expected :name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection; end
+    end
+  end
+end

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

@@ -0,0 +1,219 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing for info on making contributions:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws
+  module AutoScaling
+    class LoadBalancer
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(group_name, name, options = {})
+      #   @param [String] group_name
+      #   @param [String] name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :group_name
+      #   @option options [required, String] :name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @group_name = extract_group_name(args, options)
+        @name = extract_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def group_name
+        @group_name
+      end
+
+      # @return [String]
+      def name
+        @name
+      end
+      alias :load_balancer_name :name
+
+      # One of the following load balancer states:
+      #
+      # * `Adding` - The instances in the group are being registered with the
+      #   load balancer.
+      #
+      # * `Added` - All instances in the group are registered with the load
+      #   balancer.
+      #
+      # * `InService` - At least one instance in the group passed an ELB
+      #   health check.
+      #
+      # * `Removing` - The instances in the group are being deregistered from
+      #   the load balancer. If connection draining is enabled, Elastic Load
+      #   Balancing waits for in-flight requests to complete before
+      #   deregistering the instances.
+      #
+      # * `Removed` - All instances in the group are deregistered from the
+      #   load balancer.
+      # @return [String]
+      def state
+        data.state
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # @raise [Errors::ResourceNotLoadable]
+      # @api private
+      def load
+        msg = "#load is not implemented, data only available via enumeration"
+        raise Errors::ResourceNotLoadable, msg
+      end
+      alias :reload :load
+
+      # @raise [Errors::ResourceNotLoadableError] Raises when {#data_loaded?} is `false`.
+      # @return [Types::LoadBalancerState]
+      #   Returns the data for this {LoadBalancer}.
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean]
+      #   Returns `true` if this resource is loaded.  Accessing attributes or
+      #   {#data} on an unloaded resource will trigger a call to {#load}.
+      def data_loaded?
+        !!@data
+      end
+
+      # @!group Actions
+
+      # @example Request syntax with placeholder values
+      #
+      #   load_balancer.attach()
+      # @param [Hash] options ({})
+      # @return [Types::AttachLoadBalancersResultType]
+      def attach(options = {})
+        options = Aws::Util.deep_merge(options,
+          auto_scaling_group_name: @group_name,
+          load_balancer_names: [@name]
+        )
+        resp = @client.attach_load_balancers(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   load_balancer.detach()
+      # @param [Hash] options ({})
+      # @return [Types::DetachLoadBalancersResultType]
+      def detach(options = {})
+        options = Aws::Util.deep_merge(options,
+          auto_scaling_group_name: @group_name,
+          load_balancer_names: [@name]
+        )
+        resp = @client.detach_load_balancers(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [AutoScalingGroup]
+      def group
+        AutoScalingGroup.new(
+          name: @group_name,
+          client: @client
+        )
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        {
+          group_name: @group_name,
+          name: @name
+        }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_group_name(args, options)
+        value = args[0] || options.delete(:group_name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :group_name"
+        else
+          msg = "expected :group_name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_name(args, options)
+        value = args[1] || options.delete(:name)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :name"
+        else
+          msg = "expected :name to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      class Collection < Aws::Resources::Collection
+
+        # @!group Batch Actions
+
+        # @example Request syntax with placeholder values
+        #
+        #   load_balancer.batch_attach()
+        # @param options ({})
+        # @return [void]
+        def batch_attach(options = {})
+          batch_enum.each do |batch|
+            params = Aws::Util.copy_hash(options)
+            params[:auto_scaling_group_name] = batch[0].group_name
+            params[:load_balancer_names] ||= []
+            batch.each do |item|
+              params[:load_balancer_names] << {
+                name: item.name
+              }
+            end
+            batch[0].client.attach_load_balancers(params)
+          end
+          nil
+        end
+
+        # @example Request syntax with placeholder values
+        #
+        #   load_balancer.batch_detach()
+        # @param options ({})
+        # @return [void]
+        def batch_detach(options = {})
+          batch_enum.each do |batch|
+            params = Aws::Util.copy_hash(options)
+            params[:auto_scaling_group_name] = batch[0].group_name
+            params[:load_balancer_names] ||= []
+            batch.each do |item|
+              params[:load_balancer_names] << {
+                name: item.name
+              }
+            end
+            batch[0].client.detach_load_balancers(params)
+          end
+          nil
+        end
+
+        # @!endgroup
+
+      end
+    end
+  end
+end