You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::RouteTable

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ RouteTable #initialize(options = {}) ⇒ RouteTable

Returns a new instance of RouteTable

Overloads:

  • #initialize(id, options = {}) ⇒ RouteTable

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ RouteTable

    Options Hash (options):

    • :id (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#associate_with_subnet(options = {}) ⇒ RouteTableAssociation

Examples:

Request syntax with placeholder values


routetableassociation = route_table.associate_with_subnet({
  dry_run: false,
  subnet_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :subnet_id (required, String)

    The ID of the subnet.

Returns:



199
200
201
202
203
204
205
206
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 199

def associate_with_subnet(options = {})
  options = options.merge(route_table_id: @id)
  resp = @client.associate_route_table(options)
  RouteTableAssociation.new(
    id: resp.data.association_id,
    client: @client
  )
end

#associationsRouteTableAssociation::Collection



317
318
319
320
321
322
323
324
325
326
327
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 317

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

#clientClient

Returns:



55
56
57
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 55

def client
  @client
end

#create_route(options = {}) ⇒ Route

Examples:

Request syntax with placeholder values


route = route_table.create_route({
  destination_cidr_block: "String",
  destination_ipv_6_cidr_block: "String",
  dry_run: false,
  egress_only_internet_gateway_id: "String",
  gateway_id: "String",
  instance_id: "String",
  nat_gateway_id: "String",
  network_interface_id: "String",
  vpc_peering_connection_id: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :destination_cidr_block (String)

    The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.

  • :destination_ipv_6_cidr_block (String)

    The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

  • :dry_run (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :egress_only_internet_gateway_id (String)

    [IPv6 traffic only] The ID of an egress-only Internet gateway.

  • :gateway_id (String)

    The ID of an Internet gateway or virtual private gateway attached to your VPC.

  • :instance_id (String)

    The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

  • :nat_gateway_id (String)

    [IPv4 traffic only] The ID of a NAT gateway.

  • :network_interface_id (String)

    The ID of a network interface.

  • :vpc_peering_connection_id (String)

    The ID of a VPC peering connection.

Returns:



249
250
251
252
253
254
255
256
257
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 249

def create_route(options = {})
  options = options.merge(route_table_id: @id)
  resp = @client.create_route(options)
  Route.new(
    route_table_id: @id,
    destination_cidr_block: options[:destination_cidr_block],
    client: @client
  )
end

#create_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tag = route_table.create_tags({
  dry_run: false,
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :tags (required, Array<Types::Tag>)

    One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 281

def create_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = @client.create_tags(options)
  options[: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

#dataTypes::RouteTable

Returns the data for this Aws::EC2::RouteTable. Calls Client#describe_route_tables if #data_loaded? is false.

Returns:



75
76
77
78
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 75

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.



83
84
85
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 83

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


route_table.delete({
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (EmptyStructure)


308
309
310
311
312
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 308

def delete(options = {})
  options = options.merge(route_table_id: @id)
  resp = @client.delete_route_table(options)
  resp.data
end

#idString Also known as: route_table_id

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 29

def id
  @id
end

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

Returns:

  • (self)


65
66
67
68
69
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 65

def load
  resp = @client.describe_route_tables(route_table_ids: [@id])
  @data = resp.route_tables[0]
  self
end

#propagating_vgwsArray<Types::PropagatingVgw>

Any virtual private gateway (VGW) propagating routes.

Returns:



36
37
38
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 36

def propagating_vgws
  data[:propagating_vgws]
end

#routesRoute::Collection

Returns:



330
331
332
333
334
335
336
337
338
339
340
341
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 330

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

#tagsArray<Types::Tag>

Any tags assigned to the route table.

Returns:



42
43
44
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 42

def tags
  data[:tags]
end

#vpcVpc?

Returns:



344
345
346
347
348
349
350
351
352
353
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 344

def vpc
  if data[:vpc_id]
    Vpc.new(
      id: data[:vpc_id],
      client: @client
    )
  else
    nil
  end
end

#vpc_idString

The ID of the VPC.

Returns:

  • (String)


48
49
50
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 48

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::EC2::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) {|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

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

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 165

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