class Aws::RDS::Parameter
Public Class Methods
@overload def initialize(name, options = {})
@param [String] name @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :name @option options [Client] :client
# File lib/aws-sdk-rds/parameter.rb, line 22 def initialize(*args) options = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, options) @data = options.delete(:data) @client = options.delete(:client) || Client.new(options) @waiter_block_warned = false end
Public Instance Methods
Specifies the valid range of values for the parameter. @return [String]
# File lib/aws-sdk-rds/parameter.rb, line 70 def allowed_values data[:allowed_values] end
Indicates when to apply parameter updates. @return [String]
# File lib/aws-sdk-rds/parameter.rb, line 90 def apply_method data[:apply_method] end
Specifies the engine specific parameters type. @return [String]
# File lib/aws-sdk-rds/parameter.rb, line 58 def apply_type data[:apply_type] end
@return [Client]
# File lib/aws-sdk-rds/parameter.rb, line 103 def client @client end
@raise [NotImplementedError] Raises when {#data_loaded?} is `false`. @return [Types::Parameter]
Returns the data for this {Parameter}.
# File lib/aws-sdk-rds/parameter.rb, line 118 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-rds/parameter.rb, line 126 def data_loaded? !!@data end
Specifies the valid data type for the parameter. @return [String]
# File lib/aws-sdk-rds/parameter.rb, line 64 def data_type data[:data_type] end
Provides a description of the parameter. @return [String]
# File lib/aws-sdk-rds/parameter.rb, line 46 def description data[:description] end
@deprecated @api private
# File lib/aws-sdk-rds/parameter.rb, line 229 def identifiers { name: @name } end
Indicates whether (`true`) or not (`false`) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. @return [Boolean]
# File lib/aws-sdk-rds/parameter.rb, line 78 def is_modifiable data[:is_modifiable] end
@raise [NotImplementedError] @api private
# File lib/aws-sdk-rds/parameter.rb, line 109 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end
The earliest engine version to which the parameter can apply. @return [String]
# File lib/aws-sdk-rds/parameter.rb, line 84 def minimum_engine_version data[:minimum_engine_version] end
@return [String]
# File lib/aws-sdk-rds/parameter.rb, line 33 def name @name end
Specifies the value of the parameter. @return [String]
# File lib/aws-sdk-rds/parameter.rb, line 40 def parameter_value data[:parameter_value] end
Indicates the source of the parameter value. @return [String]
# File lib/aws-sdk-rds/parameter.rb, line 52 def source data[:source] end
The valid DB engine modes. @return [Array<String>]
# File lib/aws-sdk-rds/parameter.rb, line 96 def supported_engine_modes data[:supported_engine_modes] end
@deprecated Use [Aws::RDS::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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(options) {|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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
terminates because the waiter has entered a state that it will not transition out of, preventing success. yet successful.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-rds/parameter.rb, line 210 def wait_until(options = {}, &block) self_copy = self.dup attempts = 0 options[:max_attempts] = 10 unless options.key?(:max_attempts) options[:delay] ||= 10 options[:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == options[:max_attempts] :retry end end Aws::Waiters::Waiter.new(options).wait({}) end
Private Instance Methods
# File lib/aws-sdk-rds/parameter.rb, line 236 def extract_name(args, options) value = args[0] || options.delete(:name) case value when String then value when nil then raise ArgumentError, "missing required option :name" else msg = "expected :name to be a String, got #{value.class}" raise ArgumentError, msg end end