class AWS::CloudWatch

This class is the starting point for working with Amazon CloudWatch.

To use Amazon CloudWatch you must first sign up here.

For more information about Amazon CloudWatch:

Credentials

You can setup default credentials for all AWS services via AWS.config:

AWS.config(
  :access_key_id => 'YOUR_ACCESS_KEY_ID',
  :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')

Or you can set them directly on the AWS::Route53 interface:

cw = AWS::CloudWatch.new(
  :access_key_id => 'YOUR_ACCESS_KEY_ID',
  :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')

Using the Client

AWS::CloudWatch does not provide higher level abstractions for CloudWatch at this time. You can still access all of the API methods using {AWS::CloudWatch::Client}. Here is how you access the client and make a simple request:

cw = AWS::CloudWatch.new

resp = cw.client.describe_alarms
resp[:metric_alarms].each do |alarm|
  puts alarm[:alarm_name]
end

See {Client} for documentation on all of the supported operations.

@!attribute [r] client

@return [Client] the low-level CloudWatch client object

Public Instance Methods

alarm_history_items() click to toggle source

@return [AlarmHistoryItemCollection]

# File lib/aws/cloud_watch.rb, line 109
def alarm_history_items
  AlarmHistoryItemCollection.new(:config => config)
end
alarms() click to toggle source

@return [AlarmCollection]

# File lib/aws/cloud_watch.rb, line 104
def alarms
  AlarmCollection.new(:config => config)
end
metrics(options = {}) click to toggle source

@return [MetricCollection]

# File lib/aws/cloud_watch.rb, line 114
def metrics options = {}
  MetricCollection.new(options.merge(:config => config))
end
put_metric_data(options = {}) click to toggle source

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]

# File lib/aws/cloud_watch.rb, line 98
def put_metric_data options = {}
  client.put_metric_data(options)
  nil
end