Class: Aws::EC2::RouteTable
- Inherits:
-
Object
- Object
- Aws::EC2::RouteTable
- Defined in:
- gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#id ⇒ String
(also: #route_table_id)
-
#owner_id ⇒ String
The ID of the Amazon Web Services account that owns the route table.
-
#propagating_vgws ⇒ Array<Types::PropagatingVgw>
Any virtual private gateway (VGW) propagating routes.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the route table.
-
#vpc_id ⇒ String
The ID of the VPC.
Actions collapse
-
#associate_with_subnet(options = {}) ⇒ RouteTableAssociation
-
#create_route(options = {}) ⇒ Route
-
#create_tags(options = {}) ⇒ Tag::Collection
-
#delete(options = {}) ⇒ EmptyStructure
-
#delete_tags(options = {}) ⇒ Tag::Collection
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::RouteTable
Returns the data for this RouteTable.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ RouteTable
constructor
A new instance of RouteTable.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current RouteTable.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ RouteTable #initialize(options = {}) ⇒ RouteTable
Returns a new instance of RouteTable.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#associate_with_subnet(options = {}) ⇒ RouteTableAssociation
222 223 224 225 226 227 228 229 230 231 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 222 def associate_with_subnet( = {}) = .merge(route_table_id: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.associate_route_table() end RouteTableAssociation.new( id: resp.data.association_id, client: @client ) end |
#associations ⇒ RouteTableAssociation::Collection
422 423 424 425 426 427 428 429 430 431 432 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 422 def associations batch = [] data[:associations].each do |d| batch << RouteTableAssociation.new( id: d[:route_table_association_id], data: d, client: @client ) end RouteTableAssociation::Collection.new([batch], size: batch.size) end |
#client ⇒ Client
65 66 67 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 65 def client @client end |
#create_route(options = {}) ⇒ Route
301 302 303 304 305 306 307 308 309 310 311 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 301 def create_route( = {}) = .merge(route_table_id: @id) Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_route() end Route.new( route_table_id: @id, destination_cidr_block: [:destination_cidr_block], client: @client ) end |
#create_tags(options = {}) ⇒ Tag::Collection
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 335 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.() end [:tags].each do |t| batch << Tag.new( resource_id: @id, key: t[:key], value: t[:value], client: @client ) end Tag::Collection.new([batch], size: batch.size) end |
#data ⇒ Types::RouteTable
Returns the data for this Aws::EC2::RouteTable. Calls
Client#describe_route_tables if #data_loaded? is false
.
87 88 89 90 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 87 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
95 96 97 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 95 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
411 412 413 414 415 416 417 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 411 def delete( = {}) = .merge(route_table_id: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.delete_route_table() end resp.data end |
#delete_tags(options = {}) ⇒ Tag::Collection
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 382 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.() end [:tags].each do |t| batch << Tag.new( resource_id: @id, key: t[:key], value: t[:value], client: @client ) end Tag::Collection.new([batch], size: batch.size) end |
#id ⇒ String Also known as: route_table_id
33 34 35 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 33 def id @id end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::RouteTable.
Returns self
making it possible to chain methods.
route_table.reload.data
75 76 77 78 79 80 81 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 75 def load resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.describe_route_tables(route_table_ids: [@id]) end @data = resp.route_tables[0] self end |
#owner_id ⇒ String
The ID of the Amazon Web Services account that owns the route table.
58 59 60 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 58 def owner_id data[:owner_id] end |
#propagating_vgws ⇒ Array<Types::PropagatingVgw>
Any virtual private gateway (VGW) propagating routes.
40 41 42 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 40 def propagating_vgws data[:propagating_vgws] end |
#routes ⇒ Route::Collection
435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 435 def routes batch = [] data[:routes].each do |d| batch << Route.new( route_table_id: @id, destination_cidr_block: d[:destination_cidr_block], data: d, client: @client ) end Route::Collection.new([batch], size: batch.size) end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the route table.
46 47 48 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 46 def data[:tags] end |
#vpc ⇒ Vpc?
449 450 451 452 453 454 455 456 457 458 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 449 def vpc if data[:vpc_id] Vpc.new( id: data[:vpc_id], client: @client ) else nil end end |
#vpc_id ⇒ String
The ID of the VPC.
52 53 54 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 52 def vpc_id data[:vpc_id] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::EC2::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) 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
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 179 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::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |