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

Class: Aws::EC2::VpcPeeringConnection

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

Defined Under Namespace

Classes: Collection

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of VpcPeeringConnection

Overloads:



19
20
21
22
23
24
25
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.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)
  @waiter_block_warned = false
end

Instance Method Details

#accept(options = {}) ⇒ Types::AcceptVpcPeeringConnectionResult

Examples:

Request syntax with placeholder values


vpc_peering_connection.accept({
  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:



243
244
245
246
247
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 243

def accept(options = {})
  options = options.merge(vpc_peering_connection_id: @id)
  resp = @client.accept_vpc_peering_connection(options)
  resp.data
end

#accepter_vpcVpc?

Returns:



288
289
290
291
292
293
294
295
296
297
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 288

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_infoTypes::VpcPeeringConnectionVpcInfo

Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.



38
39
40
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 38

def accepter_vpc_info
  data[:accepter_vpc_info]
end

#clientClient

Returns:



70
71
72
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 70

def client
  @client
end

#dataTypes::VpcPeeringConnection



90
91
92
93
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 90

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.



98
99
100
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 98

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ Types::DeleteVpcPeeringConnectionResult

Examples:

Request syntax with placeholder values


vpc_peering_connection.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:



261
262
263
264
265
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 261

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

#exists?(options = {}) ⇒ Boolean

Returns true if the VpcPeeringConnection exists.

Parameters:

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

    ({})

Returns:

  • (Boolean)

    Returns true if the VpcPeeringConnection exists.



105
106
107
108
109
110
111
112
113
114
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 105

def exists?(options = {})
  begin
    wait_until_exists(options.merge(max_attempts: 1))
    true
  rescue Aws::Waiters::Errors::UnexpectedError => e
    raise e.error
  rescue Aws::Waiters::Errors::WaiterFailed
    false
  end
end

#expiration_timeTime

The time that an unaccepted VPC peering connection will expire.

Returns:

  • (Time)


44
45
46
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 44

def expiration_time
  data[:expiration_time]
end

#idString Also known as: vpc_peering_connection_id

Returns:

  • (String)


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

def id
  @id
end

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

Returns:

  • (self)


80
81
82
83
84
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 80

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

Examples:

Request syntax with placeholder values


vpc_peering_connection.reject({
  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:



279
280
281
282
283
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 279

def reject(options = {})
  options = options.merge(vpc_peering_connection_id: @id)
  resp = @client.reject_vpc_peering_connection(options)
  resp.data
end

#requester_vpcVpc?

Returns:



300
301
302
303
304
305
306
307
308
309
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 300

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_infoTypes::VpcPeeringConnectionVpcInfo

Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.



51
52
53
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 51

def requester_vpc_info
  data[:requester_vpc_info]
end

#statusTypes::VpcPeeringConnectionStateReason

The status of the VPC peering connection.



57
58
59
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 57

def status
  data[:status]
end

#tagsArray<Types::Tag>

Any tags assigned to the resource.

Returns:



63
64
65
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 63

def tags
  data[:tags]
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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 212

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

#wait_until_exists(options = {}, &block) ⇒ VpcPeeringConnection

Parameters:

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

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 40
  • :delay (Float) — default: 15
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:



122
123
124
125
126
127
128
129
130
131
132
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 122

def wait_until_exists(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::VpcPeeringConnectionExists.new(options)
  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