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

Class: Aws::RDS::DBParameterGroup

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes 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)


19
20
21
22
23
24
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.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

#clientClient

Returns:



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

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:

    • Cannot be null, empty, or blank

    • Must contain from 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter

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

Returns:



156
157
158
159
160
161
162
163
164
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 156

def copy(options = {})
  options = options.merge(source_db_parameter_group_identifier: @name)
  resp = @client.copy_db_parameter_group(options)
  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.

  • :description (required, String)

    The description for the DB parameter group.

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

    A list of tags.

Returns:



114
115
116
117
118
119
120
121
122
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 114

def create(options = {})
  options = options.merge(db_parameter_group_name: @name)
  resp = @client.create_db_parameter_group(options)
  DBParameterGroup.new(
    name: resp.data.db_parameter_group.db_parameter_group_name,
    data: resp.data.db_parameter_group,
    client: @client
  )
end

#dataTypes::DBParameterGroup

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

Returns:



77
78
79
80
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 77

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.



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

def data_loaded?
  !!@data
end

#db_parameter_group_arnString

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

Returns:

  • (String)


50
51
52
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 50

def db_parameter_group_arn
  data.db_parameter_group_arn
end

#db_parameter_group_familyString

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

Returns:

  • (String)


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

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)


171
172
173
174
175
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 171

def delete(options = {})
  options = options.merge(db_parameter_group_name: @name)
  resp = @client.delete_db_parameter_group(options)
  resp.data
end

#descriptionString

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

Returns:

  • (String)


44
45
46
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 44

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.

    Example: 2009-07-08T18:00Z

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

    Example: 2009-07-08T18:00Z

  • :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 is not currently supported.

Returns:



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 369

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      source_type: "db-parameter-group",
      source_identifier: @name
    )
    resp = @client.describe_events(options)
    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

#loadself 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)


67
68
69
70
71
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 67

def load
  resp = @client.describe_db_parameter_groups(db_parameter_group_name: @name)
  @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
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

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

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent 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, and changes are applied when you reboot the DB instance without failover.

Returns:



212
213
214
215
216
217
218
219
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 212

def modify(options = {})
  options = options.merge(db_parameter_group_name: @name)
  resp = @client.modify_db_parameter_group(options)
  DBParameterGroup.new(
    name: resp.data.db_parameter_group_name,
    client: @client
  )
end

#nameString Also known as: db_parameter_group_name

Returns:

  • (String)


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

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

    This parameter is not currently supported.

Returns:



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 413

def parameters(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_parameter_group_name: @name)
    resp = @client.describe_db_parameters(options)
    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
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :reset_all_parameters (Boolean)

    Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

    Default: true

  • :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:



273
274
275
276
277
278
279
280
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 273

def reset(options = {})
  options = options.merge(db_parameter_group_name: @name)
  resp = @client.reset_db_parameter_group(options)
  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:



292
293
294
295
296
297
298
299
300
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 292

def subscribe_to(options = {})
  options = options.merge(source_identifier: @name)
  resp = @client.add_source_identifier_to_subscription(options)
  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:



312
313
314
315
316
317
318
319
320
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_parameter_group.rb', line 312

def unsubscribe_from(options = {})
  options = options.merge(source_identifier: @name)
  resp = @client.remove_source_identifier_from_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end