Class: Aws::EC2::RouteTable
- Inherits:
-
Object
- Object
- Aws::EC2::RouteTable
- Extended by:
- Deprecations
- Defined in:
- 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 AWS 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
Associations collapse
- #associations ⇒ RouteTableAssociation::Collection
- #identifiers ⇒ Object deprecated private Deprecated.
- #routes ⇒ Route::Collection
- #vpc ⇒ Vpc?
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 = {}, &block) ⇒ 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.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#associate_with_subnet(options = {}) ⇒ RouteTableAssociation
205 206 207 208 209 210 211 212 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 205 def associate_with_subnet( = {}) = .merge(route_table_id: @id) resp = @client.associate_route_table() RouteTableAssociation.new( id: resp.data.association_id, client: @client ) end |
#associations ⇒ RouteTableAssociation::Collection
326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 326 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 |
#create_route(options = {}) ⇒ Route
258 259 260 261 262 263 264 265 266 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 258 def create_route( = {}) = .merge(route_table_id: @id) resp = @client.create_route() Route.new( route_table_id: @id, destination_cidr_block: [:destination_cidr_block], client: @client ) end |
#create_tags(options = {}) ⇒ Tag::Collection
290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 290 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = @client.() [: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`.
81 82 83 84 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 81 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
89 90 91 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 89 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
317 318 319 320 321 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 317 def delete( = {}) = .merge(route_table_id: @id) resp = @client.delete_route_table() resp.data end |
#id ⇒ String Also known as: route_table_id
29 30 31 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 29 def id @id 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.
366 367 368 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 366 def identifiers { 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
71 72 73 74 75 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 71 def load resp = @client.describe_route_tables(route_table_ids: [@id]) @data = resp.route_tables[0] self end |
#owner_id ⇒ String
The ID of the AWS account that owns the route table.
54 55 56 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 54 def owner_id data[:owner_id] end |
#propagating_vgws ⇒ Array<Types::PropagatingVgw>
Any virtual private gateway (VGW) propagating routes.
36 37 38 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 36 def propagating_vgws data[:propagating_vgws] end |
#routes ⇒ Route::Collection
339 340 341 342 343 344 345 346 347 348 349 350 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 339 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.
42 43 44 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 42 def data[:tags] end |
#vpc ⇒ Vpc?
353 354 355 356 357 358 359 360 361 362 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 353 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.
48 49 50 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 48 def vpc_id data[:vpc_id] end |
#wait_until(options = {}, &block) ⇒ 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) {|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
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/aws-sdk-ec2/route_table.rb', line 171 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 |