aws-sdk-autoscaling 1.0.0.rc1

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

@@ -0,0 +1,258 @@
+# 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 ScalingPolicy
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(name, options = {})
+      #   @param [String] name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @name = extract_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def name
+        @name
+      end
+      alias :policy_name :name
+
+      # The name of the Auto Scaling group associated with this scaling
+      # policy.
+      # @return [String]
+      def auto_scaling_group_name
+        data.auto_scaling_group_name
+      end
+
+      # The Amazon Resource Name (ARN) of the policy.
+      # @return [String]
+      def policy_arn
+        data.policy_arn
+      end
+
+      # The policy type. Valid values are `SimpleScaling` and `StepScaling`.
+      # @return [String]
+      def policy_type
+        data.policy_type
+      end
+
+      # The adjustment type, which specifies how `ScalingAdjustment` is
+      # interpreted. Valid values are `ChangeInCapacity`, `ExactCapacity`, and
+      # `PercentChangeInCapacity`.
+      # @return [String]
+      def adjustment_type
+        data.adjustment_type
+      end
+
+      # Available for backward compatibility. Use `MinAdjustmentMagnitude`
+      # instead.
+      # @return [Integer]
+      def min_adjustment_step
+        data.min_adjustment_step
+      end
+
+      # The minimum number of instances to scale. If the value of
+      # `AdjustmentType` is `PercentChangeInCapacity`, the scaling policy
+      # changes the `DesiredCapacity` of the Auto Scaling group by at least
+      # this many instances. Otherwise, the error is `ValidationError`.
+      # @return [Integer]
+      def min_adjustment_magnitude
+        data.min_adjustment_magnitude
+      end
+
+      # The amount by which to scale, based on the specified adjustment type.
+      # A positive value adds to the current capacity while a negative number
+      # removes from the current capacity.
+      # @return [Integer]
+      def scaling_adjustment
+        data.scaling_adjustment
+      end
+
+      # The amount of time, in seconds, after a scaling activity completes
+      # before any further trigger-related scaling activities can start.
+      # @return [Integer]
+      def cooldown
+        data.cooldown
+      end
+
+      # A set of adjustments that enable you to scale based on the size of the
+      # alarm breach.
+      # @return [Array<Types::StepAdjustment>]
+      def step_adjustments
+        data.step_adjustments
+      end
+
+      # The aggregation type for the CloudWatch metrics. Valid values are
+      # `Minimum`, `Maximum`, and `Average`.
+      # @return [String]
+      def metric_aggregation_type
+        data.metric_aggregation_type
+      end
+
+      # The estimated time, in seconds, until a newly launched instance can
+      # contribute to the CloudWatch metrics.
+      # @return [Integer]
+      def estimated_instance_warmup
+        data.estimated_instance_warmup
+      end
+
+      # The CloudWatch alarms related to the policy.
+      # @return [Array<Types::Alarm>]
+      def alarms
+        data.alarms
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {ScalingPolicy}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     scaling_policy.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.describe_policies(policy_names: [@name])
+        @data = resp.scalingpolicies[0]
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::ScalingPolicy]
+      #   Returns the data for this {ScalingPolicy}. Calls
+      #   {Client#describe_policies} 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
+      #
+      #   scaling_policy.delete({
+      #     auto_scaling_group_name: "ResourceName",
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :auto_scaling_group_name
+      #   The name of the Auto Scaling group.
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = options.merge(policy_name: @name)
+        resp = @client.delete_policy(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   scaling_policy.execute({
+      #     auto_scaling_group_name: "ResourceName",
+      #     honor_cooldown: false,
+      #     metric_value: 1.0,
+      #     breach_threshold: 1.0,
+      #   })
+      # @param [Hash] options ({})
+      # @option options [String] :auto_scaling_group_name
+      #   The name or Amazon Resource Name (ARN) of the Auto Scaling group.
+      # @option options [Boolean] :honor_cooldown
+      #   If this parameter is true, Auto Scaling waits for the cooldown period
+      #   to complete before executing the policy. Otherwise, Auto Scaling
+      #   executes the policy without waiting for the cooldown period to
+      #   complete.
+      #
+      #   This parameter is not supported if the policy type is `StepScaling`.
+      #
+      #   For more information, see [Auto Scaling Cooldowns][1] in the *Auto
+      #   Scaling User Guide*.
+      #
+      #
+      #
+      #   [1]: http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html
+      # @option options [Float] :metric_value
+      #   The metric value to compare to `BreachThreshold`. This enables you to
+      #   execute a policy of type `StepScaling` and determine which step
+      #   adjustment to use. For example, if the breach threshold is 50 and you
+      #   want to use a step adjustment with a lower bound of 0 and an upper
+      #   bound of 10, you can set the metric value to 59.
+      #
+      #   If you specify a metric value that doesn't correspond to a step
+      #   adjustment for the policy, the call returns an error.
+      #
+      #   This parameter is required if the policy type is `StepScaling` and not
+      #   supported otherwise.
+      # @option options [Float] :breach_threshold
+      #   The breach threshold for the alarm.
+      #
+      #   This parameter is required if the policy type is `StepScaling` and not
+      #   supported otherwise.
+      # @return [EmptyStructure]
+      def execute(options = {})
+        options = options.merge(policy_name: @name)
+        resp = @client.execute_policy(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [AutoScalingGroup, nil]
+      def group
+        if data.auto_scaling_group_name
+          AutoScalingGroup.new(
+            name: data.auto_scaling_group_name,
+            client: @client
+          )
+        else
+          nil
+        end
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        { name: @name }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_name(args, options)
+        value = args[0] || 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/scheduled_action.rb

@@ -0,0 +1,183 @@
+# 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 ScheduledAction
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(name, options = {})
+      #   @param [String] name
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :name
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @name = extract_name(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def name
+        @name
+      end
+      alias :scheduled_action_name :name
+
+      # The name of the group.
+      # @return [String]
+      def auto_scaling_group_name
+        data.auto_scaling_group_name
+      end
+
+      # The Amazon Resource Name (ARN) of the scheduled action.
+      # @return [String]
+      def scheduled_action_arn
+        data.scheduled_action_arn
+      end
+
+      # This parameter is deprecated.
+      # @return [Time]
+      def time
+        data.time
+      end
+
+      # The date and time that the action is scheduled to begin. This date and
+      # time can be up to one month in the future.
+      #
+      # When `StartTime` and `EndTime` are specified with `Recurrence`, they
+      # form the boundaries of when the recurring action will start and stop.
+      # @return [Time]
+      def start_time
+        data.start_time
+      end
+
+      # The date and time that the action is scheduled to end. This date and
+      # time can be up to one month in the future.
+      # @return [Time]
+      def end_time
+        data.end_time
+      end
+
+      # The recurring schedule for the action.
+      # @return [String]
+      def recurrence
+        data.recurrence
+      end
+
+      # The minimum size of the group.
+      # @return [Integer]
+      def min_size
+        data.min_size
+      end
+
+      # The maximum size of the group.
+      # @return [Integer]
+      def max_size
+        data.max_size
+      end
+
+      # The number of instances you prefer to maintain in the group.
+      # @return [Integer]
+      def desired_capacity
+        data.desired_capacity
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {ScheduledAction}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     scheduled_action.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.describe_scheduled_actions(scheduled_action_names: [@name])
+        @data = resp.scheduledupdategroupactions[0]
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::ScheduledUpdateGroupAction]
+      #   Returns the data for this {ScheduledAction}. Calls
+      #   {Client#describe_scheduled_actions} 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
+      #
+      #   scheduled_action.delete({
+      #     auto_scaling_group_name: "ResourceName", # required
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, String] :auto_scaling_group_name
+      #   The name of the Auto Scaling group.
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = options.merge(scheduled_action_name: @name)
+        resp = @client.delete_scheduled_action(options)
+        resp.data
+      end
+
+      # @!group Associations
+
+      # @return [AutoScalingGroup, nil]
+      def group
+        if data.auto_scaling_group_name
+          AutoScalingGroup.new(
+            name: data.auto_scaling_group_name,
+            client: @client
+          )
+        else
+          nil
+        end
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        { name: @name }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_name(args, options)
+        value = args[0] || 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/tag.rb

@@ -0,0 +1,260 @@
+# 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 Tag
+
+      extend Aws::Deprecations
+
+      # @overload def initialize(key, resource_id, resource_type, options = {})
+      #   @param [String] key
+      #   @param [String] resource_id
+      #   @param [String] resource_type
+      #   @option options [Client] :client
+      # @overload def initialize(options = {})
+      #   @option options [required, String] :key
+      #   @option options [required, String] :resource_id
+      #   @option options [required, String] :resource_type
+      #   @option options [Client] :client
+      def initialize(*args)
+        options = Hash === args.last ? args.pop.dup : {}
+        @key = extract_key(args, options)
+        @resource_id = extract_resource_id(args, options)
+        @resource_type = extract_resource_type(args, options)
+        @data = options.delete(:data)
+        @client = options.delete(:client) || Client.new(options)
+      end
+
+      # @!group Read-Only Attributes
+
+      # @return [String]
+      def key
+        @key
+      end
+
+      # @return [String]
+      def resource_id
+        @resource_id
+      end
+
+      # @return [String]
+      def resource_type
+        @resource_type
+      end
+
+      # The tag value.
+      # @return [String]
+      def value
+        data.value
+      end
+
+      # Determines whether the tag is added to new instances as they are
+      # launched in the group.
+      # @return [Boolean]
+      def propagate_at_launch
+        data.propagate_at_launch
+      end
+
+      # @!endgroup
+
+      # @return [Client]
+      def client
+        @client
+      end
+
+      # Loads, or reloads {#data} for the current {Tag}.
+      # Returns `self` making it possible to chain methods.
+      #
+      #     tag.reload.data
+      #
+      # @return [self]
+      def load
+        resp = @client.describe_tags(filters: [
+          {
+            name: "key",
+            values: [@key]
+          },
+          {
+            name: @resource_type,
+            values: [@resource_id]
+          }
+        ])
+        @data = resp.tags[0]
+        self
+      end
+      alias :reload :load
+
+      # @return [Types::TagDescription]
+      #   Returns the data for this {Tag}. Calls
+      #   {Client#describe_tags} 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
+      #
+      #   tag.create({
+      #     tags: [ # required
+      #       {
+      #         resource_id: "XmlString",
+      #         resource_type: "XmlString",
+      #         key: "TagKey", # required
+      #         value: "TagValue",
+      #         propagate_at_launch: false,
+      #       },
+      #     ],
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, Array<Types::Tag>] :tags
+      #   One or more tags.
+      # @return [EmptyStructure]
+      def create(options = {})
+        options = Aws::Util.deep_merge(options, tags: [{
+          resource_type: @resource_type,
+          resource_id: @resource_id,
+          key: @key
+        }])
+        resp = @client.create_or_update_tags(options)
+        resp.data
+      end
+
+      # @example Request syntax with placeholder values
+      #
+      #   tag.delete({
+      #     tags: [ # required
+      #       {
+      #         resource_id: "XmlString",
+      #         resource_type: "XmlString",
+      #         key: "TagKey", # required
+      #         value: "TagValue",
+      #         propagate_at_launch: false,
+      #       },
+      #     ],
+      #   })
+      # @param [Hash] options ({})
+      # @option options [required, Array<Types::Tag>] :tags
+      #   One or more tags.
+      # @return [EmptyStructure]
+      def delete(options = {})
+        options = Aws::Util.deep_merge(options, tags: [{
+          resource_type: @resource_type,
+          resource_id: @resource_id,
+          key: @key
+        }])
+        resp = @client.delete_tags(options)
+        resp.data
+      end
+
+      # @deprecated
+      # @api private
+      def identifiers
+        {
+          key: @key,
+          resource_id: @resource_id,
+          resource_type: @resource_type
+        }
+      end
+      deprecated(:identifiers)
+
+      private
+
+      def extract_key(args, options)
+        value = args[0] || options.delete(:key)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :key"
+        else
+          msg = "expected :key to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_resource_id(args, options)
+        value = args[1] || options.delete(:resource_id)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :resource_id"
+        else
+          msg = "expected :resource_id to be a String, got #{value.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      def extract_resource_type(args, options)
+        value = args[2] || options.delete(:resource_type)
+        case value
+        when String then value
+        when nil then raise ArgumentError, "missing required option :resource_type"
+        else
+          msg = "expected :resource_type 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
+        #
+        #   tag.batch_create()
+        # @param options ({})
+        # @return [void]
+        def batch_create(options = {})
+          batch_enum.each do |batch|
+            params = Aws::Util.copy_hash(options)
+            params[:tags] ||= []
+            batch.each do |item|
+              params[:tags] << {
+                resource_type: item.resource_type,
+                resource_id: item.resource_id,
+                key: item.key
+              }
+            end
+            batch[0].client.create_or_update_tags(params)
+          end
+          nil
+        end
+
+        # @example Request syntax with placeholder values
+        #
+        #   tag.batch_delete!()
+        # @param options ({})
+        # @return [void]
+        def batch_delete!(options = {})
+          batch_enum.each do |batch|
+            params = Aws::Util.copy_hash(options)
+            params[:tags] ||= []
+            batch.each do |item|
+              params[:tags] << {
+                resource_type: item.resource_type,
+                resource_id: item.resource_id,
+                key: item.key
+              }
+            end
+            batch[0].client.delete_tags(params)
+          end
+          nil
+        end
+
+        # @!endgroup
+
+      end
+    end
+  end
+end