aws-sdk 1.6.9 → 1.7.0

data/lib/aws/rds/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 'RDS', 'rds', 'rds.us-east-1.amazonaws.com'
+
+end

data/lib/aws/rds/db_instance.rb

@@ -0,0 +1,201 @@
+# 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 RDS
+
+    # @attr_reader [String] db_instance_class
+    #
+    # @attr_reader [String] engine
+    #
+    # @attr_reader [String] db_instance_status
+    #
+    # @attr_reader [String] master_username
+    #
+    # @attr_reader [String] db_name
+    #
+    # @attr_reader [String] endpoint_address
+    #
+    # @attr_reader [Integer] endpoint_port
+    #
+    # @attr_reader [Integer] allocated_storage
+    #
+    # @attr_reader [Time] creation_date_time
+    #
+    # @attr_reader [String] preferred_backup_window
+    #
+    # @attr_reader [Integer] backup_retention_period
+    #
+    # @attr_reader [String] availability_zone_name
+    #
+    # @attr_reader [String] preferred_maintenance_window
+    #
+    # @attr_reader [Time] latest_restorable_time
+    #
+    # @attr_reader [Boolean] multi_az
+    #
+    # @attr_reader [String] engine_version
+    #
+    # @attr_reader [Boolean] auto_minor_version_upgrade
+    #
+    # @attr_reader [String] read_replica_source_db_instance_identifier
+    #
+    # @attr_reader [Array<String>] read_replica_db_instance_identifiers
+    #
+    # @attr_reader [String] license_model
+    #
+    # @attr_reader [String] character_set_name
+    #
+    class DBInstance < Core::Resource
+
+      # @param [String] db_instance_id
+      # @param [Hash] options
+      def initialize db_instance_id, options = {}
+        @db_instance_identifier = db_instance_id
+        super
+      end
+
+      # @return [String]
+      attr_reader :db_instance_identifier
+
+      alias_method :id, :db_instance_identifier
+
+      alias_method :db_instance_id, :db_instance_identifier
+
+      attribute :allocated_storage, :static => true, :alias => :size
+
+      attribute :auto_minor_version_upgrade
+
+      attribute :availability_zone_name,
+        :from => :availability_zone,
+        :static => true
+
+      attribute :backup_retention_period, :static => true
+
+      attribute :character_set_name, :static => true
+
+      attribute :creation_date_time,
+        :from => :instance_create_time,
+        :static => true,
+        :alias => :created_at
+
+      attribute :db_instance_class, :static => true
+
+      attribute :db_instance_status, :alias => :status
+
+      attribute :db_name, :static => true, :alias => :name
+
+      attribute :endpoint_address,
+        :from => [:endpoint, :address],
+        :static => true
+
+      attribute :endpoint_port,
+        :from => [:endpoint, :port],
+        :static => true
+
+      attribute :engine, :static => true
+
+      attribute :engine_version, :static => true
+
+      attribute :latest_restorable_time
+
+      attribute :license_model
+
+      attribute :master_username, :static => true
+
+      attribute :multi_az, :static => true, :alias => :multi_az?
+
+      attribute :preferred_backup_window, :static => true
+
+      attribute :preferred_maintenance_window, :static => true
+
+      attribute :read_replica_db_instance_identifiers, :static => true
+
+      attribute :read_replica_source_db_instance_identifier, :static => true
+
+      populates_from(:create_db_instance) do |resp|
+        resp.data if resp.data[:db_instance_identifier] == id
+      end
+
+      populates_from(:describe_db_instances) do |resp|
+        resp.data[:db_instances].find{|j| j[:db_instance_identifier] == id }
+      end
+
+      # Modifies the database instance.
+      # @note You do not need to set +:db_instance_identifier+.
+      # @see Client#modify_db_instance
+      # @param (see Client#modify_db_instance)
+      def modify options = {}
+        client.modify_db_instance(options.merge(:db_instance_identifier => id))
+      end
+
+      # @return [DBSnapshotCollection]
+      def snapshots
+        DBSnapshotCollection.new(:config => config).db_instance(self)
+      end
+
+      # @return [DBSnapshot]
+      def create_snapshot db_snapshot_id
+
+        options = {}
+        options[:db_snapshot_identifier] = db_snapshot_id
+        options[:db_instance_identifier] = db_instance_identifier
+        resp = client.create_db_snapshot(options)
+
+        DBSnapshot.new_from(:create_db_snapshot, resp,
+          resp[:db_snapshot_identifier], :config => config)
+
+      end
+
+      # Reboots this databse instance.
+      # @param [Hash] options
+      # @option options [Boolean] :force_failover When +true+, the reboot will be
+      #   conducted through a MultiAZ failover. Constraint: You cannot
+      #   specify +true+ if the instance is not configured for MultiAZ.
+      # @return [nil]
+      def reboot options = {}
+        client.reboot_db_instance(options.merge(:db_instance_identifier => id))
+        nil
+      end
+
+      # Terminates (deletes) this database instance.
+      # @return [nil]
+      def delete options = {}
+        client.delete_db_instance(options.merge(:db_instance_identifier => id))
+        nil
+      end
+
+      # @return [Boolean] Returns +true+ if the db instance exists.
+      def exists?
+        begin
+          get_resource
+          true
+        rescue AWS::RDS::Errors::DBInstanceNotFound
+          false
+        end
+      end
+
+      protected
+
+      def resource_identifiers
+        [[:db_instance_identifier, id]]
+      end
+
+      def get_resource attr = nil
+        client.describe_db_instances(:db_instance_identifier => id)
+      end
+
+    end
+  end
+end

data/lib/aws/rds/db_instance_collection.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 'date'
+require 'time'
+
+module AWS
+  class RDS
+    class DBInstanceCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      # @param [String] db_instance_id The DB instance identifier.
+      #   This should be a lowercase string.
+      # @return [DBInstance] Returns a {DBInstance} with the given ID.
+      def [] db_instance_id
+        DBInstance.new(db_instance_id.to_s.downcase, :config => config)
+      end
+
+      # Creates a database instance.  See {Client#create_db_instance}
+      # for documentation on the accepted (and required) options.
+      # @param [String] db_instance_id The DB instance identifier.
+      #   This should be a lowercase string.
+      # @param [Hash] options
+      # @option (see Client#create_db_instance)
+      # @return [DBInstance]
+      def create db_instance_id, options = {}
+
+        options[:db_instance_identifier] = db_instance_id
+
+        resp = client.create_db_instance(options)
+
+        DBInstance.new_from(:create_db_instance, resp,
+          resp[:db_instance_identifier], :config => config)
+
+      end
+
+      protected
+
+      def _each_item marker, max_records, options = {}, &block
+
+        options[:marker] = marker if marker
+        options[:max_records] = [[20,max_records].max,100].min if max_records
+
+        response = client.describe_db_instances(options)
+        response.data[:db_instances].each do |details|
+
+          db_instance = DBInstance.new_from(
+              :describe_db_instances,
+              details,
+              details[:db_instance_identifier],
+              :config => config)
+
+          yield(db_instance)
+
+        end
+
+        response.data[:marker]
+
+      end
+
+    end
+  end
+end

data/lib/aws/rds/db_snapshot.rb

@@ -0,0 +1,163 @@
+# 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 RDS
+
+    # @attr_reader [Integer] allocated_storage
+    #
+    # @attr_reader [String] availability_zone_name
+    #
+    # @attr_reader [String] db_instance_id
+    #
+    # @attr_reader [String] engine
+    #
+    # @attr_reader [String] engine_version
+    #
+    # @attr_reader [String] license_model
+    #
+    # @attr_reader [String] master_username
+    #
+    # @attr_reader [String] port
+    #
+    # @attr_reader [Integer] vpc_id
+    #
+    # @attr_reader [String] snapshot_type
+    #
+    # @attr_reader [String] status
+    #
+    # @attr_reader [Time] created_at
+    #
+    # @attr_reader [Time] instance_create_time
+    #
+    class DBSnapshot < Core::Resource
+
+      # @param [String] db_snapshot_id
+      # @param [Hash] options
+      def initialize db_snapshot_id, options = {}
+        @db_snapshot_identifier = db_snapshot_id
+        super
+      end
+
+      # @return [String]
+      attr_reader :db_snapshot_identifier
+
+      alias_method :id, :db_snapshot_identifier
+
+      alias_method :db_snapshot_id, :db_snapshot_identifier
+
+      attribute :allocated_storage, :static => true, :alias => :size
+
+      attribute :availability_zone_name,
+        :from => :availability_zone,
+        :static => true
+
+      attribute :db_instance_id,
+        :from => :db_instance_identifier,
+        :static => true,
+        :alias => :db_instance_identifier
+
+      attribute :engine, :static => true
+
+      attribute :engine_version, :static => true
+
+      attribute :license_model, :static => true
+
+      attribute :master_username, :static => true
+
+      attribute :port, :static => true
+
+      attribute :vpc_id, :static => true
+
+      attribute :snapshot_type, :static => true, :alias => :type
+
+      attribute :status, :alias => :db_snapshot_status
+
+      attribute :created_at,
+        :from => :snapshot_create_time,
+        :static => true, :alias => :created_at
+
+      attribute :instance_create_time, :static => true
+
+      populates_from(:create_db_snapshot, :copy_db_snapshot) do |resp|
+        resp.data if resp[:db_snapshot_identifier] == id
+      end
+
+      populates_from(:describe_db_snapshots) do |resp|
+        resp.data[:db_snapshots].find{|s| s[:db_snapshot_identifier] == id }
+      end
+
+      # @return [DBInstance]
+      def db_instance
+        DBInstance.new(db_instance_id, :config => config)
+      end
+
+      # Copies this database snapshot.
+      # @param [String] new_snapshot_id
+      # @return [DBSnapshot]
+      def copy new_snapshot_id
+
+        options = {}
+        options[:source_db_snapshot_identifier] = id
+        options[:target_db_snapshot_identifier] = new_snapshot_id
+        resp = client.copy_db_snapshot(options)
+
+        DBSnapshot.new_from(:copy_db_snapshot, resp,
+          resp[:db_snapshot_identifier], :config => config)
+
+      end
+
+      # Deletes this database snapshot.
+      # @return [nil]
+      def delete
+        client.delete_db_snapshot(:db_snapshot_identifier => db_snapshot_identifier)
+        nil
+      end
+
+      # Restores the database instance from this snapshot.  You may optionally
+      # specify the db instance id if you wish to restore to a different db.
+      #
+      # @param (see Client#restore_db_instance_from_db_snapshot)
+      # @option (see Client#restore_db_instance_from_db_snapshot)
+      def restore_instance options = {}
+        options[:db_snapshot_identifier] = db_snapshot_identifier
+        options[:db_instance_identifier] ||= db_instance_id
+        client.restore_db_instance_from_db_snapshot(options)
+        nil
+      end
+
+      # @return [Boolean] Returns +true+ if the db snapshot exists.
+      def exists?
+        begin
+          get_resource
+          true
+        rescue AWS::RDS::Errors::DBSnapshotNotFound
+          false
+        end
+      end
+
+      protected
+
+      def resource_identifiers
+        [[:db_snapshot_identifier, id]]
+      end
+
+      def get_resource attr = nil
+        options = {}
+        options[:db_snapshot_identifier] = db_snapshot_identifier
+        client.describe_db_snapshots(options)
+      end
+
+    end
+  end
+end