class AWS::RDS::DBInstance
@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
Attributes
@return [String]
@return [String]
@return [String]
Public Class Methods
@param [String] db_instance_id
@param [Hash] options
AWS::Core::Resource::new
# File lib/aws/rds/db_instance.rb, line 66 def initialize db_instance_id, options = {} @db_instance_identifier = db_instance_id super end
Public Instance Methods
@return [DBSnapshot]
# File lib/aws/rds/db_instance.rb, line 153 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
Terminates (deletes) this database instance. @return [nil]
# File lib/aws/rds/db_instance.rb, line 178 def delete options = {} client.delete_db_instance(options.merge(:db_instance_identifier => id)) nil end
@return [Boolean] Returns true
if the db instance exists.
# File lib/aws/rds/db_instance.rb, line 184 def exists? begin get_resource true rescue AWS::RDS::Errors::DBInstanceNotFound false 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)
# File lib/aws/rds/db_instance.rb, line 143 def modify options = {} client.modify_db_instance(options.merge(:db_instance_identifier => id)) 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]
# File lib/aws/rds/db_instance.rb, line 171 def reboot options = {} client.reboot_db_instance(options.merge(:db_instance_identifier => id)) nil end
@return [DBSnapshotCollection]
# File lib/aws/rds/db_instance.rb, line 148 def snapshots DBSnapshotCollection.new(:config => config).db_instance(self) end
Protected Instance Methods
# File lib/aws/rds/db_instance.rb, line 199 def get_resource attr = nil client.describe_db_instances(:db_instance_identifier => id) end
# File lib/aws/rds/db_instance.rb, line 195 def resource_identifiers [[:db_instance_identifier, id]] end