Class: Aws::RDS::DBParameterGroupFamily

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-rds/db_parameter_group_family.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DBParameterGroupFamily.

Overloads:



22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-rds/db_parameter_group_family.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = Aws::EmptyStructure.new
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#client ⇒ Client 



40
41
42
 
# File 'lib/aws-sdk-rds/db_parameter_group_family.rb', line 40

def client
  @client
end

#data ⇒ EmptyStructure

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. 



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

def data
  @data
end

#data_loaded? ⇒ Boolean 



61
62
63
 
# File 'lib/aws-sdk-rds/db_parameter_group_family.rb', line 61

def data_loaded?
  !!@data
end

#engine_default_cluster_parameters(options = {}) ⇒ Parameter::Collection

Examples:

Request syntax with placeholder values


engine_default_cluster_parameters = db_parameter_group_family.engine_default_cluster_parameters({
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

Options Hash (options):

  • :filters (Array<Types::Filter>) —

    This parameter isn’t currently supported.

  • :max_records (Integer) —

    The maximum number of records to include in the response. If more records exist than the specified ‘MaxRecords` value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • :marker (String) —

    An optional pagination token provided by a previous ‘DescribeEngineDefaultClusterParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.



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

def engine_default_cluster_parameters(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(db_parameter_group_family: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_engine_default_cluster_parameters(options)
    end
    resp.data.engine_defaults.parameters.each do |p|
      batch << Parameter.new(
        name: p.parameter_name,
        data: p,
        client: @client
      )
    end
    y.yield(batch)
  end
  Parameter::Collection.new(batches)
end

#engine_default_parameters(options = {}) ⇒ Parameter::Collection

Examples:

Request syntax with placeholder values


engine_default_parameters = db_parameter_group_family.engine_default_parameters({
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Options Hash (options):

  • :filters (Array<Types::Filter>) —

    A filter that specifies one or more parameters to describe.

    The only supported filter is ‘parameter-name`. The results list only includes information about the parameters with these names.



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/aws-sdk-rds/db_parameter_group_family.rb', line 232

def engine_default_parameters(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_parameter_group_family: @name)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_engine_default_parameters(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.engine_defaults.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

#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.

Deprecated. 


255
256
257
 
# File 'lib/aws-sdk-rds/db_parameter_group_family.rb', line 255

def identifiers
  { name: @name }
end

#load ⇒ Object Also known as: reload

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.

Raises:

  • (NotImplementedError) 


46
47
48
49
 
# File 'lib/aws-sdk-rds/db_parameter_group_family.rb', line 46

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#name ⇒ String 



33
34
35
 
# File 'lib/aws-sdk-rds/db_parameter_group_family.rb', line 33

def name
  @name
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/aws-sdk-rds/db_parameter_group_family.rb', line 145

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end