aws-sdk-v1 1.52.0

data/lib/aws/rds/db_instance_collection.rb

@@ -0,0 +1,75 @@
+# 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 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-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 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

data/lib/aws/rds/db_snapshot_collection.rb

@@ -0,0 +1,89 @@
+# 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 RDS
+    class DBSnapshotCollection
+
+      include Core::Collection::WithLimitAndNextToken
+
+      # @api private
+      def initialize options = {}
+        @filters = options[:filters] || {}
+        super
+      end
+
+      # @param [String] db_snapshot_id
+      # @return [DBSnapshot] Returns a {DBSnapshot} with the given ID.
+      def [] db_snapshot_id
+        DBSnapshot.new(db_snapshot_id, :config => config)
+      end
+
+      # Filters the DB snapshots to those beloning to a single db instance.
+      # You may pass the ID of a db instance or a {DBInstance} object.
+      #
+      # @param [String,DBInstance] db_instance A db instance identifier
+      #   string or a {DBInstance} object.
+      #
+      # @return [DBSnapshotCollection]
+      #
+      def db_instance db_instance
+        id = db_instance.is_a?(Core::Model) ? db_instance.id : db_instance
+        filter(:db_instance_identifier, id.to_s.downcase)
+      end
+
+      # Filters the DB snapshots to those of a given snapshot type.
+      # @param [String] snapshot_type
+      # @return [DBSnapshotCollection]
+      def with_type snapshot_type
+        filter(:snapshot_type, snapshot_type)
+      end
+      alias_method :type, :with_type
+
+      # @param [String,Symbol] name
+      # @param [Mixed] value
+      # @return [DBSnapshotCollection]
+      def filter name, value
+        options = {}
+        options[:filters] = @filters.merge(name.to_s.to_sym => value)
+        options[:config] = config
+        DBSnapshotCollection.new(options)
+      end
+
+      protected
+
+      def _each_item marker, max_records, options = {}, &block
+
+        options = @filters.merge(options)
+        options[:marker] = marker if marker
+        options[:max_records] = [[20,max_records].max,100].min if max_records
+
+        response = client.describe_db_snapshots(options)
+        response.data[:db_snapshots].each do |details|
+
+          db_snapshot = DBSnapshot.new_from(
+              :describe_db_snapshots,
+              details,
+              details[:db_snapshot_identifier],
+              :config => config)
+
+          yield(db_snapshot)
+
+        end
+
+        response.data[:marker]
+      end
+
+    end
+  end
+end

data/lib/aws/rds/errors.rb

@@ -0,0 +1,22 @@
+# 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 RDS
+    module Errors
+
+      extend Core::LazyErrorClasses
+
+    end
+  end
+end

data/lib/aws/record.rb

@@ -0,0 +1,139 @@
+# 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 'set'
+
+module AWS
+
+  # AWS::Record is an ORM built on top of AWS services.
+  module Record
+
+    autoload :AbstractBase, 'aws/record/abstract_base'
+    autoload :Attributes, 'aws/record/attributes'
+    autoload :Base, 'aws/record/model'
+    autoload :Conversion, 'aws/record/conversion'
+    autoload :DirtyTracking, 'aws/record/dirty_tracking'
+    autoload :Errors, 'aws/record/errors'
+    autoload :HashModel, 'aws/record/hash_model'
+    autoload :Model, 'aws/record/model'
+    autoload :Naming, 'aws/record/naming'
+    autoload :Scope, 'aws/record/scope'
+    autoload :Validations, 'aws/record/validations'
+
+    # errors
+    autoload :RecordNotFound, 'aws/record/exceptions'
+    autoload :InvalidRecordError, 'aws/record/exceptions'
+    autoload :EmptyRecordError, 'aws/record/exceptions'
+    autoload :UndefinedAttributeError, 'aws/record/exceptions'
+
+    # validators
+    autoload :AcceptanceValidator, 'aws/record/validators/acceptance'
+    autoload :BlockValidator, 'aws/record/validators/block'
+    autoload :ConfirmationValidator, 'aws/record/validators/confirmation'
+    autoload :CountValidator, 'aws/record/validators/count'
+    autoload :ExclusionValidator, 'aws/record/validators/exclusion'
+    autoload :FormatValidator, 'aws/record/validators/format'
+    autoload :InclusionValidator, 'aws/record/validators/inclusion'
+    autoload :LengthValidator, 'aws/record/validators/length'
+    autoload :MethodValidator, 'aws/record/validators/method'
+    autoload :NumericalityValidator, 'aws/record/validators/numericality'
+    autoload :PresenceValidator, 'aws/record/validators/presence'
+    autoload :Validator, 'aws/record/validator'
+
+    # Sets a prefix to be applied to all SimpleDB domains associated with
+    # AWS::Record::Base classes.
+    #
+    #     AWS::Record.domain_prefix = 'production_'
+    #
+    #     class Product < AWS::Record::Base
+    #       set_shard_name 'products'
+    #     end
+    #
+    #     p = Product.new
+    #     p.shard #=> 'products'
+    #     p.save # the product is persisted to the 'production-products' domain
+    #
+    # @param [String] prefix A prefix to append to all domains.  This is useful
+    #   for grouping domains used by one application with a single prefix.
+    #
+    def self.domain_prefix= prefix
+      @domain_prefix = prefix
+    end
+
+    # @return [String,nil] The string that is prepended to all domain names.
+    def self.domain_prefix
+      @domain_prefix
+    end
+
+    # Sets a prefix to be applied to all DynamoDB tables associated
+    # with {AWS::Record::HashModel} and {AWS::Record::ListModel}
+    # classes.
+    #
+    #     AWS::Record.table_prefix = 'production_'
+    #
+    #     class Product < AWS::Record::HashModel
+    #       set_shard_name 'products'
+    #     end
+    #
+    #     p = Product.new
+    #     p.shard #=> 'products'
+    #     p.save # the product is persisted to the 'production-products' table
+    #
+    # @param [String] prefix A prefix to append to all tables.  This is
+    #   useful for grouping tables used by one application with a
+    #   single prefix.
+    #
+    def self.table_prefix= prefix
+      @table_prefix = prefix
+    end
+
+    # @return [String,nil] The string that is prepended to all table names.
+    def self.table_prefix
+      @table_prefix
+    end
+
+    # A utility method for casting values into an array.
+    #
+    # * nil is returned as an empty array, []
+    # * Arrays are returned unmodified
+    # * Everything else is returned as the sole element of an array
+    #
+    # @param [Object] value
+    # @return [Array] The value cast into an array
+    # @api private
+    def self.as_array value
+      case value
+      when nil   then []
+      when Set   then value.to_a
+      when Array then value
+      else [value]
+      end
+    end
+
+    # A utility method for casting values into
+    #
+    # * Sets are returned unmodified
+    # * everything else is passed through #{as_array} and then into a new Set
+    #
+    # @param [Object] value
+    # @return [Set] The value cast into a Set.
+    # @api private
+    def self.as_set value
+      case value
+      when Set then value
+      else Set.new(as_array(value))
+      end
+    end
+
+  end
+end