Class: Aws::EC2::VpcPeeringConnection
- Inherits:
-
Object
- Object
- Aws::EC2::VpcPeeringConnection
- Defined in:
- gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#accepter_vpc_info ⇒ Types::VpcPeeringConnectionVpcInfo
Information about the accepter VPC.
-
#expiration_time ⇒ Time
The time that an unaccepted VPC peering connection will expire.
-
#id ⇒ String
(also: #vpc_peering_connection_id)
-
#requester_vpc_info ⇒ Types::VpcPeeringConnectionVpcInfo
Information about the requester VPC.
-
#status ⇒ Types::VpcPeeringConnectionStateReason
The status of the VPC peering connection.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the resource.
Actions collapse
-
#accept(options = {}) ⇒ Types::AcceptVpcPeeringConnectionResult
-
#delete(options = {}) ⇒ Types::DeleteVpcPeeringConnectionResult
-
#reject(options = {}) ⇒ Types::RejectVpcPeeringConnectionResult
Associations collapse
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::VpcPeeringConnection
Returns the data for this VpcPeeringConnection.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#exists?(options = {}) ⇒ Boolean
Returns
true
if the VpcPeeringConnection exists. -
#initialize(*args) ⇒ VpcPeeringConnection
constructor
A new instance of VpcPeeringConnection.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current VpcPeeringConnection.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
-
#wait_until_exists(options = {}, &block) ⇒ VpcPeeringConnection
Constructor Details
#initialize(id, options = {}) ⇒ VpcPeeringConnection #initialize(options = {}) ⇒ VpcPeeringConnection
Returns a new instance of VpcPeeringConnection.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.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
#accept(options = {}) ⇒ Types::AcceptVpcPeeringConnectionResult
248 249 250 251 252 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 248 def accept( = {}) = .merge(vpc_peering_connection_id: @id) resp = @client.accept_vpc_peering_connection() resp.data end |
#accepter_vpc ⇒ Vpc?
293 294 295 296 297 298 299 300 301 302 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 293 def accepter_vpc if data[:accepter_vpc_info][:vpc_id] Vpc.new( id: data[:accepter_vpc_info][:vpc_id], client: @client ) else nil end end |
#accepter_vpc_info ⇒ Types::VpcPeeringConnectionVpcInfo
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
41 42 43 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 41 def accepter_vpc_info data[:accepter_vpc_info] end |
#client ⇒ Client
73 74 75 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 73 def client @client end |
#data ⇒ Types::VpcPeeringConnection
Returns the data for this Aws::EC2::VpcPeeringConnection. Calls
Client#describe_vpc_peering_connections if #data_loaded? is false
.
93 94 95 96 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 93 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
101 102 103 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 101 def data_loaded? !!@data end |
#delete(options = {}) ⇒ Types::DeleteVpcPeeringConnectionResult
266 267 268 269 270 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 266 def delete( = {}) = .merge(vpc_peering_connection_id: @id) resp = @client.delete_vpc_peering_connection() resp.data end |
#exists?(options = {}) ⇒ Boolean
Returns true
if the VpcPeeringConnection exists.
108 109 110 111 112 113 114 115 116 117 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 108 def exists?( = {}) begin wait_until_exists(.merge(max_attempts: 1)) true rescue Aws::Waiters::Errors::UnexpectedError => e raise e.error rescue Aws::Waiters::Errors::WaiterFailed false end end |
#expiration_time ⇒ Time
The time that an unaccepted VPC peering connection will expire.
47 48 49 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 47 def expiration_time data[:expiration_time] end |
#id ⇒ String Also known as: vpc_peering_connection_id
33 34 35 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 33 def id @id end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::EC2::VpcPeeringConnection.
Returns self
making it possible to chain methods.
vpc_peering_connection.reload.data
83 84 85 86 87 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 83 def load resp = @client.describe_vpc_peering_connections(vpc_peering_connection_ids: [@id]) @data = resp.vpc_peering_connections[0] self end |
#reject(options = {}) ⇒ Types::RejectVpcPeeringConnectionResult
284 285 286 287 288 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 284 def reject( = {}) = .merge(vpc_peering_connection_id: @id) resp = @client.reject_vpc_peering_connection() resp.data end |
#requester_vpc ⇒ Vpc?
305 306 307 308 309 310 311 312 313 314 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 305 def requester_vpc if data[:requester_vpc_info][:vpc_id] Vpc.new( id: data[:requester_vpc_info][:vpc_id], client: @client ) else nil end end |
#requester_vpc_info ⇒ Types::VpcPeeringConnectionVpcInfo
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
54 55 56 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 54 def requester_vpc_info data[:requester_vpc_info] end |
#status ⇒ Types::VpcPeeringConnectionStateReason
The status of the VPC peering connection.
60 61 62 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 60 def status data[:status] end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the resource.
66 67 68 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 66 def data[:tags] 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
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 217 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 |
#wait_until_exists(options = {}, &block) ⇒ VpcPeeringConnection
125 126 127 128 129 130 131 132 133 134 135 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 125 def wait_until_exists( = {}, &block) , params = () waiter = Waiters::VpcPeeringConnectionExists.new() yield_waiter_and_warn(waiter, &block) if block_given? resp = waiter.wait(params.merge(vpc_peering_connection_ids: [@id])) VpcPeeringConnection.new({ id: @id, data: resp.data.vpc_peering_connections[0], client: @client }) end |