aws-sdk-v1 1.52.0

data/lib/aws/ops_works/errors.rb

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

data/lib/aws/rails.rb

@@ -0,0 +1,195 @@
+# 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 'yaml'
+
+module AWS
+
+  if Object.const_defined?(:Rails) and Rails.const_defined?(:Railtie)
+
+    # @api private
+    class Railtie < Rails::Railtie
+
+      # configure our plugin on boot. other extension points such
+      # as configuration, rake tasks, etc, are also available
+      initializer "aws-sdk.initialize" do |app|
+        AWS::Rails.setup
+      end
+    end
+
+  end
+
+  # A handful of useful Rails integration methods.
+  #
+  # If you require this gem inside a Rails application (via config.gem
+  # for rails 2 and bundler for rails 3) then {setup} is called
+  # automatically.
+  module Rails
+
+    # Adds extra functionality to Rails.
+    #
+    # Normally this method is invoked automatically when you require this
+    # gem in a Rails Application:
+    #
+    # Rails 3+ (RAILS_ROOT/Gemfile)
+    #
+    #     gem 'aws-sdk'
+    #
+    # Rails 2.1 - 2.3 (RAILS_ROOT/config/environment.rb)
+    #
+    #     config.gem 'aws-sdk'
+    #
+    # @return [nil]
+    def self.setup
+      load_yaml_config
+      add_action_mailer_delivery_method
+      log_to_rails_logger
+      nil
+    end
+
+    # Loads AWS configuration options from `RAILS_ROOT/config/aws.yml`.
+    #
+    # This configuration file is optional.  You can omit this file and instead
+    # use ruby to configure AWS inside a configuration initialization script
+    # (e.g. RAILS_ROOT/config/intializers/aws.rb).
+    #
+    # If you have a yaml configuration file it should be formatted like the
+    # standard `database.yml` file in a Rails application.  This means there
+    # should be one section for Rails environment:
+    #
+    #     development:
+    #       access_key_id: YOUR_ACCESS_KEY_ID
+    #       secret_access_key: YOUR_SECRET_ACCESS_KEY
+    #       simple_db_consistent_reads: false
+    #
+    #     production:
+    #       access_key_id: YOUR_ACCESS_KEY_ID
+    #       secret_access_key: YOUR_SECRET_ACCESS_KEY
+    #       simple_db_consistent_reads: true
+    #
+    # You should also consider DRYing up your configuration file using
+    # YAML references:
+    #
+    #     development:
+    #       access_key_id: YOUR_ACCESS_KEY_ID
+    #       secret_access_key: YOUR_SECRET_ACCESS_KEY
+    #       simple_db_consistent_reads: false
+    #
+    #     production:
+    #       <<: *development
+    #       simple_db_consistent_reads: true
+    #
+    # The yaml file will also be ERB parsed so you can use ruby inside of it:
+    #
+    #     development:
+    #       access_key_id: YOUR_ACCESS_KEY_ID
+    #       secret_access_key: <%= read_secret_from_a_secure_location %>
+    #       simple_db_consistent_reads: false
+    #
+    #     production:
+    #       <<: *development
+    #       simple_db_consistent_reads: true
+    #
+    def self.load_yaml_config
+
+      path = Pathname.new("#{rails_root}/config/aws.yml")
+
+      if File.exists?(path)
+        cfg = YAML::load(ERB.new(File.read(path)).result)
+        unless cfg[rails_env]
+          raise "config/aws.yml is missing a section for `#{rails_env}`"
+        end
+        AWS.config(cfg[rails_env])
+      end
+
+    end
+
+    # Adds a delivery method to ActionMailer that uses
+    # {AWS::SimpleEmailService}.
+    #
+    # Once you have an SES delivery method you can configure Rails to
+    # use this for ActionMailer in your environment configuration
+    # (e.g.  RAILS_ROOT/config/environments/production.rb)
+    #
+    #     config.action_mailer.delivery_method = :amazon_ses
+    #
+    # ### Defaults
+    #
+    # Normally you don't need to call this method.  By default a delivery method
+    # named `:amazon_ses` is added to ActionMailer::Base.  This delivery method
+    # uses your default configuration (#{AWS.config}).
+    #
+    # ### Custom SES Options
+    #
+    # If you need to supply configuration values for SES that are different than
+    # those in {AWS.config} then you can pass those options:
+    #
+    #     AWS::Rails.add_action_mailer_delivery_method(:ses, custom_options)
+    #
+    # @param [Symbol] name (:amazon_ses) The name of the delivery
+    #   method.  The name used here should be the same as you set in
+    #   your environment config.  If you name the delivery method
+    #   `:amazon_ses` then you could do something like this in your
+    #   config/environments/ENV.rb file:
+    #
+    #       config.action_mailer.delivery_method = :amazon_ses
+    #
+    # @param [Hash] options A hash of options that are passes to
+    #   {AWS::SimpleEmailService#new} before delivering email.
+    #
+    # @return [nil]
+    #
+    def self.add_action_mailer_delivery_method name = :amazon_ses, options = {}
+
+      if ::Rails.version.to_s >= '3.0'
+        ActiveSupport.on_load(:action_mailer) do
+          self.add_delivery_method(name, AWS::SimpleEmailService, options)
+        end
+      elsif defined?(::ActionMailer)
+        amb = ::ActionMailer::Base
+        amb.send(:define_method, "perform_delivery_#{name}") do |mail|
+          AWS::SimpleEmailService.new(options).send_raw_email(mail)
+        end
+      end
+
+      nil
+
+    end
+
+    # Configures AWS to log to the Rails default logger.
+    # @return [nil]
+    def self.log_to_rails_logger
+      AWS.config(:logger => rails_logger)
+      nil
+    end
+
+    # @api private
+    protected
+    def self.rails_env
+      ::Rails.respond_to?(:env) ? ::Rails.env : RAILS_ENV
+    end
+
+    # @api private
+    protected
+    def self.rails_root
+      ::Rails.respond_to?(:root) ? ::Rails.root.to_s : RAILS_ROOT
+    end
+
+    # @api private
+    protected
+    def self.rails_logger
+      ::Rails.respond_to?(:logger) ? ::Rails.logger : ::RAILS_DEFAULT_LOGGER
+    end
+
+  end
+end

data/lib/aws/rds.rb

@@ -0,0 +1,70 @@
+# 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 'aws/core'
+require 'aws/rds/config'
+
+module AWS
+
+  # This class is the starting point for working with Amazon Relational
+  # Database Service (RDS).
+  #
+  # For more information about RDS:
+  #
+  # * [Amazon RDS](http://aws.amazon.com/rds/)
+  # * [Amazon RDS Documentation](http://aws.amazon.com/documentation/rds/)
+  #
+  # # 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::RDS interface:
+  #
+  #     rds = AWS::RDS.new(
+  #       :access_key_id => 'YOUR_ACCESS_KEY_ID',
+  #       :secret_access_key => 'YOUR_SECRET_ACCESS_KEY')
+  #
+  # @!attribute [r] client
+  #   @return [Client] the low-level RDS client object
+  class RDS
+
+    autoload :Client, 'aws/rds/client'
+    autoload :Errors, 'aws/rds/errors'
+    autoload :DBInstance, 'aws/rds/db_instance'
+    autoload :DBInstanceCollection, 'aws/rds/db_instance_collection'
+    autoload :DBSnapshot, 'aws/rds/db_snapshot'
+    autoload :DBSnapshotCollection, 'aws/rds/db_snapshot_collection'
+
+    include Core::ServiceInterface
+
+    endpoint_prefix 'rds'
+
+    # @return [DBInstanceCollection]
+    def db_instances
+      DBInstanceCollection.new(:config => config)
+    end
+    alias_method :instances, :db_instances
+
+    # @return [DBSnapshotCollection]]
+    def db_snapshots
+      DBSnapshotCollection.new(:config => config)
+    end
+    alias_method :snapshots, :db_snapshots
+
+  end
+end

data/lib/aws/rds/client.rb

@@ -0,0 +1,42 @@
+# 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
+
+    # Client class for Amazon Relational Database Service (RDS).
+    class Client < Core::QueryClient
+
+      API_VERSION = '2013-09-09'
+
+      signature_version :Version4, 'rds'
+
+      # @api private
+      CACHEABLE_REQUESTS = Set[]
+
+    end
+
+    class Client::V20130515 < Client
+
+      define_client_methods('2013-05-15')
+
+    end
+
+    class Client::V20130909 < Client
+
+      define_client_methods('2013-09-09')
+
+    end
+
+  end
+end

data/lib/aws/rds/config.rb

@@ -0,0 +1,18 @@
+# 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.
+
+AWS::Core::Configuration.module_eval do
+
+  add_service 'RDS', 'rds', 'rds'
+
+end

data/lib/aws/rds/db_instance.rb

@@ -0,0 +1,215 @@
+# 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 [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 [Integer] iops
+    #
+    # @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
+    #
+    # @attr_reader [String,nil] vpc_id
+    #
+    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 :vpc_id, :from => [:db_subnet_group, :vpc_id], :static => true
+
+      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 :iops, :static => true
+
+      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
+
+      # @return [EC2::VPC,nil]
+      def vpc
+        if vpc_id
+          EC2::VPC.new(vpc_id, :config => config)
+        end
+      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?
+        fail AWS::RDS::Errors::DBInstanceNotFound if id.to_s.empty?
+        get_resource
+        true
+      rescue AWS::RDS::Errors::DBInstanceNotFound
+        false
+      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