aws-sdk-euca 1.8.5

data/lib/aws/cloud_watch/alarm_collection.rb

@@ -0,0 +1,153 @@
+# Copyright 2011-2013 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

data/lib/aws/cloud_watch/alarm_history_item.rb

@@ -0,0 +1,50 @@
+# Copyright 2011-2013 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
+    class AlarmHistoryItem
+
+      # @private
+      def initialize options
+        @alarm_name = options[:alarm_name]
+        @history_data = options[:history_data]
+        @history_item_type = options[:history_item_type]
+        @history_summary = options[:history_summary]
+        @timestamp = options[:timestamp]
+      end
+
+      # @return [String] The descriptive name for the alarm.
+      attr_reader :alarm_name
+
+      # @return [String] Machine-readable data about the alarm in JSON format.
+      attr_reader :history_data
+
+      alias_method :data, :history_data
+
+      # @return [String] The type of alarm history item.
+      attr_reader :history_item_type
+
+      alias_method :type, :history_item_type
+
+      # @return [String] A human-readable summary of the alarm history.
+      attr_reader :history_summary
+
+      alias_method :summary, :history_summary
+
+      # @return [Time] The time stamp for the alarm history item.
+      attr_reader :timestamp
+
+    end
+  end
+end

data/lib/aws/cloud_watch/alarm_history_item_collection.rb

@@ -0,0 +1,84 @@
+# Copyright 2011-2013 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 'date'
+require 'time'
+
+module AWS
+  class CloudWatch
+    class AlarmHistoryItemCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      # @private
+      def initialize options = {}
+        @filters = options[:filters] || {}
+        super
+      end
+
+      # @param [String,Symbol] name
+      # @param [String] value
+      # @return [AlarmHistoryItemCollection]
+      def filter name, value
+        filters = @filters.merge(name.to_s.to_sym => value)
+        AlarmHistoryItemCollection.new(:filters => filters, :config => config)
+      end
+
+      # @param [String] name
+      # @return [AlarmHistoryItemCollection]
+      def with_alarm_name name
+        filter(:alarm_name, name)
+      end
+
+      # @param [Time,DateTime,String<ISO8601>] date
+      # @return [AlarmHistoryItemCollection]
+      def with_start_date date
+        date = date.iso8601 if date.respond_to?(:iso8601)
+        filter(:start_date, date)
+      end
+
+      # @param [Time,DateTime,String<ISO8601>] date
+      # @return [AlarmHistoryItemCollection]
+      def with_end_date date
+        date = date.iso8601 if date.respond_to?(:iso8601)
+        filter(:end_date, date)
+      end
+
+      # @param [String] type
+      # @return [AlarmHistoryItemCollection]
+      def with_type type
+        filter(:history_item_type, type)
+      end
+
+      protected
+
+      def _each_item next_token, limit, options = {}, &block
+        
+        options = @filters.merge(options)
+        options[:max_records] = limit if limit
+        options[:next_token] = next_token if next_token
+
+        resp = client.describe_alarm_history(options)
+        resp.data[:alarm_history_items].each do |details|
+          
+          yield(AlarmHistoryItem.new(details))
+
+        end
+
+       resp.data[:next_token]
+
+      end
+
+    end
+  end
+end

data/lib/aws/cloud_watch/client.rb

@@ -0,0 +1,247 @@
+# Copyright 2011-2013 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
+
+    # Client class for Cloud Watch
+    class Client < Core::QueryClient
+
+      # @private
+      CACHEABLE_REQUESTS = Set[
+        :describe_alarm_history,
+        :describe_alarms,
+        :describe_alarms_for_metric,
+        :list_metrics,
+      ]
+
+      # client methods #
+
+      # @!method delete_alarms(options = {})
+      # Calls the DeleteAlarms API operation.
+      # @param [Hash] options
+      #   * +:alarm_names+ - *required* - (Array<String>)
+      # @return [Core::Response]
+
+      # @!method describe_alarm_history(options = {})
+      # Calls the DescribeAlarmHistory API operation.
+      # @param [Hash] options
+      #   * +:alarm_name+ - (String)
+      #   * +:history_item_type+ - (String)
+      #   * +:start_date+ - (String<ISO8601 datetime>)
+      #   * +:end_date+ - (String<ISO8601 datetime>)
+      #   * +:max_records+ - (Integer)
+      #   * +:next_token+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:alarm_history_items+ - (Array<Hash>)
+      #     * +:alarm_name+ - (String)
+      #     * +:timestamp+ - (Time)
+      #     * +:history_item_type+ - (String)
+      #     * +:history_summary+ - (String)
+      #     * +:history_data+ - (String)
+      #   * +:next_token+ - (String)
+
+      # @!method describe_alarms(options = {})
+      # Calls the DescribeAlarms API operation.
+      # @param [Hash] options
+      #   * +:alarm_names+ - (Array<String>)
+      #   * +:alarm_name_prefix+ - (String)
+      #   * +:state_value+ - (String)
+      #   * +:action_prefix+ - (String)
+      #   * +:max_records+ - (Integer)
+      #   * +:next_token+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:metric_alarms+ - (Array<Hash>)
+      #     * +:alarm_name+ - (String)
+      #     * +:alarm_arn+ - (String)
+      #     * +:alarm_description+ - (String)
+      #     * +:alarm_configuration_updated_timestamp+ - (Time)
+      #     * +:actions_enabled+ - (Boolean)
+      #     * +:ok_actions+ - (Array<String>)
+      #     * +:alarm_actions+ - (Array<String>)
+      #     * +:insufficient_data_actions+ - (Array<String>)
+      #     * +:state_value+ - (String)
+      #     * +:state_reason+ - (String)
+      #     * +:state_reason_data+ - (String)
+      #     * +:state_updated_timestamp+ - (Time)
+      #     * +:metric_name+ - (String)
+      #     * +:namespace+ - (String)
+      #     * +:statistic+ - (String)
+      #     * +:dimensions+ - (Array<Hash>)
+      #       * +:name+ - (String)
+      #       * +:value+ - (String)
+      #     * +:period+ - (Integer)
+      #     * +:unit+ - (String)
+      #     * +:evaluation_periods+ - (Integer)
+      #     * +:threshold+ - (Numeric)
+      #     * +:comparison_operator+ - (String)
+      #   * +:next_token+ - (String)
+
+      # @!method describe_alarms_for_metric(options = {})
+      # Calls the DescribeAlarmsForMetric API operation.
+      # @param [Hash] options
+      #   * +:metric_name+ - *required* - (String)
+      #   * +:namespace+ - *required* - (String)
+      #   * +:statistic+ - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - *required* - (String)
+      #     * +:value+ - *required* - (String)
+      #   * +:period+ - (Integer)
+      #   * +:unit+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:metric_alarms+ - (Array<Hash>)
+      #     * +:alarm_name+ - (String)
+      #     * +:alarm_arn+ - (String)
+      #     * +:alarm_description+ - (String)
+      #     * +:alarm_configuration_updated_timestamp+ - (Time)
+      #     * +:actions_enabled+ - (Boolean)
+      #     * +:ok_actions+ - (Array<String>)
+      #     * +:alarm_actions+ - (Array<String>)
+      #     * +:insufficient_data_actions+ - (Array<String>)
+      #     * +:state_value+ - (String)
+      #     * +:state_reason+ - (String)
+      #     * +:state_reason_data+ - (String)
+      #     * +:state_updated_timestamp+ - (Time)
+      #     * +:metric_name+ - (String)
+      #     * +:namespace+ - (String)
+      #     * +:statistic+ - (String)
+      #     * +:dimensions+ - (Array<Hash>)
+      #       * +:name+ - (String)
+      #       * +:value+ - (String)
+      #     * +:period+ - (Integer)
+      #     * +:unit+ - (String)
+      #     * +:evaluation_periods+ - (Integer)
+      #     * +:threshold+ - (Numeric)
+      #     * +:comparison_operator+ - (String)
+
+      # @!method disable_alarm_actions(options = {})
+      # Calls the DisableAlarmActions API operation.
+      # @param [Hash] options
+      #   * +:alarm_names+ - *required* - (Array<String>)
+      # @return [Core::Response]
+
+      # @!method enable_alarm_actions(options = {})
+      # Calls the EnableAlarmActions API operation.
+      # @param [Hash] options
+      #   * +:alarm_names+ - *required* - (Array<String>)
+      # @return [Core::Response]
+
+      # @!method get_metric_statistics(options = {})
+      # Calls the GetMetricStatistics API operation.
+      # @param [Hash] options
+      #   * +:namespace+ - *required* - (String)
+      #   * +:metric_name+ - *required* - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - *required* - (String)
+      #     * +:value+ - *required* - (String)
+      #   * +:start_time+ - *required* - (String<ISO8601 datetime>)
+      #   * +:end_time+ - *required* - (String<ISO8601 datetime>)
+      #   * +:period+ - *required* - (Integer)
+      #   * +:statistics+ - *required* - (Array<String>)
+      #   * +:unit+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:label+ - (String)
+      #   * +:datapoints+ - (Array<Hash>)
+      #     * +:timestamp+ - (Time)
+      #     * +:sample_count+ - (Numeric)
+      #     * +:average+ - (Numeric)
+      #     * +:sum+ - (Numeric)
+      #     * +:minimum+ - (Numeric)
+      #     * +:maximum+ - (Numeric)
+      #     * +:unit+ - (String)
+
+      # @!method list_metrics(options = {})
+      # Calls the ListMetrics API operation.
+      # @param [Hash] options
+      #   * +:namespace+ - (String)
+      #   * +:metric_name+ - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - *required* - (String)
+      #     * +:value+ - (String)
+      #   * +:next_token+ - (String)
+      # @return [Core::Response]
+      #   The #data method of the response object returns
+      #   a hash with the following structure:
+      #   * +:metrics+ - (Array<Hash>)
+      #     * +:namespace+ - (String)
+      #     * +:metric_name+ - (String)
+      #     * +:dimensions+ - (Array<Hash>)
+      #       * +:name+ - (String)
+      #       * +:value+ - (String)
+      #   * +:next_token+ - (String)
+
+      # @!method put_metric_alarm(options = {})
+      # Calls the PutMetricAlarm API operation.
+      # @param [Hash] options
+      #   * +:alarm_name+ - *required* - (String)
+      #   * +:alarm_description+ - (String)
+      #   * +:actions_enabled+ - (Boolean)
+      #   * +:ok_actions+ - (Array<String>)
+      #   * +:alarm_actions+ - (Array<String>)
+      #   * +:insufficient_data_actions+ - (Array<String>)
+      #   * +:metric_name+ - *required* - (String)
+      #   * +:namespace+ - *required* - (String)
+      #   * +:statistic+ - *required* - (String)
+      #   * +:dimensions+ - (Array<Hash>)
+      #     * +:name+ - *required* - (String)
+      #     * +:value+ - *required* - (String)
+      #   * +:period+ - *required* - (Integer)
+      #   * +:unit+ - (String)
+      #   * +:evaluation_periods+ - *required* - (Integer)
+      #   * +:threshold+ - *required* - (Float)
+      #   * +:comparison_operator+ - *required* - (String)
+      # @return [Core::Response]
+
+      # @!method put_metric_data(options = {})
+      # Calls the PutMetricData API operation.
+      # @param [Hash] options
+      #   * +:namespace+ - *required* - (String)
+      #   * +:metric_data+ - *required* - (Array<Hash>)
+      #     * +:metric_name+ - *required* - (String)
+      #     * +:dimensions+ - (Array<Hash>)
+      #       * +:name+ - *required* - (String)
+      #       * +:value+ - *required* - (String)
+      #     * +:timestamp+ - (String<ISO8601 datetime>)
+      #     * +:value+ - (Float)
+      #     * +:statistic_values+ - (Hash)
+      #       * +:sample_count+ - *required* - (Float)
+      #       * +:sum+ - *required* - (Float)
+      #       * +:minimum+ - *required* - (Float)
+      #       * +:maximum+ - *required* - (Float)
+      #     * +:unit+ - (String)
+      # @return [Core::Response]
+
+      # @!method set_alarm_state(options = {})
+      # Calls the SetAlarmState API operation.
+      # @param [Hash] options
+      #   * +:alarm_name+ - *required* - (String)
+      #   * +:state_value+ - *required* - (String)
+      #   * +:state_reason+ - *required* - (String)
+      #   * +:state_reason_data+ - (String)
+      # @return [Core::Response]
+
+      # end client methods #
+
+      define_client_methods('2010-08-01')
+
+    end
+  end
+end