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



147
148
149
150
151
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 147

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

#accepter_vpcVpc?

Returns:



192
193
194
195
196
197
198
199
200
201
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 192

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.



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

def accepter_vpc_info
  data.accepter_vpc_info
end

#clientClient

Returns:



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

def client
  @client
end

#dataTypes::VpcPeeringConnection



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

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.



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

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:



165
166
167
168
169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 165

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.



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

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)


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

def expiration_time
  data.expiration_time
end

#idString Also known as: vpc_peering_connection_id

Returns:

  • (String)


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

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)


79
80
81
82
83
# File 'gems/aws-sdk-ec2/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

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:



183
184
185
186
187
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 183

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

#requester_vpcVpc?

Returns:



204
205
206
207
208
209
210
211
212
213
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/vpc_peering_connection.rb', line 204

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.



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

def requester_vpc_info
  data.requester_vpc_info
end

#statusTypes::VpcPeeringConnectionStateReason

The status of the VPC peering connection.



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

def status
  data.status
end

#tagsArray<Types::Tag>

Any tags assigned to the resource.

Returns:



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

def tags
  data.tags
end

#wait_until_exists(options = {}) ⇒ 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:



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

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