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

Class: Aws::RDS::DBSubnetGroup

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

Defined Under Namespace

Classes: Collection

Actions collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DBSubnetGroup

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBSubnetGroup

    Options Hash (options):

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


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

#clientClient

Returns:



67
68
69
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 67

def client
  @client
end

#create(options = {}) ⇒ DBSubnetGroup

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

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:



121
122
123
124
125
126
127
128
129
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 121

def create(options = {})
  options = options.merge(db_subnet_group_name: @name)
  resp = @client.create_db_subnet_group(options)
  DBSubnetGroup.new(
    name: resp.data.db_subnet_group.db_subnet_group_name,
    data: resp.data.db_subnet_group,
    client: @client
  )
end

#dataTypes::DBSubnetGroup

Returns the data for this Aws::RDS::DBSubnetGroup. Calls Client#describe_db_subnet_groups if #data_loaded? is false.

Returns:



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

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.



95
96
97
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 95

def data_loaded?
  !!@data
end

#db_subnet_group_arnString

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

Returns:

  • (String)


60
61
62
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 60

def db_subnet_group_arn
  data.db_subnet_group_arn
end

#db_subnet_group_descriptionString

Provides the description of the DB subnet group.

Returns:

  • (String)


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

def db_subnet_group_description
  data.db_subnet_group_description
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


db_subnet_group.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure)


136
137
138
139
140
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 136

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

#loadself Also known as: reload

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

db_subnet_group.reload.data

Returns:

  • (self)


77
78
79
80
81
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 77

def load
  resp = @client.describe_db_subnet_groups(db_subnet_group_name: @name)
  @data = resp.db_subnet_groups[0]
  self
end

#modify(options = {}) ⇒ DBSubnetGroup

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

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:



154
155
156
157
158
159
160
161
162
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 154

def modify(options = {})
  options = options.merge(db_subnet_group_name: @name)
  resp = @client.modify_db_subnet_group(options)
  DBSubnetGroup.new(
    name: resp.data.db_subnet_group.db_subnet_group_name,
    data: resp.data.db_subnet_group,
    client: @client
  )
end

#nameString Also known as: db_subnet_group_name

Returns:

  • (String)


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

def name
  @name
end

#subnet_group_statusString

Provides the status of the DB subnet group.

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 48

def subnet_group_status
  data.subnet_group_status
end

#subnetsArray<Types::Subnet>

Contains a list of Subnet elements.

Returns:



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

def subnets
  data.subnets
end

#vpc_idString

Provides the VpcId of the DB subnet group.

Returns:

  • (String)


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

def vpc_id
  data.vpc_id
end