class Aws::RDS::DBParameterGroup
Public Class Methods
@overload def initialize(name, options = {})
@param [String] name @option options [Client] :client
@overload def initialize(options = {})
@option options [required, String] :name @option options [Client] :client
# 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
Public Instance Methods
@return [Client]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 61 def client @client end
@example 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", }, ], })
@param [Hash] options ({}) @option options [required, String] :target_db_parameter_group_identifier
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`
@option options [required, String] :target_db_parameter_group_description
A description for the copied DB parameter group.
@option options [Array<Types::Tag>] :tags
A list of tags. For more information, see [Tagging Amazon RDS Resources][1] in the *Amazon RDS User Guide.* [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
@return [DBParameterGroup]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 308 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
@example Request syntax with placeholder values
dbparametergroup = db_parameter_group.create({ db_parameter_group_family: "String", # required description: "String", # required tags: [ { key: "String", value: "String", }, ], })
@param [Hash] options ({}) @option options [required, String] :db_parameter_group_family
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` (for MySQL 5.6-compatible Aurora) * `aurora-mysql` (for MySQL 5.7-compatible Aurora) * `aurora-postgresql` * `mariadb` * `mysql` * `oracle-ee` * `oracle-ee-cdb` * `oracle-se2` * `oracle-se2-cdb` * `postgres` * `sqlserver-ee` * `sqlserver-se` * `sqlserver-ex` * `sqlserver-web`
@option options [required, String] :description
The description for the DB parameter group.
@option options [Array<Types::Tag>] :tags
Tags to assign to the DB parameter group.
@return [DBParameterGroup]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 261 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
@return [Types::DBParameterGroup]
Returns the data for this {DBParameterGroup}. Calls {Client#describe_db_parameter_groups} if {#data_loaded?} is `false`.
# File lib/aws-sdk-rds/db_parameter_group.rb, line 81 def data load unless @data @data end
@return [Boolean]
Returns `true` if this resource is loaded. Accessing attributes or {#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-rds/db_parameter_group.rb, line 89 def data_loaded? !!@data end
The Amazon Resource
Name (ARN) for the DB parameter group. @return [String]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 54 def db_parameter_group_arn data[:db_parameter_group_arn] end
The name of the DB parameter group family that this DB parameter group is compatible with. @return [String]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 41 def db_parameter_group_family data[:db_parameter_group_family] end
@example Request syntax with placeholder values
db_parameter_group.delete()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 323 def delete(options = {}) options = options.merge(db_parameter_group_name: @name) resp = @client.delete_db_parameter_group(options) resp.data end
Provides the customer-specified description for this DB parameter group. @return [String]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 48 def description data[:description] end
@example 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 }, ], })
@param [Hash] options ({}) @option options [Time,DateTime,Date,Integer,String] :start_time
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]: http://en.wikipedia.org/wiki/ISO_8601
@option options [Time,DateTime,Date,Integer,String] :end_time
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]: http://en.wikipedia.org/wiki/ISO_8601
@option options [Integer] :duration
The number of minutes to retrieve events for. Default: 60
@option options [Array<String>] :event_categories
A list of event categories that trigger notifications for a event notification subscription.
@option options [Array<Types::Filter>] :filters
This parameter isn't currently supported.
@return [Event::Collection]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 529 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
@deprecated @api private
# File lib/aws-sdk-rds/db_parameter_group.rb, line 594 def identifiers { name: @name } end
Loads, or reloads {#data} for the current {DBParameterGroup}. Returns `self` making it possible to chain methods.
db_parameter_group.reload.data
@return [self]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 71 def load resp = @client.describe_db_parameter_groups(db_parameter_group_name: @name) @data = resp.db_parameter_groups[0] self end
@example 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"], }, ], })
@param [Hash] options ({}) @option options [required, Array<Types::Parameter>] :parameters
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method 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` <note markdown="1"> 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>
@return [DBParameterGroup]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 372 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
@return [String]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 33 def name @name end
@example Request syntax with placeholder values
parameters = db_parameter_group.parameters({ source: "String", filters: [ { name: "String", # required values: ["String"], # required }, ], })
@param [Hash] options ({}) @option options [String] :source
The parameter types to return. Default: All parameter types returned Valid Values: `user | system | engine-default`
@option options [Array<Types::Filter>] :filters
This parameter isn't currently supported.
@return [Parameter::Collection]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 573 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
@example 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"], }, ], })
@param [Hash] options ({}) @option options [Boolean] :reset_all_parameters
A value that indicates 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.
@option options [Array<Types::Parameter>] :parameters
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`
@return [DBParameterGroup]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 433 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
@example Request syntax with placeholder values
eventsubscription = db_parameter_group.subscribe_to({ subscription_name: "String", # required })
@param [Hash] options ({}) @option options [required, String] :subscription_name
The name of the RDS event notification subscription you want to add a source identifier to.
@return [EventSubscription]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 452 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
@example Request syntax with placeholder values
eventsubscription = db_parameter_group.unsubscribe_from({ subscription_name: "String", # required })
@param [Hash] options ({}) @option options [required, String] :subscription_name
The name of the RDS event notification subscription you want to remove a source identifier from.
@return [EventSubscription]
# File lib/aws-sdk-rds/db_parameter_group.rb, line 472 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
@deprecated Use [Aws::RDS::Client] wait_until
instead
Waiter polls an API operation until a resource enters a desired state.
@note The waiting operation is performed on a copy. The original resource
remains unchanged.
## 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
@yieldparam [Resource] resource to be used in the waiting condition.
@raise [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.
@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
encountered while polling for a resource that is not expected.
@raise [NotImplementedError] Raised when the resource does not
@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful
# File lib/aws-sdk-rds/db_parameter_group.rb, line 173 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
Private Instance Methods
# File lib/aws-sdk-rds/db_parameter_group.rb, line 601 def extract_name(args, options) value = args[0] || options.delete(:name) case value when String then value when nil then raise ArgumentError, "missing required option :name" else msg = "expected :name to be a String, got #{value.class}" raise ArgumentError, msg end end