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

Class: Aws::RDS::DBSubnetGroup

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

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

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

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

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#db_subnet_group_arnString (readonly)

The Amazon Resource Name (ARN) for the DB subnet group.

Returns:

  • (String)

    The Amazon Resource Name (ARN) for the DB subnet group.

#db_subnet_group_descriptionString (readonly)

Provides the description of the DB subnet group.

Returns:

  • (String)

    Provides the description of the DB subnet group.

#db_subnet_group_nameString (readonly)

The name of the DB subnet group.

Returns:

  • (String)

    The name of the DB subnet group.

#nameString (readonly)

Returns:

  • (String)

#subnet_group_statusString (readonly)

Provides the status of the DB subnet group.

Returns:

  • (String)

    Provides the status of the DB subnet group.

#subnetsArray<Types::Subnet> (readonly)

Contains a list of Subnet elements.

Returns:

#vpc_idString (readonly)

Provides the VpcId of the DB subnet group.

Returns:

  • (String)

    Provides the VpcId of the DB subnet group.

Instance Method Details

#create(options = {}) ⇒ DBSubnetGroup

Examples:

Request syntax example with placeholder values


dbsubnetgroup.create({
  db_subnet_group_description: "String", # required
  subnet_ids: ["String"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Basic usage

dbsubnetgroup = dbsubnetgroup.create(options)
dbsubnetgroup.name
#=> "dbsubnetgroup-name"

Options Hash (options):

  • :db_subnet_group_description (required, String)

    The description for the DB subnet group.

  • :subnet_ids (required, Array<String>)

    The EC2 Subnet IDs for the DB subnet group.

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

    A list of tags.

Returns:

See Also:

#deleteStruct

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

Examples:

Request syntax example with placeholder values


dbsubnetgroup.delete()

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#modify(options = {}) ⇒ DBSubnetGroup

Examples:

Request syntax example with placeholder values


dbsubnetgroup.modify({
  db_subnet_group_description: "String",
  subnet_ids: ["String"], # required
})

Basic usage

dbsubnetgroup = dbsubnetgroup.modify(options)
dbsubnetgroup.name
#=> "dbsubnetgroup-name"

Options Hash (options):

  • :db_subnet_group_description (String)

    The description for the DB subnet group.

  • :subnet_ids (required, Array<String>)

    The EC2 subnet IDs for the DB subnet group.

Returns:

See Also: