Class: Aws::RDS::DBParameterGroup
- Inherits:
-
Object
- Object
- Aws::RDS::DBParameterGroup
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/db_parameter_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#db_parameter_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB parameter group.
-
#db_parameter_group_family ⇒ String
Provides the name of the DB parameter group family that this DB parameter group is compatible with.
-
#description ⇒ String
Provides the customer-specified description for this DB parameter group.
- #name ⇒ String (also: #db_parameter_group_name)
Actions collapse
- #copy(options = {}) ⇒ DBParameterGroup
- #create(options = {}) ⇒ DBParameterGroup
- #delete(options = {}) ⇒ EmptyStructure
- #modify(options = {}) ⇒ DBParameterGroup
- #reset(options = {}) ⇒ DBParameterGroup
- #subscribe_to(options = {}) ⇒ EventSubscription
- #unsubscribe_from(options = {}) ⇒ EventSubscription
Associations collapse
- #events(options = {}) ⇒ Event::Collection
- #identifiers ⇒ Object deprecated private Deprecated.
- #parameters(options = {}) ⇒ Parameter::Collection
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::DBParameterGroup
Returns the data for this DBParameterGroup.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ DBParameterGroup
constructor
A new instance of DBParameterGroup.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBParameterGroup.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ DBParameterGroup #initialize(options = {}) ⇒ DBParameterGroup
Returns a new instance of DBParameterGroup.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#client ⇒ Client
57 58 59 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 57 def client @client end |
#copy(options = {}) ⇒ DBParameterGroup
271 272 273 274 275 276 277 278 279 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 271 def copy( = {}) = .merge(source_db_parameter_group_identifier: @name) resp = @client.copy_db_parameter_group() DBParameterGroup.new( name: resp.data.db_parameter_group.db_parameter_group_name, data: resp.data.db_parameter_group, client: @client ) end |
#create(options = {}) ⇒ DBParameterGroup
224 225 226 227 228 229 230 231 232 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 224 def create( = {}) = .merge(db_parameter_group_name: @name) resp = @client.create_db_parameter_group() DBParameterGroup.new( name: resp.data.db_parameter_group.db_parameter_group_name, data: resp.data.db_parameter_group, client: @client ) end |
#data ⇒ Types::DBParameterGroup
Returns the data for this Aws::RDS::DBParameterGroup. Calls Client#describe_db_parameter_groups if #data_loaded? is ‘false`.
77 78 79 80 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 77 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
85 86 87 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 85 def data_loaded? !!@data end |
#db_parameter_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB parameter group.
50 51 52 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 50 def db_parameter_group_arn data[:db_parameter_group_arn] end |
#db_parameter_group_family ⇒ String
Provides the name of the DB parameter group family that this DB parameter group is compatible with.
37 38 39 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 37 def db_parameter_group_family data[:db_parameter_group_family] end |
#delete(options = {}) ⇒ EmptyStructure
286 287 288 289 290 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 286 def delete( = {}) = .merge(db_parameter_group_name: @name) resp = @client.delete_db_parameter_group() resp.data end |
#description ⇒ String
Provides the customer-specified description for this DB parameter group.
44 45 46 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 44 def description data[:description] end |
#events(options = {}) ⇒ Event::Collection
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 486 def events( = {}) batches = Enumerator.new do |y| = .merge( source_type: "db-parameter-group", source_identifier: @name ) 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 |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
551 552 553 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 551 def identifiers { name: @name } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::DBParameterGroup. Returns ‘self` making it possible to chain methods.
db_parameter_group.reload.data
67 68 69 70 71 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 67 def load resp = @client.describe_db_parameter_groups(db_parameter_group_name: @name) @data = resp.db_parameter_groups[0] self end |
#modify(options = {}) ⇒ DBParameterGroup
328 329 330 331 332 333 334 335 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 328 def modify( = {}) = .merge(db_parameter_group_name: @name) resp = @client.modify_db_parameter_group() DBParameterGroup.new( name: resp.data.db_parameter_group_name, client: @client ) end |
#name ⇒ String Also known as: db_parameter_group_name
29 30 31 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 29 def name @name end |
#parameters(options = {}) ⇒ Parameter::Collection
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 530 def parameters( = {}) batches = Enumerator.new do |y| = .merge(db_parameter_group_name: @name) resp = @client.describe_db_parameters() resp.each_page do |page| batch = [] page.data.parameters.each do |p| batch << Parameter.new( name: p.parameter_name, data: p, client: @client ) end y.yield(batch) end end Parameter::Collection.new(batches) end |
#reset(options = {}) ⇒ DBParameterGroup
390 391 392 393 394 395 396 397 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 390 def reset( = {}) = .merge(db_parameter_group_name: @name) resp = @client.reset_db_parameter_group() DBParameterGroup.new( name: resp.data.db_parameter_group_name, client: @client ) end |
#subscribe_to(options = {}) ⇒ EventSubscription
409 410 411 412 413 414 415 416 417 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 409 def subscribe_to( = {}) = .merge(source_identifier: @name) 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 |
#unsubscribe_from(options = {}) ⇒ EventSubscription
429 430 431 432 433 434 435 436 437 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 429 def unsubscribe_from( = {}) = .merge(source_identifier: @name) 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 |
#wait_until(options = {}, &block) ⇒ 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) {|instance| instance.state.name == 'running' }
## 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
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 167 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 |