aws-sdk 1.5.6 → 1.5.7

data/lib/aws/auto_scaling/activity.rb

@@ -1,6 +1,5 @@
 # Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#.kkk:w
-
+#
 # Licensed under the Apache License, Version 2.0 (the "License"). You
 # may not use this file except in compliance with the License. A copy of
 # the License is located at
@@ -12,6 +11,7 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
+
 module AWS
   class AutoScaling
 

data/lib/aws/auto_scaling/activity_collection.rb

@@ -36,7 +36,7 @@ module AWS
     #   
     class ActivityCollection
 
-      include Core::Collection::Limitable
+      include Core::Collection::WithLimitAndNextToken
       
       # @private
       def initialize options = {}

data/lib/aws/auto_scaling/group_collection.rb

@@ -17,7 +17,7 @@ module AWS
     class GroupCollection
 
       include GroupOptions
-      include Core::Collection::Limitable
+      include Core::Collection::WithLimitAndNextToken
 
       # Creates an Auto Scaling Group.
       #

data/lib/aws/auto_scaling/instance_collection.rb

@@ -28,7 +28,7 @@ module AWS
     #
     class InstanceCollection
 
-      include Core::Collection::Limitable
+      include Core::Collection::WithLimitAndNextToken
       
       # @param [String] instance_id An {EC2::Instance} id string.
       # @return [AutoScaling::Instance]

data/lib/aws/auto_scaling/launch_configuration_collection.rb

@@ -17,7 +17,7 @@ module AWS
   class AutoScaling
     class LaunchConfigurationCollection
 
-      include Core::Collection::Limitable
+      include Core::Collection::WithLimitAndNextToken
 
       # Creates an Auto Scaling launch configuration.
       #

data/lib/aws/auto_scaling/notification_configuration_collection.rb

@@ -47,7 +47,7 @@ module AWS
     #
     class NotificationConfigurationCollection
 
-      include Core::Collection::Limitable
+      include Core::Collection::WithLimitAndNextToken
       
       # @private
       def initialize options = {}

data/lib/aws/auto_scaling/scaling_policy_collection.rb

@@ -15,7 +15,7 @@ module AWS
   class AutoScaling
     class ScalingPolicyCollection
 
-      include Core::Collection::Limitable
+      include Core::Collection::WithLimitAndNextToken
       include ScalingPolicyOptions
       
       def initialize auto_scaling_group, options = {}

data/lib/aws/auto_scaling/scheduled_action_collection.rb

@@ -18,7 +18,7 @@ module AWS
 
     class ScheduledActionCollection
 
-      include Core::Collection::Limitable
+      include Core::Collection::WithLimitAndNextToken
       
       # @private
       def initialize options = {}

data/lib/aws/auto_scaling/tag_collection.rb

@@ -59,7 +59,7 @@ module AWS
     # 
     class TagCollection
 
-      include Core::Collection::Limitable
+      include Core::Collection::WithLimitAndNextToken
 
       # @private
       def initialize options = {}

data/lib/aws/cloud_watch.rb

@@ -0,0 +1,75 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/core'
+require 'aws/cloud_watch/config'
+
+module AWS
+  class CloudWatch
+
+    AWS.register_autoloads(self, 'aws/cloud_watch') do
+      autoload :Alarm, 'alarm'
+      autoload :AlarmCollection, 'alarm_collection'
+      autoload :AlarmHistoryItem, 'alarm_history_item'
+      autoload :AlarmHistoryItemCollection, 'alarm_history_item_collection'
+      autoload :Client, 'client'
+      autoload :Errors, 'errors'
+      autoload :Metric, 'metric'
+      autoload :MetricCollection, 'metric_collection'
+      autoload :MetricAlarmCollection, 'metric_alarm_collection'
+      autoload :MetricStatistics, 'metric_statistics'
+      autoload :Request, 'request'
+    end
+
+    include Core::ServiceInterface
+
+    # Puts data for a metric.  The metric is created if it does not already
+    # exist.
+    #
+    #   cw.put_metric_data(
+    #     :namespace => 'test/cli',
+    #     :metric_data => [
+    #       { :metric_name => 'sample', :value => 1 },
+    #       { :metric_name => 'sample', :value => 2 },
+    #       { :metric_name => 'sample', :value => 3 },
+    #       { :metric_name => 'sample', :value => 4 },
+    #       { :metric_name => 'sample', :value => 5 },
+    #     ]
+    #   )
+    #
+    # @param [Hash] options
+    # @see Client#put_metric_data
+    # @return [nil]
+    #
+    def put_metric_data options = {}
+      client.put_metric_data(options)
+      nil
+    end
+
+    # @return [AlarmCollection]
+    def alarms
+      AlarmCollection.new(:config => config)
+    end
+
+    # @return [AlarmHistoryItemCollection]
+    def alarm_history_items
+      AlarmHistoryItemCollection.new(:config => config)
+    end
+
+    # @return [MetricCollection]
+    def metrics options = {}
+      MetricCollection.new(options.merge(:config => config))
+    end
+
+  end
+end

data/lib/aws/cloud_watch/alarm.rb

@@ -0,0 +1,272 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+
+    # @attr_reader [String] metric_name
+    #
+    # @attr_reader [String] namespace
+    #
+    # @attr_reader [Array<Hash>] dimensions
+    #
+    # @attr_reader [Boolean] enabled Indicates whether actions 
+    #   should be executed during any changes to the alarm's state.
+    #
+    # @attr_reader [Array<String>] actions The list of actions to execute 
+    #   when this alarm transitions into an ALARM state from any other 
+    #   state.
+    #
+    # @attr_reader [String] arn The Amazon Resource Name (ARN) of the alarm.
+    #
+    # @attr_reader [Time] configuration_updated_timestamp
+    #   The time stamp of the last update to the alarm configuration.
+    #
+    # @attr_reader [String] description The description for the alarm.
+    #
+    # @attr_reader [String] comparison_operator The arithmetic operation to 
+    #   use when comparing the specified Statistic and Threshold. The 
+    #   specified Statistic value is used as the first operand.
+    #
+    # @attr_reader [Integer] evaluation_periods The number of periods over 
+    #   which data is compared to the specified threshold.
+    #
+    # @attr_reader [Array<Hash>] insufficient_data_actions The list of
+    #   actions to execute when this alarm transitions into an
+    #   INSUFFICIENT_DATA state
+    #
+    # @attr_reader [Array<Hash>] ok_actions The list of actions to execute
+    #   when this alarm transitions into an OK state.
+    #
+    # @attr_reader [Integer] period The period in seconds over which the 
+    #   statistic is applied.
+    #
+    # @attr_reader [String] state_reason A human-readable explanation for
+    #   the alarm's state.
+    #
+    # @attr_reader [String] state_reason_data An explanation for the alarm's
+    #   state in machine-readable JSON format.
+    #
+    # @attr_reader [Time] state_updated_timestamp When the alarm's state
+    #   last updated.
+    #
+    # @attr_reader [String] state_value The state value for the alarm.
+    #
+    # @attr_reader [Float] threshold The value against which the specified
+    #   statistic is compared.
+    #
+    # @attr_reader [String] unit The unit of the alarm's associated metric.
+    #
+    class Alarm < Core::Resource
+
+      # @private
+      def initialize alarm_name, options = {}
+        @alarm_name = alarm_name
+        super
+      end
+
+      # @return [String]
+      attr_reader :alarm_name
+
+      alias_method :name, :alarm_name
+
+      attribute :namespace, :static => true
+
+      attribute :metric_name, :static => true
+
+      attribute :dimensions, :static => true
+
+      attribute :actions_enabled
+
+      alias_method :enabled, :actions_enabled
+
+      alias_method :enabled?, :enabled
+
+      attribute :alarm_actions
+
+      alias_method :actions, :alarm_actions
+
+      attribute :alarm_arn, :static => true
+
+      alias_method :arn, :alarm_arn
+
+      attribute :alarm_configuration_updated_timestamp
+
+      alias_method :configuration_updated_timestamp, 
+        :alarm_configuration_updated_timestamp
+
+      attribute :alarm_description
+
+      alias_method :description, :alarm_description
+
+      attribute :comparison_operator
+
+      attribute :evaluation_periods
+
+      attribute :insufficient_data_actions
+
+      attribute :ok_actions
+
+      attribute :period
+
+      attribute :state_reason
+
+      attribute :state_reason_data
+
+      attribute :state_updated_timestamp
+
+      attribute :state_value
+
+      attribute :statistic
+
+      attribute :threshold
+
+      attribute :unit
+
+      populates_from :describe_alarms do |resp|
+        resp.data[:metric_alarms].find{|a| a[:alarm_name] == alarm_name }
+      end
+
+      populates_from :describe_alarms_for_metric do |resp|
+        resp.data[:metric_alarms].find{|a| a[:alarm_name] == alarm_name }
+      end
+
+      # @return [Metric]
+      def metric
+        options = {}
+        options[:dimensions] = dimensions unless dimensions.empty?
+        options[:config] = config
+        Metric.new(namespace, metric_name, options)
+      end
+
+      # Updates the metric alarm.
+      #
+      # @option options [String,required] :comparison_operator The arithmetic
+      #   operation to use when comparing the specified Statistic and 
+      #   Threshold. The specified Statistic value is used as the first 
+      #   operand.  Valid values inlucde:
+      #   * 'GreaterThanOrEqualToThreshold'
+      #   * 'GreaterThanThreshold'
+      #   * 'LessThanThreshold'
+      #   * 'LessThanOrEqualToThreshold'
+      # @option options [Integer,required] :evaluation_periods The number 
+      #   of periods over which data is compared to the specified threshold.
+      # @option options [Integer,required] :period The period in seconds 
+      #   over which the specified statistic is applied.
+      # @option options [String,required] :statistic The statistic to apply 
+      #   to the alarm's associated metric. Valid values include:
+      #   * 'SampleCount'
+      #   * 'Average'
+      #   * 'Sum'
+      #   * 'Minimum'
+      #   * 'Maximum'
+      # @option options [Number,required] :threshold The value against which
+      #   the specified statistic is compared.
+      # @option options [Array<String>] :insufficient_data_actions
+      #   The list of actions to execute when this alarm transitions into an 
+      #   INSUFFICIENT_DATA state from any other state. Each action is 
+      #   specified as an Amazon Resource Number (ARN). Currently the only 
+      #   action supported is publishing to an Amazon SNS topic or an 
+      #   Amazon Auto Scaling policy.
+      # @option options [Array<String>] :ok_actions The list of actions to
+      #   execute when this alarm transitions into an OK state from any
+      #   other state. Each action is specified as an Amazon Resource
+      #   Number (ARN). Currently the only action supported is publishing to
+      #   an Amazon SNS topic or an Amazon Auto Scaling policy.
+      # @option options [Boolean] :actions_enabled Indicates whether or not 
+      #   actions should be executed during any changes to the alarm's 
+      #   state.
+      # @option options [Array<String>] :alarm_actions The list of actions 
+      #   to execute when this alarm transitions into an ALARM state from 
+      #   any other state. Each action is specified as an Amazon Resource 
+      #   Number (ARN). Currently the only action supported is publishing 
+      #   to an Amazon SNS topic or an Amazon Auto Scaling policy.
+      #   Maximum of 5 alarm actions.
+      # @option options [String] :alarm_description The description for 
+      #   the alarm.
+      # @option options [String] :unit The unit for the alarm's associated 
+      #   metric.
+      # @return [nil]
+      def update options = {}
+        options[:alarm_name] = alarm_name
+        client.put_metric_alarm(options)
+        nil
+      end
+
+      # Deletes the current alarm.
+      # @return [nil]
+      def delete
+        client.delete_alarms(:alarm_names => [ alarm_name ])
+        nil
+      end
+
+      # Disable the current alarm actions.
+      # @return [nil]
+      def disable
+        client.disable_alarm_actions(:alarm_names => [ alarm_name ])
+        nil
+      end
+
+      # Enable the current alarm actions.
+      # @return [nil]
+      def enable
+        client.enable_alarm_actions(:alarm_names => [ alarm_name ])
+        nil
+      end
+
+      # @return [Boolean] Returns true if this alarm exists.
+      def exists?
+        !get_resource.data[:metric_alarms].empty?
+      end
+
+      # Returns a collection of the history items for current alarm.
+      # @return [AlarmHistoryItemCollection]
+      def history_items options = {}
+        AlarmHistoryItemCollection.new(:config => config).with_alarm_name(name)
+      end
+      alias_method :history, :history_items
+      alias_method :histories, :history_items
+
+      # Temporarily sets the state of current alarm.
+      # @param [String] reason The reason that this alarm is set to this 
+      #   specific state (in human-readable text format).
+      # @param [String] value Valid values include:
+      #   * 'OK'
+      #   * 'ALARM'
+      #   * 'INSUFFICIENT_DATA'
+      # @param [Hash] options
+      # @option options [String] :state_reason_data The reason that this 
+      #   alarm is set to this specific state (in machine-readable JSON 
+      #   format)
+      # @return [nil]
+      def set_state reason, value, options = {}
+        options[:alarm_name] = alarm_name
+        options[:state_reason] = reason
+        options[:state_value] = value
+        client.set_alarm_state(options)
+        nil
+      end
+
+      protected
+
+      def resource_identifiers
+        [[:alarm_name, alarm_name]]
+      end
+
+      def get_resource attr_name = nil
+        client.describe_alarms(:alarm_names => [ alarm_name ])
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_watch/alarm_collection.rb

@@ -0,0 +1,153 @@
+# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class CloudWatch
+
+    # = AlarmCollection
+    # 
+    # Represents alarms for an AWS account.
+    #
+    # == Getting an alarm by name
+    #
+    # If you know the name of the alarm, you can get a reference using
+    # the {#[]} method.
+    #
+    #   cw = AWS::CloudWatch.new
+    #   alarm = cw.alarms['alarm-name']
+    #
+    # == Enumerating Alarms
+    #
+    # You can enumerate all alarms using each (or any of the
+    # methods defined in {Core::Collection}).
+    #
+    #   cw.alarms.each do |alarm|
+    #     puts alarm.name
+    #   end
+    #
+    # == Filtering Alarms
+    #
+    # Use one of the filtering methods to reduce the number of alarms
+    # returned.
+    #
+    #   cw.alarms.with_name_prefix('some-prefix-').each {|alarm| ... }
+    #
+    class AlarmCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      def initialize options = {}
+        @filters = options[:filters] || {}
+        super
+      end
+
+      # @param [String] alarm_name
+      # @return [Alarm]
+      def [] alarm_name
+        Alarm.new(alarm_name, :config => config)
+      end
+
+      # Creates an alarm and associates it with the specified metric.
+      #
+      # @param [String] alarm_name The descriptive name for the alarm. 
+      #   This name must be unique within the user's AWS account.
+      # @param [Hash] options
+      # @option options [String,required] :namespace The namespace for the 
+      #   alarm's associated metric.
+      # @option options [String,required] :metric_name The name for the 
+      #   alarm's associated metric.
+      # @option options [Array<Hash>] :dimensions The dimensions for the 
+      #   alarm's associated metric.  Each dimension must specify a
+      #   +:name+ and a +:value+.
+      # @option (see Alarm#update)
+      # @return [Alarm]
+      def create alarm_name, options = {}
+        options[:alarm_name] = alarm_name
+        client.put_metric_alarm(options)
+        self[alarm_name]
+      end
+
+      # Delete one or more alarms by name.
+      #
+      #   cloud_watch.alarms.delete('alarm1', 'alarm2')
+      #
+      # @param [String,Array<String>] alarm_names
+      # @return [nil]
+      def delete *alarm_names
+        client.delete_alarms(:alarm_names => alarm_names.flatten)
+        nil
+      end
+
+      # Returns a new collection with the given filter.
+      # @param [String,Symbol] name
+      # @param [String,Integer] value
+      # @return [Alarm]
+      def filter name, value
+        filters = @filters.merge(name.to_s.to_sym => value)
+        AlarmCollection.new(:filters => filters, :config => config)
+      end
+
+      # @param [String] prefix
+      # @return [MetricAlarmCollection]
+      def with_action_prefix prefix
+        filter(:action_prefix, prefix)
+      end
+
+      # @param [String] prefix The alarm name prefix.
+      # @return [MetricAlarmCollection]
+      def with_name_prefix prefix
+        filter(:alarm_name_prefix, prefix)
+      end
+
+      # @param [String,Array<String>] names A list of alarm names to
+      #   retrieve information for.
+      # @return [MetricAlarmCollection]
+      def with_name *names
+        filter(:alarm_names, names.flatten)
+      end
+
+      # @param [String] state The state value to be used in matching alarms.
+      # @return [MetricAlarmCollection]
+      def with_state_value state
+        filter(:state_value, state)
+      end
+
+      protected
+
+      def _each_item next_token, limit, options = {}, &block
+
+        options = @filters.merge(options)
+
+        options[:next_token] = next_token if next_token
+        options[:max_records] = limit if limit
+
+        resp = client.describe_alarms(options)
+        resp.data[:metric_alarms].each do |details|
+
+          alarm = Alarm.new_from(
+            :describe_alarms,
+            details, 
+            details[:alarm_name],
+            :config => config)
+
+          yield(alarm)
+
+        end
+
+        resp.data[:next_token]
+
+      end
+
+    end
+  end
+end