Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added basic documentation for the AWS::RDS service interface.

  • Loading branch information...
commit b09b85f1e2debf0a83ea03e1b1f50b7a9c8e5f85 1 parent 31c911c
@trevorrowe trevorrowe authored
Showing with 25 additions and 0 deletions.
  1. +25 −0 lib/aws/rds.rb
View
25 lib/aws/rds.rb
@@ -17,6 +17,29 @@
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')
+ #
class RDS
AWS.register_autoloads(self) do
@@ -31,11 +54,13 @@ class RDS
include Core::ServiceInterface
+ # @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
Please sign in to comment.
Something went wrong with that request. Please try again.