aws-sdk 1.3.8 → 1.3.9

data/lib/aws/auto_scaling.rb

@@ -0,0 +1,162 @@
+# 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/auto_scaling/config'
+
+module AWS
+
+  # This class is the starting point for working with Auto Scaling.
+  #
+  # To use Auto Scaling you must first 
+  # {sign up here}[http://aws.amazon.com/autoscaling/].
+  #
+  # For more information about Auto Scaling:
+  #
+  # * {Auto Scaling}[http://aws.amazon.com/autoscaling/]
+  # * {Auto Scaling Documentation}[http://aws.amazon.com/documentation/autoscaling/]
+  #
+  # = 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::AutoSclaing interface:
+  #
+  #   auto_scaling = AWS::AutoScaling.new(
+  #     :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #     :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # = Launch Configurations
+  #
+  # You need to create a launch configuration before you can create
+  # an Auto Scaling Group.
+  #
+  #   # needs a name, image id, and instance type
+  #   launch_config = auto_scaling.launch_configurations.create(
+  #     'launch-config-name', 'ami-12345', 'm1-small')
+  #
+  # If you have previously created a launch configuration you can 
+  # reference using the {LaunchConfigurationCollection}.
+  #
+  #   launch_config = auto_scaling.launch_configurations['launch-config-name']
+  #
+  # = Auto Scaling Groups
+  #
+  # Given a launch configuration, you can now create an Auto Scaling {Group}.
+  #
+  #   group = auto_scaling.groups.create('group-name', 
+  #     :launch_configuration => launch_config,
+  #     :availability_zones => %(us-east-1a us-east-1b),
+  #     :min_size => 1,
+  #     :max_size => 4)
+  #
+  class AutoScaling
+
+    AWS.register_autoloads(self, 'aws/auto_scaling') do
+      autoload :Activity, 'activity'
+      autoload :ActivityCollection, 'activity_collection'
+      autoload :Client, 'client'
+      autoload :Errors, 'errors'
+      autoload :Group, 'group'
+      autoload :GroupCollection, 'group_collection'
+      autoload :GroupOptions, 'group_options'
+      autoload :Instance, 'instance'
+      autoload :InstanceCollection, 'instance_collection'
+      autoload :LaunchConfiguration, 'launch_configuration'
+      autoload :LaunchConfigurationCollection, 'launch_configuration_collection'
+      autoload :NotificationConfiguration, 'notification_configuration'
+      autoload :NotificationConfigurationCollection, 'notification_configuration_collection'
+      autoload :Request, 'request'
+      autoload :ScalingPolicy, 'scaling_policy'
+      autoload :ScalingPolicyCollection, 'scaling_policy_collection'
+      autoload :ScalingPolicyOptions, 'scaling_policy_options'
+      autoload :ScheduledAction, 'scheduled_action'
+      autoload :ScheduledActionCollection, 'scheduled_action_collection'
+      autoload :Tag, 'tag'
+      autoload :TagCollection, 'tag_collection'
+    end
+
+    include Core::ServiceInterface
+
+    # @return [LaunchConfigurationCollection]
+    def launch_configurations
+      LaunchConfigurationCollection.new(:config => config)
+    end
+
+    # @return [GroupCollection]
+    def groups
+      GroupCollection.new(:config => config)
+    end
+
+    # @return [TagCollection]
+    def tags
+      TagCollection.new(:config => config)
+    end
+
+    # @return [NotificationConfigurationCollection]
+    def notification_configurations
+      NotificationConfigurationCollection.new(:config => config)
+    end
+
+    # @return [AutoScaling::InstancesCollection] Returns a collection of
+    #   {AutoScaling::Instance} objects.  Each of these is a small
+    #   wrapper around an {EC::Instance} with additional attributes.
+    def instances
+      InstanceCollection.new(:config => config)
+    end
+
+    # @return [ActivityCollection]
+    def activities
+      ActivityCollection.new(:config => config)
+    end
+
+    # @return [ScheduledActionCollection]
+    def scheduled_actions
+      ScheduledActionCollection.new(:config => config)
+    end
+
+    # Returns a list of all notification types that are supported by 
+    # Auto Scaling.
+    # @return [Array<String>]
+    def notification_types
+      resp = client.describe_auto_scaling_notification_types
+      resp.auto_scaling_notification_types
+    end
+
+    # @return [Array<String>] Returns the list of valid adjustmet types.
+    def adjustment_types
+      client.describe_adjustment_types.adjustment_types.map(&:adjustment_type)
+    end
+
+    # @return [Array<String>] Returns the list of valid scaling process types.
+    def scaling_process_types
+      client.describe_scaling_process_types.processes.map(&:process_name)
+    end
+
+    # @return [Array<String>] Returns the list of valid metric collection types.
+    def metric_collection_types
+      client.describe_metric_collection_types.metrics.map(&:metric)
+    end
+
+    # @return [Array<String>] Returns the list of valid metric granularities.
+    def metric_collection_granularities
+      client.describe_metric_collection_types.granularities.map(&:granularity)
+    end
+
+  end
+end

data/lib/aws/auto_scaling/activity.rb

@@ -0,0 +1,102 @@
+# 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
+#
+#     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 AutoScaling
+
+    # @attr_reader [String] auto_scaling_group_name
+    #
+    # @attr_reader [String] cause
+    #
+    # @attr_reader [nil,String] description
+    #
+    # @attr_reader [String] details
+    #
+    # @attr_reader [Time] start_time
+    #
+    # @attr_reader [nil,Time] end_time
+    #
+    # @attr_reader [Integer] progress
+    #
+    # @attr_reader [nil,String] status_code
+    # 
+    # @attr_reader [nil,String] status_message
+    #
+    class Activity < Core::Resource
+
+      # @private
+      def initialize activity_id, options = {}
+        @activity_id = activity_id
+        super
+      end
+
+      # @return [String]
+      attr_reader :activity_id
+
+      alias_method :id, :activity_id
+
+      attribute :auto_scaling_group_name, :static => true
+
+      attribute :cause, :static => true
+
+      attribute :description, :static => true
+
+      attribute :details
+
+      attribute :start_time, :static => true
+
+      attribute :end_time
+
+      attribute :progress
+
+      attribute :status_code
+
+      attribute :status_message
+
+      populates_from(:describe_scaling_activities) do |resp|
+        resp.activities.find {|a| a.activity_id == activity_id }
+      end
+
+      populates_from(:terminate_instance_in_auto_scaling_group) do |resp|
+        resp.activity if resp.activity.activity_id == activity_id
+      end
+
+      # @return [Group]
+      def group
+        Group.new(auto_scaling_group_name, :config => config)
+      end
+
+      # @return [Boolean]
+      def exists?
+        client_opts = {}
+        client_opts[:activity_ids] = [activity_id]
+        resp = client.describe_scaling_activities(client_opts)
+        !resp.activities.empty?
+      end
+
+      protected
+
+      def get_resource attr_name = nil
+        client_opts = {}
+        client_opts[:activity_ids] = [activity_id]
+        client.describe_scaling_activities(client_opts)
+      end
+
+      def resource_identifiers
+        [[:activity_id, activity_id]]
+      end
+
+    end
+  end
+end

data/lib/aws/auto_scaling/activity_collection.rb

@@ -0,0 +1,82 @@
+# 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 AutoScaling
+
+    # Allows you to enumerate Auto Scaling activities
+    #
+    # Enumerating ALL activities:
+    #
+    #   auto_scaling = AWS::AutoScaling.new
+    #   auto_scaling.activities.each do |activity|
+    #     # ...
+    #   end
+    #
+    # Enumerating activities for a single Auto Scaling group:
+    #
+    #   group = auto_scaling.groups['group-name']
+    #   group.activities.each do |activity|
+    #     # ...
+    #   end
+    #
+    # If you know the id of an activity you can get a refernce to it:
+    #
+    #   activity = auto_scaling.activities['activity-id']
+    #   
+    class ActivityCollection
+
+      include Core::Collection::Limitable
+      
+      # @private
+      def initialize options = {}
+        @group = options[:group]
+        if @group
+          super(@group, options)
+        else
+          super
+        end
+      end
+
+      # @param [String] activity_id
+      # @return [Activity]
+      def [] activity_id
+        Activity.new(activity_id, :config => config)
+      end
+      
+      protected
+
+      def _each_item next_token, limit, options = {}, &block
+
+        options[:next_token] = next_token if next_token
+        options[:max_records] = limit if limit
+        options[:auto_scaling_group_name] = @group.name if @group
+
+        resp = client.describe_scaling_activities(options)
+        resp.activities.each do |details|
+          
+          activity = Activity.new_from(
+            :describe_scaling_activities, details, 
+            details.activity_id, :config => config)
+
+          yield(activity)
+          
+        end
+
+        resp.next_token if resp.respond_to?(:next_token)
+
+      end
+
+    end
+  end
+end

data/lib/aws/auto_scaling/client.rb

@@ -0,0 +1,50 @@
+# 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 AutoScaling
+
+    # @private
+    class Client < Core::Client
+
+      AWS.register_autoloads(self, 'aws/auto_scaling/client') do
+        autoload :XML, 'xml'
+      end
+
+      include Core::ConfiguredClientMethods
+
+      API_VERSION = '2011-01-01'
+
+      REQUEST_CLASS = AutoScaling::Request
+
+      # @private
+      CACHEABLE_REQUESTS = Set[
+        :describe_adjustment_types,
+        :describe_auto_scaling_groups,
+        :describe_auto_scaling_instances,
+        :describe_auto_scaling_notification_types,
+        :describe_launch_configurations,
+        :describe_metric_collection_types,
+        :describe_notification_configurations,
+        :describe_policies,
+        :describe_scaling_activities,
+        :describe_scaling_process_types,
+        :describe_scheduled_actions,
+        :describe_tags,
+      ]
+
+      configure_client
+
+    end
+  end
+end

data/lib/aws/auto_scaling/client/xml.rb

@@ -0,0 +1,32 @@
+# 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 AutoScaling
+    class Client < Core::Client
+      module XML
+
+        include Core::ConfiguredXmlGrammars
+
+        extend Core::IgnoreResultElement
+
+        BaseError = Core::XmlGrammar.customize do
+          element("Error") { ignore }
+        end
+
+        define_configured_grammars
+
+      end
+    end
+  end
+end

data/lib/aws/auto_scaling/config.rb

@@ -0,0 +1,18 @@
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'AutoScaling', 'auto_scaling', 'autoscaling.us-east-1.amazonaws.com'
+
+end