Class: Aws::EC2::VpcPeeringConnection
- Inherits:
-
Object
- Object
- Aws::EC2::VpcPeeringConnection
- Extended by:
- Deprecations
- Defined in:
- 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
- #accepter_vpc ⇒ Vpc?
- #identifiers ⇒ Object deprecated private Deprecated.
- #requester_vpc ⇒ Vpc?
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 = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
- #wait_until_exists(options = {}) ⇒ VpcPeeringConnection
Constructor Details
#initialize(id, options = {}) ⇒ VpcPeeringConnection #initialize(options = {}) ⇒ VpcPeeringConnection
Returns a new instance of VpcPeeringConnection.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.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
#accept(options = {}) ⇒ Types::AcceptVpcPeeringConnectionResult
242 243 244 245 246 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 242 def accept( = {}) = .merge(vpc_peering_connection_id: @id) resp = @client.accept_vpc_peering_connection() resp.data end |
#accepter_vpc ⇒ Vpc?
287 288 289 290 291 292 293 294 295 296 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 287 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.
37 38 39 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 37 def accepter_vpc_info data[:accepter_vpc_info] end |
#client ⇒ Client
69 70 71 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 69 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`.
89 90 91 92 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 89 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
97 98 99 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 97 def data_loaded? !!@data end |
#delete(options = {}) ⇒ Types::DeleteVpcPeeringConnectionResult
260 261 262 263 264 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 260 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.
104 105 106 107 108 109 110 111 112 113 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 104 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.
43 44 45 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 43 def expiration_time data[:expiration_time] end |
#id ⇒ String Also known as: vpc_peering_connection_id
29 30 31 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.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.
312 313 314 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 312 def identifiers { 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
79 80 81 82 83 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 79 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
278 279 280 281 282 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 278 def reject( = {}) = .merge(vpc_peering_connection_id: @id) resp = @client.reject_vpc_peering_connection() resp.data end |
#requester_vpc ⇒ Vpc?
299 300 301 302 303 304 305 306 307 308 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 299 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.
50 51 52 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 50 def requester_vpc_info data[:requester_vpc_info] end |
#status ⇒ Types::VpcPeeringConnectionStateReason
The status of the VPC peering connection.
56 57 58 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 56 def status data[:status] end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the resource.
62 63 64 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 62 def data[:tags] 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
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 211 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 = {}) ⇒ VpcPeeringConnection
121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/aws-sdk-ec2/vpc_peering_connection.rb', line 121 def wait_until_exists( = {}) , params = () waiter = Waiters::VpcPeeringConnectionExists.new() yield_waiter_and_warn(waiter, &Proc.new) 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 |