Class: Aws::RDS::DBClusterParameterGroup
- Inherits:
-
Object
- Object
- Aws::RDS::DBClusterParameterGroup
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/db_cluster_parameter_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#db_cluster_parameter_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster parameter group.
-
#db_parameter_group_family ⇒ String
Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
-
#description ⇒ String
Provides the customer-specified description for this DB cluster parameter group.
- #name ⇒ String (also: #db_cluster_parameter_group_name)
Actions collapse
- #create(options = {}) ⇒ DBClusterParameterGroup
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
- #modify(options = {}) ⇒ DBClusterParameterGroup
- #reset(options = {}) ⇒ DBClusterParameterGroup
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::DBClusterParameterGroup
Returns the data for this DBClusterParameterGroup.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ DBClusterParameterGroup
constructor
A new instance of DBClusterParameterGroup.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBClusterParameterGroup.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ DBClusterParameterGroup #initialize(options = {}) ⇒ DBClusterParameterGroup
Returns a new instance of DBClusterParameterGroup.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/db_cluster_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_cluster_parameter_group.rb', line 57 def client @client end |
#create(options = {}) ⇒ DBClusterParameterGroup
223 224 225 226 227 228 229 230 231 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 223 def create( = {}) = .merge(db_cluster_parameter_group_name: @name) resp = @client.create_db_cluster_parameter_group() DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group.db_cluster_parameter_group_name, data: resp.data.db_cluster_parameter_group, client: @client ) end |
#data ⇒ Types::DBClusterParameterGroup
Returns the data for this Aws::RDS::DBClusterParameterGroup. Calls Client#describe_db_cluster_parameter_groups if #data_loaded? is ‘false`.
77 78 79 80 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 77 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
85 86 87 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 85 def data_loaded? !!@data end |
#db_cluster_parameter_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster parameter group.
50 51 52 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 50 def db_cluster_parameter_group_arn data[:db_cluster_parameter_group_arn] end |
#db_parameter_group_family ⇒ String
Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
37 38 39 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 37 def db_parameter_group_family data[:db_parameter_group_family] end |
#delete(options = {}) ⇒ EmptyStructure
238 239 240 241 242 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 238 def delete( = {}) = .merge(db_cluster_parameter_group_name: @name) resp = @client.delete_db_cluster_parameter_group() resp.data end |
#description ⇒ String
Provides the customer-specified description for this DB cluster parameter group.
44 45 46 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 44 def description data[:description] 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.
318 319 320 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 318 def identifiers { name: @name } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::DBClusterParameterGroup. Returns ‘self` making it possible to chain methods.
db_cluster_parameter_group.reload.data
67 68 69 70 71 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 67 def load resp = @client.describe_db_cluster_parameter_groups(db_cluster_parameter_group_name: @name) @data = resp.db_cluster_parameter_groups[0] self end |
#modify(options = {}) ⇒ DBClusterParameterGroup
267 268 269 270 271 272 273 274 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 267 def modify( = {}) = .merge(db_cluster_parameter_group_name: @name) resp = @client.modify_db_cluster_parameter_group() DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group_name, client: @client ) end |
#name ⇒ String Also known as: db_cluster_parameter_group_name
29 30 31 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 29 def name @name end |
#reset(options = {}) ⇒ DBClusterParameterGroup
307 308 309 310 311 312 313 314 |
# File 'lib/aws-sdk-rds/db_cluster_parameter_group.rb', line 307 def reset( = {}) = .merge(db_cluster_parameter_group_name: @name) resp = @client.reset_db_cluster_parameter_group() DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group_name, 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_cluster_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 |