Class: Aws::RDS::DBParameterGroup

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DBParameterGroup.

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBParameterGroup

    Options Hash (options):

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


22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-rds/db_parameter_group.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

Instance Method Details

#client ⇒ Client

Returns:



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

def client
  @client
end

#copy(options = {}) ⇒ DBParameterGroup

Examples:

Request syntax with placeholder values


dbparametergroup = db_parameter_group.copy({
  target_db_parameter_group_identifier: "String", # required
  target_db_parameter_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :target_db_parameter_group_identifier (required, String) —

    The identifier for the copied DB parameter group.

    Constraints:

    • Can’t be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can’t end with a hyphen or contain two consecutive hyphens

    Example: ‘my-db-parameter-group`

  • :target_db_parameter_group_description (required, String) —

    A description for the copied DB parameter group.

  • :tags (Array<Types::Tag>) —

    A list of tags.

    For more information, see [Tagging Amazon RDS resources] in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources] in the *Amazon Aurora User Guide*.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html

Returns:



318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 318

def copy(options = {})
  options = options.merge(source_db_parameter_group_identifier: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.copy_db_parameter_group(options)
  end
  DBParameterGroup.new(
    name: resp.data.db_parameter_group.db_parameter_group_name,
    data: resp.data.db_parameter_group,
    client: @client
  )
end

#create(options = {}) ⇒ DBParameterGroup

Examples:

Request syntax with placeholder values


dbparametergroup = db_parameter_group.create({
  db_parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :db_parameter_group_family (required, String) —

    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

    To list all of the available parameter group families for a DB engine, use the following command:

    ‘aws rds describe-db-engine-versions –query “DBEngineVersions[].DBParameterGroupFamily” –engine <engine>`

    For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

    ‘aws rds describe-db-engine-versions –query “DBEngineVersions[].DBParameterGroupFamily” –engine mysql`

    <note markdown=“1”> The output contains duplicates.

    </note>

    The following are the valid DB engine values:

    • ‘aurora-mysql`

    • ‘aurora-postgresql`

    • ‘db2-ae`

    • ‘db2-se`

    • ‘mysql`

    • ‘oracle-ee`

    • ‘oracle-ee-cdb`

    • ‘oracle-se2`

    • ‘oracle-se2-cdb`

    • ‘postgres`

    • ‘sqlserver-ee`

    • ‘sqlserver-se`

    • ‘sqlserver-ex`

    • ‘sqlserver-web`

  • :description (required, String) —

    The description for the DB parameter group.

  • :tags (Array<Types::Tag>) —

    Tags to assign to the DB parameter group.

Returns:



265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 265

def create(options = {})
  options = options.merge(db_parameter_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_db_parameter_group(options)
  end
  DBParameterGroup.new(
    name: resp.data.db_parameter_group.db_parameter_group_name,
    data: resp.data.db_parameter_group,
    client: @client
  )
end

#data ⇒ Types::DBParameterGroup

Returns the data for this Aws::RDS::DBParameterGroup. Calls Client#describe_db_parameter_groups if #data_loaded? is ‘false`.

Returns:



83
84
85
86
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 83

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.



91
92
93
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 91

def data_loaded?
  !!@data
end

#db_parameter_group_arn ⇒ String

The Amazon Resource Name (ARN) for the DB parameter group.

Returns:

  • (String) 


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

def db_parameter_group_arn
  data[:db_parameter_group_arn]
end

#db_parameter_group_family ⇒ String

The name of the DB parameter group family that this DB parameter group is compatible with.

Returns:

  • (String) 


41
42
43
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 41

def db_parameter_group_family
  data[:db_parameter_group_family]
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


db_parameter_group.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


335
336
337
338
339
340
341
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 335

def delete(options = {})
  options = options.merge(db_parameter_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_db_parameter_group(options)
  end
  resp.data
end

#description ⇒ String

Provides the customer-specified description for this DB parameter group.

Returns:

  • (String) 


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

def description
  data[:description]
end

#events(options = {}) ⇒ Event::Collection

Examples:

Request syntax with placeholder values


events = db_parameter_group.events({
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  event_categories: ["String"],
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :start_time (Time, DateTime, Date, Integer, String) —

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the

    ISO8601 Wikipedia page.][1

    Example: 2009-07-08T18:00Z

    [1]: en.wikipedia.org/wiki/ISO_8601

  • :end_time (Time, DateTime, Date, Integer, String) —

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the

    ISO8601 Wikipedia page.][1

    Example: 2009-07-08T18:00Z

    [1]: en.wikipedia.org/wiki/ISO_8601

  • :duration (Integer) —

    The number of minutes to retrieve events for.

    Default: 60

  • :event_categories (Array<String>) —

    A list of event categories that trigger notifications for a event notification subscription.

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

    This parameter isn’t currently supported.

Returns:



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 561

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      source_type: "db-parameter-group",
      source_identifier: @name
    )
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_events(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.events.each do |e|
        batch << Event.new(
          source_id: e.source_identifier,
          date: e.date,
          data: e,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Event::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. 


633
634
635
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 633

def identifiers
  { name: @name }
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::RDS::DBParameterGroup. Returns ‘self` making it possible to chain methods.

db_parameter_group.reload.data

Returns:

  • (self) 


71
72
73
74
75
76
77
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 71

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_db_parameter_groups(db_parameter_group_name: @name)
  end
  @data = resp.db_parameter_groups[0]
  self
end

#modify(options = {}) ⇒ DBParameterGroup

Examples:

Request syntax with placeholder values


dbparametergroup = db_parameter_group.modify({
  parameters: [ # required
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
      supported_engine_modes: ["String"],
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :parameters (required, Array<Types::Parameter>) —

    An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.

    Valid Values (for the application method): ‘immediate | pending-reboot`

    You can use the ‘immediate` value with dynamic parameters only. You can use the `pending-reboot` value for both dynamic and static parameters.

    When the application method is ‘immediate`, changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.

    When the application method is ‘pending-reboot`, changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.

    <note markdown=“1”> You can’t use ‘pending-reboot` with dynamic parameters on RDS for SQL Server DB instances. Use `immediate`.

    </note>

    For more information on modifying DB parameters, see [Working with DB parameter groups] in the *Amazon RDS User Guide*.

    [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html

Returns:



396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 396

def modify(options = {})
  options = options.merge(db_parameter_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.modify_db_parameter_group(options)
  end
  DBParameterGroup.new(
    name: resp.data.db_parameter_group_name,
    client: @client
  )
end

#name ⇒ String Also known as: db_parameter_group_name

Returns:

  • (String) 


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

def name
  @name
end

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

Examples:

Request syntax with placeholder values


parameters = db_parameter_group.parameters({
  source: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :source (String) —

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: ‘user | system | engine-default`

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

    A filter that specifies one or more DB parameters to describe.

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

Returns:



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 610

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

#reset(options = {}) ⇒ DBParameterGroup

Examples:

Request syntax with placeholder values


dbparametergroup = db_parameter_group.reset({
  reset_all_parameters: false,
  parameters: [
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      apply_type: "String",
      data_type: "String",
      allowed_values: "String",
      is_modifiable: false,
      minimum_engine_version: "String",
      apply_method: "immediate", # accepts immediate, pending-reboot
      supported_engine_modes: ["String"],
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :reset_all_parameters (Boolean) —

    Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

  • :parameters (Array<Types::Parameter>) —

    To reset the entire DB parameter group, specify the ‘DBParameterGroup` name and `ResetAllParameters` parameters. To reset specific parameters, provide a list of the following: `ParameterName` and `ApplyMethod`. A maximum of 20 parameters can be modified in a single request.

    MySQL

    Valid Values (for Apply method): ‘immediate` | `pending-reboot`

    You can use the immediate value with dynamic parameters only. You can use the ‘pending-reboot` value for both dynamic and static parameters, and changes are applied when DB instance reboots.

    MariaDB

    Valid Values (for Apply method): ‘immediate` | `pending-reboot`

    You can use the immediate value with dynamic parameters only. You can use the ‘pending-reboot` value for both dynamic and static parameters, and changes are applied when DB instance reboots.

    Oracle

    Valid Values (for Apply method): ‘pending-reboot`

Returns:



459
460
461
462
463
464
465
466
467
468
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 459

def reset(options = {})
  options = options.merge(db_parameter_group_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.reset_db_parameter_group(options)
  end
  DBParameterGroup.new(
    name: resp.data.db_parameter_group_name,
    client: @client
  )
end

#subscribe_to(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = db_parameter_group.subscribe_to({
  subscription_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :subscription_name (required, String) —

    The name of the RDS event notification subscription you want to add a source identifier to.

Returns:



480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 480

def subscribe_to(options = {})
  options = options.merge(source_identifier: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.add_source_identifier_to_subscription(options)
  end
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

#unsubscribe_from(options = {}) ⇒ EventSubscription

Examples:

Request syntax with placeholder values


eventsubscription = db_parameter_group.unsubscribe_from({
  subscription_name: "String", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :subscription_name (required, String) —

    The name of the RDS event notification subscription you want to remove a source identifier from.

Returns:



502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 502

def unsubscribe_from(options = {})
  options = options.merge(source_identifier: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.remove_source_identifier_from_subscription(options)
  end
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
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

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/aws-sdk-rds/db_parameter_group.rb', line 175

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