Class: Aws::RDS::DBSnapshot
- Inherits:
-
Object
- Object
- Aws::RDS::DBSnapshot
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#allocated_storage ⇒ Integer
Specifies the allocated storage size in gibibytes (GiB).
-
#availability_zone ⇒ String
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
-
#db_snapshot_arn ⇒ String
The Amazon Resource Name (ARN) for the DB snapshot.
-
#dbi_resource_id ⇒ String
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
-
#encrypted ⇒ Boolean
Specifies whether the DB snapshot is encrypted.
-
#engine ⇒ String
Specifies the name of the database engine.
-
#engine_version ⇒ String
Specifies the version of the database engine.
-
#iam_database_authentication_enabled ⇒ Boolean
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
-
#instance_create_time ⇒ Time
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
-
#instance_id ⇒ String
(also: #db_instance_identifier)
-
#iops ⇒ Integer
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
-
#kms_key_id ⇒ String
If
Encrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. -
#license_model ⇒ String
License model information for the restored DB instance.
-
#master_username ⇒ String
Provides the master username for the DB snapshot.
-
#option_group_name ⇒ String
Provides the option group name for the DB snapshot.
-
#original_snapshot_create_time ⇒ Time
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC).
-
#percent_progress ⇒ Integer
The percentage of the estimated data that has been transferred.
-
#port ⇒ Integer
Specifies the port that the database engine was listening on at the time of the snapshot.
-
#processor_features ⇒ Array<Types::ProcessorFeature>
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
-
#snapshot_create_time ⇒ Time
Specifies when the snapshot was taken in Coordinated Universal Time (UTC).
-
#snapshot_database_time ⇒ Time
The timestamp of the most recent transaction applied to the database that you're backing up.
-
#snapshot_id ⇒ String
(also: #db_snapshot_identifier)
-
#snapshot_target ⇒ String
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
-
#snapshot_type ⇒ String
Provides the type of the DB snapshot.
-
#source_db_snapshot_identifier ⇒ String
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from.
-
#source_region ⇒ String
The Amazon Web Services Region that the DB snapshot was created in or copied from.
-
#status ⇒ String
Specifies the status of this DB snapshot.
-
#storage_throughput ⇒ Integer
Specifies the storage throughput for the DB snapshot.
-
#storage_type ⇒ String
Specifies the storage type associated with DB snapshot.
-
#tag_list ⇒ Array<Types::Tag>
A list of tags.
-
#tde_credential_arn ⇒ String
The ARN from the key store with which to associate the instance for TDE encryption.
-
#timezone ⇒ String
The time zone of the DB snapshot.
-
#vpc_id ⇒ String
Provides the VPC ID associated with the DB snapshot.
Actions collapse
-
#copy(options = {}) ⇒ DBSnapshot
-
#create(options = {}) ⇒ DBSnapshot
-
#delete(options = {}) ⇒ DBSnapshot
-
#restore(options = {}) ⇒ DBInstance
-
#subscribe_to(options = {}) ⇒ EventSubscription
-
#unsubscribe_from(options = {}) ⇒ EventSubscription
Associations collapse
-
#attributes(options = {}) ⇒ DBSnapshotAttribute::Collection
-
#events(options = {}) ⇒ Event::Collection
-
#instance ⇒ DBInstance
-
#option_group ⇒ OptionGroup?
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::DBSnapshot
Returns the data for this DBSnapshot.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ DBSnapshot
constructor
A new instance of DBSnapshot.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBSnapshot.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(instance_id, snapshot_id, options = {}) ⇒ DBSnapshot #initialize(options = {}) ⇒ DBSnapshot
Returns a new instance of DBSnapshot.
24 25 26 27 28 29 30 31 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 24 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @instance_id = extract_instance_id(args, ) @snapshot_id = extract_snapshot_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#allocated_storage ⇒ Integer
Specifies the allocated storage size in gibibytes (GiB).
62 63 64 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 62 def allocated_storage data[:allocated_storage] end |
#attributes(options = {}) ⇒ DBSnapshotAttribute::Collection
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1126 def attributes( = {}) batches = Enumerator.new do |y| batch = [] = .merge(db_snapshot_identifier: @snapshot_id) resp = @client.describe_db_snapshot_attributes() resp.data.db_snapshot_attributes_result.db_snapshot_attributes.each do |d| batch << DBSnapshotAttribute.new( snapshot_id: @snapshot_id, name: d.attribute_name, data: d, client: @client ) end y.yield(batch) end DBSnapshotAttribute::Collection.new(batches) end |
#availability_zone ⇒ String
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
82 83 84 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 82 def availability_zone data[:availability_zone] end |
#client ⇒ Client
271 272 273 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 271 def client @client end |
#copy(options = {}) ⇒ DBSnapshot
597 598 599 600 601 602 603 604 605 606 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 597 def copy( = {}) = .merge(source_db_snapshot_identifier: @snapshot_id) resp = @client.copy_db_snapshot() DBSnapshot.new( instance_id: resp.data.db_snapshot.db_instance_identifier, snapshot_id: resp.data.db_snapshot.db_snapshot_identifier, data: resp.data.db_snapshot, client: @client ) end |
#create(options = {}) ⇒ DBSnapshot
421 422 423 424 425 426 427 428 429 430 431 432 433 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 421 def create( = {}) = .merge( db_instance_identifier: @instance_id, db_snapshot_identifier: @snapshot_id ) resp = @client.create_db_snapshot() DBSnapshot.new( instance_id: resp.data.db_snapshot.db_instance_identifier, snapshot_id: resp.data.db_snapshot.db_snapshot_identifier, data: resp.data.db_snapshot, client: @client ) end |
#data ⇒ Types::DBSnapshot
Returns the data for this Aws::RDS::DBSnapshot. Calls
Client#describe_db_snapshots if #data_loaded? is false
.
291 292 293 294 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 291 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
299 300 301 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 299 def data_loaded? !!@data end |
#db_snapshot_arn ⇒ String
The Amazon Resource Name (ARN) for the DB snapshot.
188 189 190 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 188 def db_snapshot_arn data[:db_snapshot_arn] end |
#dbi_resource_id ⇒ String
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
218 219 220 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 218 def dbi_resource_id data[:dbi_resource_id] end |
#delete(options = {}) ⇒ DBSnapshot
613 614 615 616 617 618 619 620 621 622 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 613 def delete( = {}) = .merge(db_snapshot_identifier: @snapshot_id) resp = @client.delete_db_snapshot() DBSnapshot.new( instance_id: resp.data.db_snapshot.db_instance_identifier, snapshot_id: resp.data.db_snapshot.db_snapshot_identifier, data: resp.data.db_snapshot, client: @client ) end |
#encrypted ⇒ Boolean
Specifies whether the DB snapshot is encrypted.
172 173 174 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 172 def encrypted data[:encrypted] end |
#engine ⇒ String
Specifies the name of the database engine.
56 57 58 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 56 def engine data[:engine] end |
#engine_version ⇒ String
Specifies the version of the database engine.
107 108 109 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 107 def engine_version data[:engine_version] end |
#events(options = {}) ⇒ Event::Collection
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1189 def events( = {}) batches = Enumerator.new do |y| = .merge( source_type: "db-snapshot", source_identifier: @snapshot_id ) resp = @client.describe_events() resp.each_page do |page| batch = [] page.data.events.each do |e| batch << Event.new( source_id: e.source_identifier, date: e.date, data: e, client: @client ) end y.yield(batch) end end Event::Collection.new(batches) end |
#iam_database_authentication_enabled ⇒ Boolean
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
204 205 206 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 204 def iam_database_authentication_enabled data[:iam_database_authentication_enabled] end |
#instance ⇒ DBInstance
1213 1214 1215 1216 1217 1218 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1213 def instance DBInstance.new( id: @instance_id, client: @client ) end |
#instance_create_time ⇒ Time
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
95 96 97 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 95 def instance_create_time data[:instance_create_time] end |
#instance_id ⇒ String Also known as: db_instance_identifier
36 37 38 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 36 def instance_id @instance_id end |
#iops ⇒ Integer
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
126 127 128 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 126 def iops data[:iops] end |
#kms_key_id ⇒ String
If Encrypted
is true, the Amazon Web Services KMS key identifier for
the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
182 183 184 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 182 def kms_key_id data[:kms_key_id] end |
#license_model ⇒ String
License model information for the restored DB instance.
113 114 115 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 113 def license_model data[:license_model] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::DBSnapshot.
Returns self
making it possible to chain methods.
db_snapshot.reload.data
281 282 283 284 285 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 281 def load resp = @client.describe_db_snapshots(db_snapshot_identifier: @snapshot_id) @data = resp.db_snapshots[0] self end |
#master_username ⇒ String
Provides the master username for the DB snapshot.
101 102 103 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 101 def master_username data[:master_username] end |
#option_group ⇒ OptionGroup?
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1221 def option_group if data[:db_snapshot][:option_group_name] OptionGroup.new( name: data[:db_snapshot][:option_group_name], client: @client ) else nil end end |
#option_group_name ⇒ String
Provides the option group name for the DB snapshot.
132 133 134 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 132 def option_group_name data[:option_group_name] end |
#original_snapshot_create_time ⇒ Time
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
236 237 238 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 236 def original_snapshot_create_time data[:original_snapshot_create_time] end |
#percent_progress ⇒ Integer
The percentage of the estimated data that has been transferred.
138 139 140 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 138 def percent_progress data[:percent_progress] end |
#port ⇒ Integer
Specifies the port that the database engine was listening on at the time of the snapshot.
75 76 77 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 75 def port data[:port] end |
#processor_features ⇒ Array<Types::ProcessorFeature>
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
211 212 213 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 211 def processor_features data[:processor_features] end |
#restore(options = {}) ⇒ DBInstance
1069 1070 1071 1072 1073 1074 1075 1076 1077 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1069 def restore( = {}) = .merge(db_snapshot_identifier: @snapshot_id) resp = @client.restore_db_instance_from_db_snapshot() DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) end |
#snapshot_create_time ⇒ Time
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
50 51 52 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 50 def snapshot_create_time data[:snapshot_create_time] end |
#snapshot_database_time ⇒ Time
The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
251 252 253 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 251 def snapshot_database_time data[:snapshot_database_time] end |
#snapshot_id ⇒ String Also known as: db_snapshot_identifier
42 43 44 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 42 def snapshot_id @snapshot_id end |
#snapshot_target ⇒ String
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
258 259 260 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 258 def snapshot_target data[:snapshot_target] end |
#snapshot_type ⇒ String
Provides the type of the DB snapshot.
119 120 121 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 119 def snapshot_type data[:snapshot_type] end |
#source_db_snapshot_identifier ⇒ String
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
153 154 155 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 153 def source_db_snapshot_identifier data[:source_db_snapshot_identifier] end |
#source_region ⇒ String
The Amazon Web Services Region that the DB snapshot was created in or copied from.
145 146 147 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 145 def source_region data[:source_region] end |
#status ⇒ String
Specifies the status of this DB snapshot.
68 69 70 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 68 def status data[:status] end |
#storage_throughput ⇒ Integer
Specifies the storage throughput for the DB snapshot.
264 265 266 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 264 def storage_throughput data[:storage_throughput] end |
#storage_type ⇒ String
Specifies the storage type associated with DB snapshot.
159 160 161 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 159 def storage_type data[:storage_type] end |
#subscribe_to(options = {}) ⇒ EventSubscription
1089 1090 1091 1092 1093 1094 1095 1096 1097 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1089 def subscribe_to( = {}) = .merge(source_identifier: @snapshot_id) resp = @client.add_source_identifier_to_subscription() EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, data: resp.data.event_subscription, client: @client ) end |
#tag_list ⇒ Array<Types::Tag>
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
229 230 231 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 229 def tag_list data[:tag_list] end |
#tde_credential_arn ⇒ String
The ARN from the key store with which to associate the instance for TDE encryption.
166 167 168 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 166 def tde_credential_arn data[:tde_credential_arn] end |
#timezone ⇒ String
The time zone of the DB snapshot. In most cases, the Timezone
element is empty. Timezone
content appears only for snapshots taken
from Microsoft SQL Server DB instances that were created with a time
zone specified.
197 198 199 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 197 def timezone data[:timezone] end |
#unsubscribe_from(options = {}) ⇒ EventSubscription
1109 1110 1111 1112 1113 1114 1115 1116 1117 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 1109 def unsubscribe_from( = {}) = .merge(source_identifier: @snapshot_id) resp = @client.remove_source_identifier_from_subscription() EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, data: resp.data.event_subscription, client: @client ) end |
#vpc_id ⇒ String
Provides the VPC ID associated with the DB snapshot.
88 89 90 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 88 def vpc_id data[:vpc_id] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::RDS::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged.
Waiter polls an API operation until a resource enters a desired state.
Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_snapshot.rb', line 383 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |