You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::RDS

Inherits:
Object
  • Object
show all
Includes:
Core::ServiceInterface
Defined in:
lib/aws/rds.rb,
lib/aws/rds/client.rb,
lib/aws/rds/errors.rb,
lib/aws/rds/db_snapshot.rb,
lib/aws/rds/db_instance.rb,
lib/aws/rds/db_instance_collection.rb,
lib/aws/rds/db_snapshot_collection.rb

Overview

This class is the starting point for working with Amazon Relational Database Service (RDS).

For more information about 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')

Defined Under Namespace

Modules: Errors Classes: Client, DBInstance, DBInstanceCollection, DBSnapshot, DBSnapshotCollection

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::ServiceInterface

included, #initialize, #inspect

Instance Attribute Details

#clientClient (readonly)

Returns the low-level RDS client object

Returns:

  • (Client)

    the low-level RDS client object



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/aws/rds.rb', line 44

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

Instance Method Details

#db_instancesDBInstanceCollection Also known as: instances



58
59
60
# File 'lib/aws/rds.rb', line 58

def db_instances
  DBInstanceCollection.new(:config => config)
end

#db_snapshotsDBSnapshotCollection Also known as: snapshots

Returns ]

Returns:



64
65
66
# File 'lib/aws/rds.rb', line 64

def db_snapshots
  DBSnapshotCollection.new(:config => config)
end