class Aws::RDS::DBClusterParameterGroup
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_cluster_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_cluster_parameter_group.rb, line 61 def client @client end
@example Request syntax with placeholder values
dbclusterparametergroup = db_cluster_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 cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. **Aurora MySQL** Example: `aurora5.6`, `aurora-mysql5.7` **Aurora PostgreSQL** Example: `aurora-postgresql9.6` 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 Aurora PostgreSQL DB engine, use the following command: `aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql` <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`
@option options [required, String] :description
The description for the DB cluster parameter group.
@option options [Array<Types::Tag>] :tags
Tags to assign to the DB cluster parameter group.
@return [DBClusterParameterGroup]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 249 def create(options = {}) options = options.merge(db_cluster_parameter_group_name: @name) resp = @client.create_db_cluster_parameter_group(options) DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group.db_cluster_parameter_group_name, data: resp.data.db_cluster_parameter_group, client: @client ) end
@return [Types::DBClusterParameterGroup]
Returns the data for this {DBClusterParameterGroup}. Calls {Client#describe_db_cluster_parameter_groups} if {#data_loaded?} is `false`.
# File lib/aws-sdk-rds/db_cluster_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_cluster_parameter_group.rb, line 89 def data_loaded? !!@data end
The Amazon Resource
Name (ARN) for the DB cluster parameter group. @return [String]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 54 def db_cluster_parameter_group_arn data[:db_cluster_parameter_group_arn] end
The name of the DB parameter group family that this DB cluster parameter group is compatible with. @return [String]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 41 def db_parameter_group_family data[:db_parameter_group_family] end
@example Request syntax with placeholder values
db_cluster_parameter_group.delete()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 264 def delete(options = {}) options = options.merge(db_cluster_parameter_group_name: @name) resp = @client.delete_db_cluster_parameter_group(options) resp.data end
Provides the customer-specified description for this DB cluster parameter group. @return [String]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 48 def description data[:description] end
@deprecated @api private
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 360 def identifiers { name: @name } end
Loads, or reloads {#data} for the current {DBClusterParameterGroup}. Returns `self` making it possible to chain methods.
db_cluster_parameter_group.reload.data
@return [self]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 71 def load resp = @client.describe_db_cluster_parameter_groups(db_cluster_parameter_group_name: @name) @data = resp.db_cluster_parameter_groups[0] self end
@example Request syntax with placeholder values
dbclusterparametergroup = db_cluster_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
A list of parameters in the DB cluster parameter group to modify. 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 clusters 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 clusters associated with the parameter group. </note>
@return [DBClusterParameterGroup]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 309 def modify(options = {}) options = options.merge(db_cluster_parameter_group_name: @name) resp = @client.modify_db_cluster_parameter_group(options) DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group_name, client: @client ) end
@return [String]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 33 def name @name end
@example Request syntax with placeholder values
dbclusterparametergroup = db_cluster_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 cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the `Parameters` parameter.
@option options [Array<Types::Parameter>] :parameters
A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the `ResetAllParameters` parameter is enabled.
@return [DBClusterParameterGroup]
# File lib/aws-sdk-rds/db_cluster_parameter_group.rb, line 349 def reset(options = {}) options = options.merge(db_cluster_parameter_group_name: @name) resp = @client.reset_db_cluster_parameter_group(options) DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group_name, 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_cluster_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_cluster_parameter_group.rb, line 367 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