Class: PlatformAPI::Peering

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Peering provides a way to peer your Private Space VPC to another AWS VPC.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Peering

Returns a new instance of Peering.



2291
2292
2293
# File 'lib/platform-api/client.rb', line 2291

def initialize(client)
  @client = client
end

Instance Method Details

#accept(space_id_or_space_name, peering_pcx_id) ⇒ Object

Accept a pending peering connection with a private space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space

  • peering_pcx_id:

    The AWS VPC Peering Connection ID of the peering.



2306
2307
2308
# File 'lib/platform-api/client.rb', line 2306

def accept(space_id_or_space_name, peering_pcx_id)
  @client.peering.accept(space_id_or_space_name, peering_pcx_id)
end

#destroy(space_id_or_space_name, peering_pcx_id) ⇒ Object

Destroy an active peering connection with a private space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space

  • peering_pcx_id:

    The AWS VPC Peering Connection ID of the peering.



2314
2315
2316
# File 'lib/platform-api/client.rb', line 2314

def destroy(space_id_or_space_name, peering_pcx_id)
  @client.peering.destroy(space_id_or_space_name, peering_pcx_id)
end

#info(space_id_or_space_name, peering_pcx_id) ⇒ Object

Fetch information for existing peering connection

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space

  • peering_pcx_id:

    The AWS VPC Peering Connection ID of the peering.



2322
2323
2324
# File 'lib/platform-api/client.rb', line 2322

def info(space_id_or_space_name, peering_pcx_id)
  @client.peering.info(space_id_or_space_name, peering_pcx_id)
end

#list(space_id_or_space_name) ⇒ Object

List peering connections of a private space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space



2298
2299
2300
# File 'lib/platform-api/client.rb', line 2298

def list(space_id_or_space_name)
  @client.peering.list(space_id_or_space_name)
end