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

Class: Aws::RDS::DBParameterGroupFamily

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

Defined Under Namespace

Classes: Collection

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DBParameterGroupFamily

Overloads:



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

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

Instance Method Details

#clientClient

Returns:



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

def client
  @client
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.



57
58
59
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 57

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",
})

Parameters:

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

    ({})

Options Hash (options):

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

    This parameter is not 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 that the remaining results can be retrieved.

    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.

Returns:



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 188

def engine_default_cluster_parameters(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = options.merge(db_parameter_group_family: @name)
    resp = @client.describe_engine_default_cluster_parameters(options)
    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
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

Returns:



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 219

def engine_default_parameters(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_parameter_group_family: @name)
    resp = @client.describe_engine_default_parameters(options)
    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

#nameString

Returns:

  • (String)


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

def name
  @name
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group_family.rb', line 139

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