Class: Aws::RDS::OptionGroup

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of OptionGroup.

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ OptionGroup

    Options Hash (options):

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


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

#allows_vpc_and_non_vpc_instance_memberships ⇒ Boolean

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.

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/aws-sdk-rds/option_group.rb', line 63

def allows_vpc_and_non_vpc_instance_memberships
  data[:allows_vpc_and_non_vpc_instance_memberships]
end

#client ⇒ Client

Returns:



87
88
89
 
# File 'lib/aws-sdk-rds/option_group.rb', line 87

def client
  @client
end

#copy(options = {}) ⇒ OptionGroup

Examples:

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",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :target_option_group_identifier (required, String) —

    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`

  • :target_option_group_description (required, String) —

    The description for the copied option group.

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

    A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

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

Returns:



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

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

#create(options = {}) ⇒ OptionGroup

Examples:

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",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :engine_name (required, String) —

    Specifies the name of the engine that this option group should be associated with.

  • :major_engine_version (required, String) —

    Specifies the major version of the engine that this option group should be associated with.

  • :option_group_description (required, String) —

    The description of the option group.

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

    A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

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

Returns:



246
247
248
249
250
251
252
253
254
 
# File 'lib/aws-sdk-rds/option_group.rb', line 246

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

#data ⇒ Types::OptionGroup

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

Returns:



107
108
109
110
 
# File 'lib/aws-sdk-rds/option_group.rb', line 107

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.



115
116
117
 
# File 'lib/aws-sdk-rds/option_group.rb', line 115

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


option_group.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


308
309
310
311
312
 
# File 'lib/aws-sdk-rds/option_group.rb', line 308

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

#engine_name ⇒ String

Indicates the name of the engine that this option group can be applied to.

Returns:

  • (String) 


43
44
45
 
# File 'lib/aws-sdk-rds/option_group.rb', line 43

def engine_name
  data[:engine_name]
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. 


366
367
368
 
# File 'lib/aws-sdk-rds/option_group.rb', line 366

def identifiers
  { name: @name }
end

#load ⇒ self Also known as: reload

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

option_group.reload.data

Returns:

  • (self) 


97
98
99
100
101
 
# File 'lib/aws-sdk-rds/option_group.rb', line 97

def load
  resp = @client.describe_option_groups(option_group_name: @name)
  @data = resp.option_groups_list[0]
  self
end

#major_engine_version ⇒ String

Indicates the major engine version associated with this option group.

Returns:

  • (String) 


49
50
51
 
# File 'lib/aws-sdk-rds/option_group.rb', line 49

def major_engine_version
  data[:major_engine_version]
end

#modify(options = {}) ⇒ OptionGroup

Examples:

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

Parameters:

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

    ({})

Options Hash (options):

  • :options_to_include (Array<Types::OptionConfiguration>) —

    Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

  • :options_to_remove (Array<String>) —

    Options in this list are removed from the option group.

  • :apply_immediately (Boolean) —

    Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

Returns:



354
355
356
357
358
359
360
361
362
 
# File 'lib/aws-sdk-rds/option_group.rb', line 354

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

#name ⇒ String Also known as: option_group_name

Returns:

  • (String) 


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

def name
  @name
end

#option_group_arn ⇒ String

The Amazon Resource Name (ARN) for the option group.

Returns:

  • (String) 


80
81
82
 
# File 'lib/aws-sdk-rds/option_group.rb', line 80

def option_group_arn
  data[:option_group_arn]
end

#option_group_description ⇒ String

Provides a description of the option group.

Returns:

  • (String) 


36
37
38
 
# File 'lib/aws-sdk-rds/option_group.rb', line 36

def option_group_description
  data[:option_group_description]
end

#options ⇒ Array<Types::Option>

Indicates what options are available in the option group.

Returns:



55
56
57
 
# File 'lib/aws-sdk-rds/option_group.rb', line 55

def options
  data[:options]
end

#vpc_id ⇒ String

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.

Returns:

  • (String) 


74
75
76
 
# File 'lib/aws-sdk-rds/option_group.rb', line 74

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}, &block) ⇒ 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) {|instance| instance.state.name == 'running' }

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

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/aws-sdk-rds/option_group.rb', line 197

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