Class: Aws::RDS::DBSubnetGroup

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
sig/db_subnet_group.rbs,
lib/aws-sdk-rds/db_subnet_group.rb

Overview

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/DBSubnetGroup.html

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) 


13
14
15
 
# File 'sig/db_subnet_group.rbs', line 13

def initialize: (String name, Hash[Symbol, untyped] options) -> void
| (name: String, ?client: Client) -> void
| (Hash[Symbol, untyped] args) -> void

Instance Method Details

#client ⇒ Client

Returns:



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

def client: () -> Client

#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:



53
 
# File 'sig/db_subnet_group.rbs', line 53

def create: (

#data ⇒ Types::DBSubnetGroup

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

Returns:



46
 
# File 'sig/db_subnet_group.rbs', line 46

def data: () -> Types::DBSubnetGroup

#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.



49
 
# File 'sig/db_subnet_group.rbs', line 49

def data_loaded?: () -> bool

#db_subnet_group_arn ⇒ String

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

Returns:

  • (String) 


34
 
# File 'sig/db_subnet_group.rbs', line 34

def db_subnet_group_arn: () -> ::String

#db_subnet_group_description ⇒ String

Provides the description of the DB subnet group.

Returns:

  • (String) 


22
 
# File 'sig/db_subnet_group.rbs', line 22

def db_subnet_group_description: () -> ::String

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


db_subnet_group.delete()

Parameters:

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

    ({})

Returns:

  • (EmptyStructure) 


66
 
# File 'sig/db_subnet_group.rbs', line 66

def delete: (

#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.

Deprecated. 


302
303
304
 
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 302

def identifiers
  { name: @name }
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) 


42
 
# File 'sig/db_subnet_group.rbs', line 42

def load: () -> self

#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:



71
 
# File 'sig/db_subnet_group.rbs', line 71

def modify: (

#name ⇒ String Also known as: db_subnet_group_name

Returns:

  • (String) 


18
 
# File 'sig/db_subnet_group.rbs', line 18

def name: () -> String

#subnet_group_status ⇒ String

Provides the status of the DB subnet group.

Returns:

  • (String) 


28
 
# File 'sig/db_subnet_group.rbs', line 28

def subnet_group_status: () -> ::String

#subnets ⇒ Array<Types::Subnet>

Contains a list of Subnet elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.

Returns:



31
 
# File 'sig/db_subnet_group.rbs', line 31

def subnets: () -> ::Array[Types::Subnet]

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


37
 
# File 'sig/db_subnet_group.rbs', line 37

def supported_network_types: () -> ::Array[::String]

#vpc_id ⇒ String

Provides the VpcId of the DB subnet group.

Returns:

  • (String) 


25
 
# File 'sig/db_subnet_group.rbs', line 25

def vpc_id: () -> ::String

#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



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

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.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end