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

Read-Only Attributes collapse

Actions 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) 


22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 22

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)
  @waiter_block_warned = false
end

Instance Method Details

#client ⇒ Client

Returns:



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

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>) —

    Tags to assign to the DB subnet group.

Returns:



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

def create(options = {})
  options = options.merge(db_subnet_group_name: @name)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.create_db_subnet_group(options)
  end
  DBSubnetGroup.new(
    name: resp.data.db_subnet_group.db_subnet_group_name,
    data: resp.data.db_subnet_group,
    client: @client
  )
end

#data ⇒ Types::DBSubnetGroup

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

Returns:



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

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.



123
124
125
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 123

def data_loaded?
  !!@data
end

#db_subnet_group_arn ⇒ String

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

Returns:

  • (String) 


64
65
66
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 64

def db_subnet_group_arn
  data[:db_subnet_group_arn]
end

#db_subnet_group_description ⇒ String

Provides the description of the DB subnet group.

Returns:

  • (String) 


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

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) 


265
266
267
268
269
270
271
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 265

def delete(options = {})
  options = options.merge(db_subnet_group_name: @name)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.delete_db_subnet_group(options)
  end
  resp.data
end

#load ⇒ self 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) 


103
104
105
106
107
108
109
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 103

def load
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.describe_db_subnet_groups(db_subnet_group_name: @name)
  end
  @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:



285
286
287
288
289
290
291
292
293
294
295
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 285

def modify(options = {})
  options = options.merge(db_subnet_group_name: @name)
  resp = Aws::Plugins::UserAgent.feature('resource') do
    @client.modify_db_subnet_group(options)
  end
  DBSubnetGroup.new(
    name: resp.data.db_subnet_group.db_subnet_group_name,
    data: resp.data.db_subnet_group,
    client: @client
  )
end

#name ⇒ String Also known as: db_subnet_group_name

Returns:

  • (String) 


33
34
35
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 33

def name
  @name
end

#subnet_group_status ⇒ String

Provides the status of the DB subnet group.

Returns:

  • (String) 


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

def subnet_group_status
  data[:subnet_group_status]
end

#subnets ⇒ Array<Types::Subnet>

Contains a list of Subnet elements.

Returns:



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

def subnets
  data[:subnets]
end

#supported_network_types ⇒ Array<String>

The network type of the DB subnet group.

Valid values:

  • IPV4

  • DUAL

A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Returns:

  • (Array<String>) 


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

def supported_network_types
  data[:supported_network_types]
end

#vpc_id ⇒ String

Provides the VpcId of the DB subnet group.

Returns:

  • (String) 


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

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}) {|resource| ... } ⇒ 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) do |instance|
  instance.state.name == 'running'
end

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

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_subnet_group.rb', line 207

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::Plugins::UserAgent.feature('resource') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end