Class: Aws::RDS::DBSubnetGroup
- Inherits:
-
Object
- Object
- Aws::RDS::DBSubnetGroup
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/db_subnet_group.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#db_subnet_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB subnet group.
-
#db_subnet_group_description ⇒ String
Provides the description of the DB subnet group.
- #name ⇒ String (also: #db_subnet_group_name)
-
#subnet_group_status ⇒ String
Provides the status of the DB subnet group.
-
#subnets ⇒ Array<Types::Subnet>
Contains a list of Subnet elements.
-
#vpc_id ⇒ String
Provides the VpcId of the DB subnet group.
Actions collapse
- #create(options = {}) ⇒ DBSubnetGroup
- #delete(options = {}) ⇒ EmptyStructure
- #identifiers ⇒ Object deprecated private Deprecated.
- #modify(options = {}) ⇒ DBSubnetGroup
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::DBSubnetGroup
Returns the data for this DBSubnetGroup.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ DBSubnetGroup
constructor
A new instance of DBSubnetGroup.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBSubnetGroup.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(name, options = {}) ⇒ DBSubnetGroup #initialize(options = {}) ⇒ DBSubnetGroup
Returns a new instance of DBSubnetGroup.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/db_subnet_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
#client ⇒ Client
67 68 69 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 67 def client @client end |
#create(options = {}) ⇒ DBSubnetGroup
221 222 223 224 225 226 227 228 229 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 221 def create( = {}) = .merge(db_subnet_group_name: @name) resp = @client.create_db_subnet_group() 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`.
87 88 89 90 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 87 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
95 96 97 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 95 def data_loaded? !!@data end |
#db_subnet_group_arn ⇒ String
The Amazon Resource Name (ARN) for the DB subnet group.
60 61 62 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 60 def db_subnet_group_arn data[:db_subnet_group_arn] end |
#db_subnet_group_description ⇒ String
Provides the description of the DB subnet group.
36 37 38 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 36 def db_subnet_group_description data[:db_subnet_group_description] end |
#delete(options = {}) ⇒ EmptyStructure
236 237 238 239 240 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 236 def delete( = {}) = .merge(db_subnet_group_name: @name) resp = @client.delete_db_subnet_group() resp.data 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.
266 267 268 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 266 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
77 78 79 80 81 |
# File '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
254 255 256 257 258 259 260 261 262 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 254 def modify( = {}) = .merge(db_subnet_group_name: @name) resp = @client.modify_db_subnet_group() 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
29 30 31 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 29 def name @name end |
#subnet_group_status ⇒ String
Provides the status of the DB subnet group.
48 49 50 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 48 def subnet_group_status data[:subnet_group_status] end |
#subnets ⇒ Array<Types::Subnet>
Contains a list of Subnet elements.
54 55 56 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 54 def subnets data[:subnets] end |
#vpc_id ⇒ String
Provides the VpcId of the DB subnet group.
42 43 44 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 42 def vpc_id data[:vpc_id] end |
#wait_until(options = {}, &block) ⇒ Resource
Use [Aws::RDS::Client] #wait_until instead
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() {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
## 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
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/aws-sdk-rds/db_subnet_group.rb', line 177 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |