Class: Aws::EC2::Route
- Inherits:
-
Object
- Object
- Aws::EC2::Route
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-ec2/route.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #destination_cidr_block ⇒ String
-
#destination_ipv_6_cidr_block ⇒ String
The IPv6 CIDR block used for the destination match.
-
#destination_prefix_list_id ⇒ String
The prefix of the AWS service.
-
#egress_only_internet_gateway_id ⇒ String
The ID of the egress-only internet gateway.
-
#gateway_id ⇒ String
The ID of a gateway attached to your VPC.
-
#instance_id ⇒ String
The ID of a NAT instance in your VPC.
-
#instance_owner_id ⇒ String
The AWS account ID of the owner of the instance.
-
#nat_gateway_id ⇒ String
The ID of a NAT gateway.
-
#network_interface_id ⇒ String
The ID of the network interface.
-
#origin ⇒ String
Describes how the route was created.
- #route_table_id ⇒ String
-
#state ⇒ String
The state of the route.
-
#transit_gateway_id ⇒ String
The ID of a transit gateway.
-
#vpc_peering_connection_id ⇒ String
The ID of a VPC peering connection.
Actions collapse
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #route_table ⇒ RouteTable
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::Route
Returns the data for this Route.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ Route
constructor
A new instance of Route.
- #load ⇒ Object (also: #reload) private
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
Constructor Details
#initialize(route_table_id, destination_cidr_block, options = {}) ⇒ Route #initialize(options = {}) ⇒ Route
Returns a new instance of Route.
21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-ec2/route.rb', line 21 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @route_table_id = extract_route_table_id(args, ) @destination_cidr_block = extract_destination_cidr_block(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#data ⇒ Types::Route
Returns the data for this Aws::EC2::Route.
142 143 144 145 |
# File 'lib/aws-sdk-ec2/route.rb', line 142 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
150 151 152 |
# File 'lib/aws-sdk-ec2/route.rb', line 150 def data_loaded? !!@data end |
#delete(options = {}) ⇒ EmptyStructure
267 268 269 270 271 272 273 274 |
# File 'lib/aws-sdk-ec2/route.rb', line 267 def delete( = {}) = .merge( route_table_id: @route_table_id, destination_cidr_block: @destination_cidr_block ) resp = @client.delete_route() resp.data end |
#destination_cidr_block ⇒ String
37 38 39 |
# File 'lib/aws-sdk-ec2/route.rb', line 37 def destination_cidr_block @destination_cidr_block end |
#destination_ipv_6_cidr_block ⇒ String
The IPv6 CIDR block used for the destination match.
43 44 45 |
# File 'lib/aws-sdk-ec2/route.rb', line 43 def destination_ipv_6_cidr_block data[:destination_ipv_6_cidr_block] end |
#destination_prefix_list_id ⇒ String
The prefix of the AWS service.
49 50 51 |
# File 'lib/aws-sdk-ec2/route.rb', line 49 def destination_prefix_list_id data[:destination_prefix_list_id] end |
#egress_only_internet_gateway_id ⇒ String
The ID of the egress-only internet gateway.
55 56 57 |
# File 'lib/aws-sdk-ec2/route.rb', line 55 def egress_only_internet_gateway_id data[:egress_only_internet_gateway_id] end |
#gateway_id ⇒ String
The ID of a gateway attached to your VPC.
61 62 63 |
# File 'lib/aws-sdk-ec2/route.rb', line 61 def gateway_id data[:gateway_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.
335 336 337 338 339 340 |
# File 'lib/aws-sdk-ec2/route.rb', line 335 def identifiers { route_table_id: @route_table_id, destination_cidr_block: @destination_cidr_block } end |
#instance_id ⇒ String
The ID of a NAT instance in your VPC.
67 68 69 |
# File 'lib/aws-sdk-ec2/route.rb', line 67 def instance_id data[:instance_id] end |
#instance_owner_id ⇒ String
The AWS account ID of the owner of the instance.
73 74 75 |
# File 'lib/aws-sdk-ec2/route.rb', line 73 def instance_owner_id data[:instance_owner_id] end |
#load ⇒ Object Also known as: reload
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.
133 134 135 136 |
# File 'lib/aws-sdk-ec2/route.rb', line 133 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#nat_gateway_id ⇒ String
The ID of a NAT gateway.
79 80 81 |
# File 'lib/aws-sdk-ec2/route.rb', line 79 def nat_gateway_id data[:nat_gateway_id] end |
#network_interface_id ⇒ String
The ID of the network interface.
91 92 93 |
# File 'lib/aws-sdk-ec2/route.rb', line 91 def network_interface_id data[:network_interface_id] end |
#origin ⇒ String
Describes how the route was created.
-
‘CreateRouteTable` - The route was automatically created when the route table was created.
-
‘CreateRoute` - The route was manually added to the route table.
-
‘EnableVgwRoutePropagation` - The route was propagated by route propagation.
105 106 107 |
# File 'lib/aws-sdk-ec2/route.rb', line 105 def origin data[:origin] end |
#replace(options = {}) ⇒ EmptyStructure
314 315 316 317 318 319 320 321 |
# File 'lib/aws-sdk-ec2/route.rb', line 314 def replace( = {}) = .merge( route_table_id: @route_table_id, destination_cidr_block: @destination_cidr_block ) resp = @client.replace_route() resp.data end |
#route_table ⇒ RouteTable
326 327 328 329 330 331 |
# File 'lib/aws-sdk-ec2/route.rb', line 326 def route_table RouteTable.new( id: @route_table_id, client: @client ) end |
#route_table_id ⇒ String
32 33 34 |
# File 'lib/aws-sdk-ec2/route.rb', line 32 def route_table_id @route_table_id end |
#state ⇒ String
The state of the route. The ‘blackhole` state indicates that the route’s target isn’t available (for example, the specified gateway isn’t attached to the VPC, or the specified NAT instance has been terminated).
114 115 116 |
# File 'lib/aws-sdk-ec2/route.rb', line 114 def state data[:state] end |
#transit_gateway_id ⇒ String
The ID of a transit gateway.
85 86 87 |
# File 'lib/aws-sdk-ec2/route.rb', line 85 def transit_gateway_id data[:transit_gateway_id] end |
#vpc_peering_connection_id ⇒ String
The ID of a VPC peering connection.
120 121 122 |
# File 'lib/aws-sdk-ec2/route.rb', line 120 def vpc_peering_connection_id data[:vpc_peering_connection_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
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/aws-sdk-ec2/route.rb', line 232 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 |