You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::Parameter

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ Parameter #initialize(options = {}) ⇒ Parameter

Returns a new instance of Parameter

Overloads:

  • #initialize(name, options = {}) ⇒ Parameter

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Parameter

    Options Hash (options):

    • :name (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 19

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)
end

Instance Method Details

#allowed_valuesString

Specifies the valid range of values for the parameter.

Returns:

  • (String)


66
67
68
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 66

def allowed_values
  data[:allowed_values]
end

#apply_methodString

Indicates when to apply parameter updates.

Returns:

  • (String)


86
87
88
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 86

def apply_method
  data[:apply_method]
end

#apply_typeString

Specifies the engine specific parameters type.

Returns:

  • (String)


54
55
56
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 54

def apply_type
  data[:apply_type]
end

#clientClient

Returns:



93
94
95
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 93

def client
  @client
end

#dataTypes::Parameter

Returns the data for this Aws::RDS::Parameter.

Returns:

Raises:



108
109
110
111
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 108

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



116
117
118
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 116

def data_loaded?
  !!@data
end

#data_typeString

Specifies the valid data type for the parameter.

Returns:

  • (String)


60
61
62
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 60

def data_type
  data[:data_type]
end

#descriptionString

Provides a description of the parameter.

Returns:

  • (String)


42
43
44
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 42

def description
  data[:description]
end

#is_modifiableBoolean

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Returns:

  • (Boolean)


74
75
76
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 74

def is_modifiable
  data[:is_modifiable]
end

#minimum_engine_versionString

The earliest engine version to which the parameter can apply.

Returns:

  • (String)


80
81
82
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 80

def minimum_engine_version
  data[:minimum_engine_version]
end

#nameString Also known as: parameter_name

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 29

def name
  @name
end

#parameter_valueString

Specifies the value of the parameter.

Returns:

  • (String)


36
37
38
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 36

def parameter_value
  data[:parameter_value]
end

#sourceString

Indicates the source of the parameter value.

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 48

def source
  data[:source]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

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(options) {|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

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (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.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/parameter.rb', line 198

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