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

Read-Only Attributes collapse

Actions collapse

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


22
23
24
25
26
27
28
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 22

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)
  @waiter_block_warned = false
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: "SubnetId",
  gateway_id: "RouteGatewayId",
})

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 (String)

    The ID of the subnet.

  • :gateway_id (String)

    The ID of the internet gateway or virtual private gateway.

Returns:



214
215
216
217
218
219
220
221
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 214

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



392
393
394
395
396
397
398
399
400
401
402
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 392

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:



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

Examples:

Request syntax with placeholder values


route = route_table.create_route({
  destination_cidr_block: "String",
  destination_ipv_6_cidr_block: "String",
  destination_prefix_list_id: "PrefixListResourceId",
  dry_run: false,
  egress_only_internet_gateway_id: "EgressOnlyInternetGatewayId",
  gateway_id: "RouteGatewayId",
  instance_id: "InstanceId",
  nat_gateway_id: "NatGatewayId",
  transit_gateway_id: "TransitGatewayId",
  local_gateway_id: "LocalGatewayId",
  carrier_gateway_id: "CarrierGatewayId",
  network_interface_id: "NetworkInterfaceId",
  vpc_peering_connection_id: "VpcPeeringConnectionId",
})

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. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

  • :destination_ipv_6_cidr_block (String)

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

  • :destination_prefix_list_id (String)

    The ID of a prefix list used for the destination 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.

  • :transit_gateway_id (String)

    The ID of a transit gateway.

  • :local_gateway_id (String)

    The ID of the local gateway.

  • :carrier_gateway_id (String)

    The ID of the carrier gateway.

    You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

  • :network_interface_id (String)

    The ID of a network interface.

  • :vpc_peering_connection_id (String)

    The ID of a VPC peering connection.

Returns:



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

def create_route(options = {})
  options = options.merge(route_table_id: @id)
  @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>)

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



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

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:



85
86
87
88
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 85

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.



93
94
95
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 93

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)


383
384
385
386
387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 383

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

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

Examples:

Request syntax with placeholder values


tag = route_table.delete_tags({
  dry_run: false,
  tags: [
    {
      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 (Array<Types::Tag>)

    The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

    If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix).

Returns:



356
357
358
359
360
361
362
363
364
365
366
367
368
369
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 356

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

#idString Also known as: route_table_id

Returns:

  • (String)


33
34
35
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 33

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)


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

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

#owner_idString

The ID of the AWS account that owns the route table.

Returns:

  • (String)


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_vgwsArray<Types::PropagatingVgw>

Any virtual private gateway (VGW) propagating routes.

Returns:



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

def propagating_vgws
  data[:propagating_vgws]
end

#routesRoute::Collection

Returns:



405
406
407
408
409
410
411
412
413
414
415
416
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 405

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:



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

def tags
  data[:tags]
end

#vpcVpc?

Returns:



419
420
421
422
423
424
425
426
427
428
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 419

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)


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

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/route_table.rb', line 177

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