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
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 = {}) {|resource| ... } ⇒ 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.
22 23 24 25 26 27 28 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#client ⇒ Client
61 62 63 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 61 def client @client end |
#copy(options = {}) ⇒ DBParameterGroup
309 310 311 312 313 314 315 316 317 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 309 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
262 263 264 265 266 267 268 269 270 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 262 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`.
81 82 83 84 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 81 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
89 90 91 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 89 def data_loaded? !!@data end |
#db_parameter_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB parameter group.
54 55 56 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 54 def db_parameter_group_arn data[:db_parameter_group_arn] end |
#db_parameter_group_family ⇒ String
The name of the DB parameter group family that this DB parameter group is compatible with.
41 42 43 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 41 def db_parameter_group_family data[:db_parameter_group_family] end |
#delete(options = {}) ⇒ EmptyStructure
324 325 326 327 328 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 324 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.
48 49 50 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 48 def description data[:description] end |
#events(options = {}) ⇒ Event::Collection
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 540 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.
605 606 607 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 605 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
71 72 73 74 75 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 71 def load resp = @client.describe_db_parameter_groups(db_parameter_group_name: @name) @data = resp.db_parameter_groups[0] self end |
#modify(options = {}) ⇒ DBParameterGroup
383 384 385 386 387 388 389 390 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 383 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
33 34 35 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 33 def name @name end |
#parameters(options = {}) ⇒ Parameter::Collection
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 584 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
444 445 446 447 448 449 450 451 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 444 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
463 464 465 466 467 468 469 470 471 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 463 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
483 484 485 486 487 488 489 490 491 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 483 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 = {}) {|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
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 173 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 |