class Aws::RDS::OptionGroup
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/option_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
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value `true` indicates the option group can be applied to both VPC and non-VPC instances. @return [Boolean]
# File lib/aws-sdk-rds/option_group.rb, line 67 def allows_vpc_and_non_vpc_instance_memberships data[:allows_vpc_and_non_vpc_instance_memberships] end
@return [Client]
# File lib/aws-sdk-rds/option_group.rb, line 91 def client @client end
@example Request syntax with placeholder values
optiongroup = option_group.copy({ target_option_group_identifier: "String", # required target_option_group_description: "String", # required tags: [ { key: "String", value: "String", }, ], })
@param [Hash] options ({}) @option options [required, String] :target_option_group_identifier
The identifier for the copied option 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-option-group`
@option options [required, String] :target_option_group_description
The description for the copied option 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 [OptionGroup]
# File lib/aws-sdk-rds/option_group.rb, line 318 def copy(options = {}) options = options.merge(source_option_group_identifier: @name) resp = @client.copy_option_group(options) OptionGroup.new( name: resp.data.option_group.option_group_name, data: resp.data.option_group, client: @client ) end
@example Request syntax with placeholder values
optiongroup = option_group.create({ engine_name: "String", # required major_engine_version: "String", # required option_group_description: "String", # required tags: [ { key: "String", value: "String", }, ], })
@param [Hash] options ({}) @option options [required, String] :engine_name
Specifies the name of the engine that this option group should be associated with. Valid Values: * `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] :major_engine_version
Specifies the major version of the engine that this option group should be associated with.
@option options [required, String] :option_group_description
The description of the option group.
@option options [Array<Types::Tag>] :tags
Tags to assign to the option group.
@return [OptionGroup]
# File lib/aws-sdk-rds/option_group.rb, line 271 def create(options = {}) options = options.merge(option_group_name: @name) resp = @client.create_option_group(options) OptionGroup.new( name: resp.data.option_group.option_group_name, data: resp.data.option_group, client: @client ) end
@return [Types::OptionGroup]
Returns the data for this {OptionGroup}. Calls {Client#describe_option_groups} if {#data_loaded?} is `false`.
# File lib/aws-sdk-rds/option_group.rb, line 111 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/option_group.rb, line 119 def data_loaded? !!@data end
@example Request syntax with placeholder values
option_group.delete()
@param [Hash] options ({}) @return [EmptyStructure]
# File lib/aws-sdk-rds/option_group.rb, line 333 def delete(options = {}) options = options.merge(option_group_name: @name) resp = @client.delete_option_group(options) resp.data end
Indicates the name of the engine that this option group can be applied to. @return [String]
# File lib/aws-sdk-rds/option_group.rb, line 47 def engine_name data[:engine_name] end
@deprecated @api private
# File lib/aws-sdk-rds/option_group.rb, line 391 def identifiers { name: @name } end
Loads, or reloads {#data} for the current {OptionGroup}. Returns `self` making it possible to chain methods.
option_group.reload.data
@return [self]
# File lib/aws-sdk-rds/option_group.rb, line 101 def load resp = @client.describe_option_groups(option_group_name: @name) @data = resp.option_groups_list[0] self end
Indicates the major engine version associated with this option group. @return [String]
# File lib/aws-sdk-rds/option_group.rb, line 53 def major_engine_version data[:major_engine_version] end
@example Request syntax with placeholder values
optiongroup = option_group.modify({ options_to_include: [ { option_name: "String", # required port: 1, option_version: "String", db_security_group_memberships: ["String"], vpc_security_group_memberships: ["String"], option_settings: [ { name: "String", value: "String", default_value: "String", description: "String", apply_type: "String", data_type: "String", allowed_values: "String", is_modifiable: false, is_collection: false, }, ], }, ], options_to_remove: ["String"], apply_immediately: false, })
@param [Hash] options ({}) @option options [Array<Types::OptionConfiguration>] :options_to_include
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
@option options [Array<String>] :options_to_remove
Options in this list are removed from the option group.
@option options [Boolean] :apply_immediately
A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
@return [OptionGroup]
# File lib/aws-sdk-rds/option_group.rb, line 379 def modify(options = {}) options = options.merge(option_group_name: @name) resp = @client.modify_option_group(options) OptionGroup.new( name: resp.data.option_group.option_group_name, data: resp.data.option_group, client: @client ) end
@return [String]
# File lib/aws-sdk-rds/option_group.rb, line 33 def name @name end
The Amazon Resource
Name (ARN) for the option group. @return [String]
# File lib/aws-sdk-rds/option_group.rb, line 84 def option_group_arn data[:option_group_arn] end
Provides a description of the option group. @return [String]
# File lib/aws-sdk-rds/option_group.rb, line 40 def option_group_description data[:option_group_description] end
Indicates what options are available in the option group. @return [Array<Types::Option>]
# File lib/aws-sdk-rds/option_group.rb, line 59 def options data[:options] end
If AllowsVpcAndNonVpcInstanceMemberships is `false`, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is `true` and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field. @return [String]
# File lib/aws-sdk-rds/option_group.rb, line 78 def vpc_id data[:vpc_id] 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/option_group.rb, line 203 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/option_group.rb, line 398 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