Class: Aws::RDS::DBClusterSnapshot
- Inherits:
-
Object
- Object
- Aws::RDS::DBClusterSnapshot
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#allocated_storage ⇒ Integer
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
-
#availability_zones ⇒ Array<String>
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
-
#cluster_create_time ⇒ Time
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
-
#cluster_id ⇒ String
(also: #db_cluster_identifier)
-
#db_cluster_resource_id ⇒ String
The resource ID of the DB cluster that this DB cluster snapshot was created from.
-
#db_cluster_snapshot_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster snapshot.
-
#db_system_id ⇒ String
Reserved for future use.
-
#engine ⇒ String
The name of the database engine for this DB cluster snapshot.
-
#engine_mode ⇒ String
The engine mode of the database engine for this DB cluster snapshot.
-
#engine_version ⇒ String
The version of the database engine for this DB cluster snapshot.
-
#iam_database_authentication_enabled ⇒ Boolean
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
-
#kms_key_id ⇒ String
If
StorageEncrypted
is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. -
#license_model ⇒ String
The license model information for this DB cluster snapshot.
-
#master_username ⇒ String
The master username for this DB cluster snapshot.
-
#percent_progress ⇒ Integer
The percentage of the estimated data that has been transferred.
-
#port ⇒ Integer
The port that the DB cluster was listening on at the time of the snapshot.
-
#snapshot_create_time ⇒ Time
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
-
#snapshot_id ⇒ String
(also: #db_cluster_snapshot_identifier)
-
#snapshot_type ⇒ String
The type of the DB cluster snapshot.
-
#source_db_cluster_snapshot_arn ⇒ String
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
-
#status ⇒ String
The status of this DB cluster snapshot.
-
#storage_encrypted ⇒ Boolean
Indicates whether the DB cluster snapshot is encrypted.
-
#storage_throughput ⇒ Integer
The storage throughput for the DB cluster snapshot.
-
#storage_type ⇒ String
The storage type associated with the DB cluster snapshot.
-
#tag_list ⇒ Array<Types::Tag>
A list of tags.
-
#vpc_id ⇒ String
The VPC ID associated with the DB cluster snapshot.
Actions collapse
-
#copy(options = {}) ⇒ DBClusterSnapshot
-
#create(options = {}) ⇒ DBClusterSnapshot
-
#delete(options = {}) ⇒ DBClusterSnapshot
-
#restore(options = {}) ⇒ DBCluster
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::DBClusterSnapshot
Returns the data for this DBClusterSnapshot.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ DBClusterSnapshot
constructor
A new instance of DBClusterSnapshot.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBClusterSnapshot.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(cluster_id, snapshot_id, options = {}) ⇒ DBClusterSnapshot #initialize(options = {}) ⇒ DBClusterSnapshot
Returns a new instance of DBClusterSnapshot.
24 25 26 27 28 29 30 31 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 24 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @cluster_id = extract_cluster_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
The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
76 77 78 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 76 def allocated_storage data[:allocated_storage] end |
#availability_zones ⇒ Array<String>
The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
50 51 52 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 50 def availability_zones data[:availability_zones] end |
#client ⇒ Client
225 226 227 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 225 def client @client end |
#cluster ⇒ DBCluster
990 991 992 993 994 995 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 990 def cluster DBCluster.new( id: @cluster_id, client: @client ) end |
#cluster_create_time ⇒ Time
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
109 110 111 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 109 def cluster_create_time data[:cluster_create_time] end |
#cluster_id ⇒ String Also known as: db_cluster_identifier
36 37 38 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 36 def cluster_id @cluster_id end |
#copy(options = {}) ⇒ DBClusterSnapshot
513 514 515 516 517 518 519 520 521 522 523 524 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 513 def copy( = {}) = .merge(source_db_cluster_snapshot_identifier: @snapshot_id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.copy_db_cluster_snapshot() end DBClusterSnapshot.new( cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier, snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier, data: resp.data.db_cluster_snapshot, client: @client ) end |
#create(options = {}) ⇒ DBClusterSnapshot
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 374 def create( = {}) = .merge( db_cluster_identifier: @cluster_id, db_cluster_snapshot_identifier: @snapshot_id ) resp = Aws::Plugins::UserAgent.feature('resource') do @client.create_db_cluster_snapshot() end DBClusterSnapshot.new( cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier, snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier, data: resp.data.db_cluster_snapshot, client: @client ) end |
#data ⇒ Types::DBClusterSnapshot
Returns the data for this Aws::RDS::DBClusterSnapshot. Calls
Client#describe_db_cluster_snapshots if #data_loaded? is false
.
247 248 249 250 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 247 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
255 256 257 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 255 def data_loaded? !!@data end |
#db_cluster_resource_id ⇒ String
The resource ID of the DB cluster that this DB cluster snapshot was created from.
208 209 210 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 208 def db_cluster_resource_id data[:db_cluster_resource_id] end |
#db_cluster_snapshot_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster snapshot.
161 162 163 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 161 def db_cluster_snapshot_arn data[:db_cluster_snapshot_arn] end |
#db_system_id ⇒ String
Reserved for future use.
193 194 195 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 193 def db_system_id data[:db_system_id] end |
#delete(options = {}) ⇒ DBClusterSnapshot
531 532 533 534 535 536 537 538 539 540 541 542 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 531 def delete( = {}) = .merge(db_cluster_snapshot_identifier: @snapshot_id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.delete_db_cluster_snapshot() end DBClusterSnapshot.new( cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier, snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier, data: resp.data.db_cluster_snapshot, client: @client ) end |
#engine ⇒ String
The name of the database engine for this DB cluster snapshot.
63 64 65 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 63 def engine data[:engine] end |
#engine_mode ⇒ String
The engine mode of the database engine for this DB cluster snapshot.
69 70 71 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 69 def engine_mode data[:engine_mode] end |
#engine_version ⇒ String
The version of the database engine for this DB cluster snapshot.
121 122 123 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 121 def engine_version data[:engine_version] end |
#events(options = {}) ⇒ Event::Collection
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 1042 def events( = {}) batches = Enumerator.new do |y| = .merge( source_type: "db-cluster-snapshot", source_identifier: @snapshot_id ) resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_events() end 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
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
176 177 178 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 176 def iam_database_authentication_enabled data[:iam_database_authentication_enabled] end |
#kms_key_id ⇒ String
If StorageEncrypted
is true, the Amazon Web Services KMS key
identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
155 156 157 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 155 def kms_key_id data[:kms_key_id] end |
#license_model ⇒ String
The license model information for this DB cluster snapshot.
127 128 129 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 127 def license_model data[:license_model] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::DBClusterSnapshot.
Returns self
making it possible to chain methods.
db_cluster_snapshot.reload.data
235 236 237 238 239 240 241 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 235 def load resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_db_cluster_snapshots(db_cluster_snapshot_identifier: @snapshot_id) end @data = resp.db_cluster_snapshots[0] self end |
#master_username ⇒ String
The master username for this DB cluster snapshot.
115 116 117 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 115 def master_username data[:master_username] end |
#percent_progress ⇒ Integer
The percentage of the estimated data that has been transferred.
139 140 141 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 139 def percent_progress data[:percent_progress] end |
#port ⇒ Integer
The port that the DB cluster was listening on at the time of the snapshot.
96 97 98 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 96 def port data[:port] end |
#restore(options = {}) ⇒ DBCluster
975 976 977 978 979 980 981 982 983 984 985 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 975 def restore( = {}) = .merge(snapshot_identifier: @snapshot_id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.restore_db_cluster_from_snapshot() end DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end |
#snapshot_create_time ⇒ Time
The time when the snapshot was taken, in Universal Coordinated Time (UTC).
57 58 59 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 57 def snapshot_create_time data[:snapshot_create_time] end |
#snapshot_id ⇒ String Also known as: db_cluster_snapshot_identifier
42 43 44 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 42 def snapshot_id @snapshot_id end |
#snapshot_type ⇒ String
The type of the DB cluster snapshot.
133 134 135 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 133 def snapshot_type data[:snapshot_type] end |
#source_db_cluster_snapshot_arn ⇒ String
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
169 170 171 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 169 def source_db_cluster_snapshot_arn data[:source_db_cluster_snapshot_arn] end |
#status ⇒ String
The status of this DB cluster snapshot. Valid statuses are the following:
available
copying
creating
89 90 91 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 89 def status data[:status] end |
#storage_encrypted ⇒ Boolean
Indicates whether the DB cluster snapshot is encrypted.
145 146 147 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 145 def storage_encrypted data[:storage_encrypted] end |
#storage_throughput ⇒ Integer
The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
218 219 220 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 218 def storage_throughput data[:storage_throughput] end |
#storage_type ⇒ String
The storage type associated with the DB cluster snapshot.
This setting is only for Aurora DB clusters.
201 202 203 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 201 def storage_type data[:storage_type] end |
#tag_list ⇒ Array<Types::Tag>
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
187 188 189 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 187 def tag_list data[:tag_list] end |
#vpc_id ⇒ String
The VPC ID associated with the DB cluster snapshot.
102 103 104 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 102 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
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster_snapshot.rb', line 339 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::Plugins::UserAgent.feature('resource') do Aws::Waiters::Waiter.new().wait({}) end end |