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

Class: Aws::RDS::OptionGroup

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes 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 'gems/aws-sdk-rds/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_membershipsBoolean

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 'gems/aws-sdk-rds/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

#clientClient

Returns:



87
88
89
# File 'gems/aws-sdk-rds/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:

    • 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-option-group

  • :target_option_group_description (required, String)

    The description for the copied option group.

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

    A list of tags.

Returns:



188
189
190
191
192
193
194
195
196
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group.rb', line 188

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.

Returns:



146
147
148
149
150
151
152
153
154
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group.rb', line 146

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

#dataTypes::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 'gems/aws-sdk-rds/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 'gems/aws-sdk-rds/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)


203
204
205
206
207
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group.rb', line 203

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

#engine_nameString

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

Returns:

  • (String)


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

def engine_name
  data.engine_name
end

#loadself 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 'gems/aws-sdk-rds/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_versionString

Indicates the major engine version associated with this option group.

Returns:

  • (String)


49
50
51
# File 'gems/aws-sdk-rds/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:



249
250
251
252
253
254
255
256
257
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group.rb', line 249

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

#nameString Also known as: option_group_name

Returns:

  • (String)


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

def name
  @name
end

#option_group_arnString

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

Returns:

  • (String)


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

def option_group_arn
  data.option_group_arn
end

#option_group_descriptionString

Provides a description of the option group.

Returns:

  • (String)


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

def option_group_description
  data.option_group_description
end

#optionsArray<Types::Option>

Indicates what options are available in the option group.

Returns:



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

def options
  data.options
end

#vpc_idString

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 'gems/aws-sdk-rds/lib/aws-sdk-rds/option_group.rb', line 74

def vpc_id
  data.vpc_id
end