Class: Aws::RDS::OptionGroup
- Inherits:
-
Object
- Object
- Aws::RDS::OptionGroup
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/option_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#allows_vpc_and_non_vpc_instance_memberships ⇒ Boolean
Indicates whether this option group can be applied to both VPC and non-VPC instances.
-
#engine_name ⇒ String
Indicates the name of the engine that this option group can be applied to.
-
#major_engine_version ⇒ String
Indicates the major engine version associated with this option group.
- #name ⇒ String (also: #option_group_name)
-
#option_group_arn ⇒ String
The Amazon Resource Name (ARN) for the option group.
-
#option_group_description ⇒ String
Provides a description of the option group.
-
#options ⇒ Array<Types::Option>
Indicates what options are available in the option group.
-
#vpc_id ⇒ String
If AllowsVpcAndNonVpcInstanceMemberships is ‘false`, this field is blank.
Actions collapse
- #copy(options = {}) ⇒ OptionGroup
- #create(options = {}) ⇒ OptionGroup
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
- #modify(options = {}) ⇒ OptionGroup
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::OptionGroup
Returns the data for this OptionGroup.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ OptionGroup
constructor
A new instance of OptionGroup.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current OptionGroup.
Constructor Details
#initialize(name, options = {}) ⇒ OptionGroup #initialize(options = {}) ⇒ OptionGroup
Returns a new instance of OptionGroup.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/option_group.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() 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.
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 |
#copy(options = {}) ⇒ OptionGroup
188 189 190 191 192 193 194 195 196 |
# File 'lib/aws-sdk-rds/option_group.rb', line 188 def copy( = {}) = .merge(source_option_group_identifier: @name) resp = @client.copy_option_group() OptionGroup.new( name: resp.data.option_group.option_group_name, data: resp.data.option_group, client: @client ) end |
#create(options = {}) ⇒ OptionGroup
146 147 148 149 150 151 152 153 154 |
# File 'lib/aws-sdk-rds/option_group.rb', line 146 def create( = {}) = .merge(option_group_name: @name) resp = @client.create_option_group() 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`.
107 108 109 110 |
# File 'lib/aws-sdk-rds/option_group.rb', line 107 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
115 116 117 |
# File 'lib/aws-sdk-rds/option_group.rb', line 115 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
203 204 205 206 207 |
# File 'lib/aws-sdk-rds/option_group.rb', line 203 def delete( = {}) = .merge(option_group_name: @name) resp = @client.delete_option_group() resp.data end |
#engine_name ⇒ String
Indicates the name of the engine that this option group can be applied to.
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.
261 262 263 |
# File 'lib/aws-sdk-rds/option_group.rb', line 261 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
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.
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
249 250 251 252 253 254 255 256 257 |
# File 'lib/aws-sdk-rds/option_group.rb', line 249 def modify( = {}) = .merge(option_group_name: @name) resp = @client.modify_option_group() 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
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.
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.
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.
55 56 57 |
# File 'lib/aws-sdk-rds/option_group.rb', line 55 def data. 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.
74 75 76 |
# File 'lib/aws-sdk-rds/option_group.rb', line 74 def vpc_id data.vpc_id end |