Module erlcloud_directconnect

Data Types
Function Index
Function Details

Data Types

connection()

connection() = proplist()

interconnect()

interconnect() = proplist()

location()

location() = proplist()

virtual_gateway()

virtual_gateway() = proplist()

virtual_interface()

virtual_interface() = proplist()

Function Index

configure/2
describe_connections/0	DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeConnections.html.
describe_connections/1
describe_connections/2
describe_connections_on_interconnect/1	DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeConnectionsOnInterconnect.html.
describe_connections_on_interconnect/2
describe_interconnects/0	DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeInterconnects.html.
describe_interconnects/1
describe_interconnects/2
describe_locations/0	DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLocations.html.
describe_locations/1
describe_virtual_gateways/0	DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeVirtualGateways.html.
describe_virtual_gateways/1
describe_virtual_interfaces/0	DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeVirtualInterfaces.html.
describe_virtual_interfaces/1
describe_virtual_interfaces/2
new/2
new/4

Function Details

configure/2

configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok

describe_connections/0

describe_connections() -> {ok, [connection()]} | {error, term()}

DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeConnections.html

Example

Get all connections:

{ok, Connections} = erlcloud_directconnect:describe_connections().

Get specific connection:

{ok, [Connection]} = erlcloud_directconnect:describe_connections("dxcon-fg5678gh").

------------------------------------------------------------------------------

describe_connections/1

describe_connections(Config::aws_config() | string() | none) -> {ok, [connection()]} | {error, term()}

describe_connections/2

describe_connections(ConnectionId::string() | none, Config::aws_config()) -> {ok, [connection()]} | {error, term()}

describe_connections_on_interconnect/1

describe_connections_on_interconnect(InterconnectId::string()) -> {ok, [connection()]} | {error, term()}

DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeConnectionsOnInterconnect.html

Example

Get all connections for specific interconnect:

{ok, Connections} = erlcloud_directconnect:describe_connections_on_interconnect("dxcon-abc123").

------------------------------------------------------------------------------

describe_connections_on_interconnect/2

describe_connections_on_interconnect(InterconnectId::string(), Config::aws_config()) -> {ok, [connection()]} | {error, term()}

describe_interconnects/0

describe_interconnects() -> {ok, [interconnect()]} | {error, term()}

DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeInterconnects.html

Example

Get all interconnects:

{ok, InterConnects} = erlcloud_directconnect:describe_interconnects().

Get specific interconnect:

{ok, [InterConnect]} = erlcloud_directconnect:describe_interconnects("dxcon-abc123").

------------------------------------------------------------------------------

describe_interconnects/1

describe_interconnects(Config::aws_config() | string() | none) -> {ok, [interconnect()]} | {error, term()}

describe_interconnects/2

describe_interconnects(InterconnectId::string() | none, Config::aws_config()) -> {ok, [interconnect()]} | {error, term()}

describe_locations/0

describe_locations() -> {ok, [location()]} | {error, term()}

DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLocations.html

Example

Get all locations:

{ok, Locations} = erlcloud_directconnect:describe_locations().

------------------------------------------------------------------------------

describe_locations/1

describe_locations(Config::aws_config()) -> {ok, [location()]} | {error, term()}

describe_virtual_gateways/0

describe_virtual_gateways() -> {ok, [virtual_gateway()]} | {error, term()}

DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeVirtualGateways.html

Example

Get all virtual gateways:

{ok, VirtualGateways} = erlcloud_directconnect:describe_virtual_gateways().

------------------------------------------------------------------------------

describe_virtual_gateways/1

describe_virtual_gateways(Config::aws_config()) -> {ok, [virtual_gateway()]} | {error, term()}

describe_virtual_interfaces/0

describe_virtual_interfaces() -> {ok, [virtual_interface()]} | {error, term()}

DirectConnect API: http://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeVirtualInterfaces.html

Example

Get all virtual interfaces:

{ok, VirtualInterfaces} = erlcloud_directconnect:describe_virtual_interfaces().

Get virtual intefafaces for specific connection:

{ok, VirtualInterfaces} = erlcloud_directconnect:describe_virtual_interfaces("dxcon-fg5678gh").

Get specific virtual interface by id:

{ok, [VirtualInterface]} = erlcloud_directconnect:describe_virtual_interfaces(none, "dxvif-123dfg56").

------------------------------------------------------------------------------