ExAws.DirectConnect.Core

AWS Direct Connect

AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections.

The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the AWS Direct Connect API Reference:

Actions: An alphabetical list of all AWS Direct Connect actions.

Source

Summary

allocate_connection_on_interconnect!(client, input)

Same as allocate_connection_on_interconnect/2 but raise on error

allocate_connection_on_interconnect(client, input)

AllocateConnectionOnInterconnect

allocate_private_virtual_interface!(client, input)

Same as allocate_private_virtual_interface/2 but raise on error

allocate_private_virtual_interface(client, input)

AllocatePrivateVirtualInterface

allocate_public_virtual_interface!(client, input)

Same as allocate_public_virtual_interface/2 but raise on error

allocate_public_virtual_interface(client, input)

AllocatePublicVirtualInterface

confirm_connection!(client, input)

Same as confirm_connection/2 but raise on error

confirm_connection(client, input)

ConfirmConnection

confirm_private_virtual_interface!(client, input)

Same as confirm_private_virtual_interface/2 but raise on error

confirm_private_virtual_interface(client, input)

ConfirmPrivateVirtualInterface

confirm_public_virtual_interface!(client, input)

Same as confirm_public_virtual_interface/2 but raise on error

confirm_public_virtual_interface(client, input)

ConfirmPublicVirtualInterface

create_connection!(client, input)

Same as create_connection/2 but raise on error

create_connection(client, input)

CreateConnection

create_interconnect!(client, input)

Same as create_interconnect/2 but raise on error

create_interconnect(client, input)

CreateInterconnect

create_private_virtual_interface!(client, input)

Same as create_private_virtual_interface/2 but raise on error

create_private_virtual_interface(client, input)

CreatePrivateVirtualInterface

create_public_virtual_interface!(client, input)

Same as create_public_virtual_interface/2 but raise on error

create_public_virtual_interface(client, input)

CreatePublicVirtualInterface

delete_connection!(client, input)

Same as delete_connection/2 but raise on error

delete_connection(client, input)

DeleteConnection

delete_interconnect!(client, input)

Same as delete_interconnect/2 but raise on error

delete_interconnect(client, input)

DeleteInterconnect

delete_virtual_interface!(client, input)

Same as delete_virtual_interface/2 but raise on error

delete_virtual_interface(client, input)

DeleteVirtualInterface

describe_connections!(client, input)

Same as describe_connections/2 but raise on error

describe_connections(client, input)

DescribeConnections

describe_connections_on_interconnect!(client, input)

Same as describe_connections_on_interconnect/2 but raise on error

describe_connections_on_interconnect(client, input)

DescribeConnectionsOnInterconnect

describe_interconnects!(client, input)

Same as describe_interconnects/2 but raise on error

describe_interconnects(client, input)

DescribeInterconnects

describe_locations!(client)

Same as describe_locations/2 but raise on error

describe_locations(client)

DescribeLocations

describe_virtual_gateways!(client)

Same as describe_virtual_gateways/2 but raise on error

describe_virtual_gateways(client)

DescribeVirtualGateways

describe_virtual_interfaces!(client, input)

Same as describe_virtual_interfaces/2 but raise on error

describe_virtual_interfaces(client, input)

DescribeVirtualInterfaces

Types

new_public_virtual_interface :: [amazon_address: amazon_address, asn: asn, auth_key: bgp_auth_key, customer_address: customer_address, route_filter_prefixes: route_filter_prefix_list, virtual_interface_name: virtual_interface_name, vlan: vlan]

create_private_virtual_interface_request :: [connection_id: connection_id, new_private_virtual_interface: new_private_virtual_interface]

router_config :: binary

error_message :: binary

interconnect :: [bandwidth: bandwidth, interconnect_id: interconnect_id, interconnect_name: interconnect_name, interconnect_state: interconnect_state, location: location_code, region: region]

connection_state :: binary

cidr :: binary

connection_id :: binary

bgp_auth_key :: binary

location_code :: binary

connection_name :: binary

region :: binary

new_public_virtual_interface_allocation :: [amazon_address: amazon_address, asn: asn, auth_key: bgp_auth_key, customer_address: customer_address, route_filter_prefixes: route_filter_prefix_list, virtual_interface_name: virtual_interface_name, vlan: vlan]

delete_interconnect_response :: [{:interconnect_state, interconnect_state}]

vlan :: integer

virtual_interfaces :: [{:virtual_interfaces, virtual_interface_list}]

interconnect_name :: binary

owner_account :: binary

interconnect_state :: binary

route_filter_prefix :: [{:cidr, cidr}]

confirm_connection_request :: [{:connection_id, connection_id}]

new_private_virtual_interface :: [amazon_address: amazon_address, asn: asn, auth_key: bgp_auth_key, customer_address: customer_address, virtual_gateway_id: virtual_gateway_id, virtual_interface_name: virtual_interface_name, vlan: vlan]

allocate_private_virtual_interface_request :: [connection_id: connection_id, new_private_virtual_interface_allocation: new_private_virtual_interface_allocation, owner_account: owner_account]

virtual_gateway_id :: binary

interconnect_id :: binary

location :: [location_code: location_code, location_name: location_name]

partner_name :: binary

new_private_virtual_interface_allocation :: [amazon_address: amazon_address, asn: asn, auth_key: bgp_auth_key, customer_address: customer_address, virtual_interface_name: virtual_interface_name, vlan: vlan]

allocate_public_virtual_interface_request :: [connection_id: connection_id, new_public_virtual_interface_allocation: new_public_virtual_interface_allocation, owner_account: owner_account]

amazon_address :: binary

locations :: [{:locations, location_list}]

virtual_gateway :: [virtual_gateway_id: virtual_gateway_id, virtual_gateway_state: virtual_gateway_state]

virtual_gateways :: [{:virtual_gateways, virtual_gateway_list}]

delete_interconnect_request :: [{:interconnect_id, interconnect_id}]

asn :: integer

create_interconnect_request :: [bandwidth: bandwidth, interconnect_name: interconnect_name, location: location_code]

create_connection_request :: [bandwidth: bandwidth, connection_name: connection_name, location: location_code]

delete_connection_request :: [{:connection_id, connection_id}]

location_name :: binary

customer_address :: binary

virtual_interface :: [amazon_address: amazon_address, asn: asn, auth_key: bgp_auth_key, connection_id: connection_id, customer_address: customer_address, customer_router_config: router_config, location: location_code, owner_account: owner_account, route_filter_prefixes: route_filter_prefix_list, virtual_gateway_id: virtual_gateway_id, virtual_interface_id: virtual_interface_id, virtual_interface_name: virtual_interface_name, virtual_interface_state: virtual_interface_state, virtual_interface_type: virtual_interface_type, vlan: vlan]

bandwidth :: binary

confirm_connection_response :: [{:connection_state, connection_state}]

interconnects :: [{:interconnects, interconnect_list}]

connection :: [bandwidth: bandwidth, connection_id: connection_id, connection_name: connection_name, connection_state: connection_state, location: location_code, owner_account: owner_account, partner_name: partner_name, region: region, vlan: vlan]

describe_virtual_interfaces_request :: [connection_id: connection_id, virtual_interface_id: virtual_interface_id]

connections :: [{:connections, connection_list}]

allocate_connection_on_interconnect_request :: [bandwidth: bandwidth, connection_name: connection_name, interconnect_id: interconnect_id, owner_account: owner_account, vlan: vlan]

create_public_virtual_interface_request :: [connection_id: connection_id, new_public_virtual_interface: new_public_virtual_interface]

Functions

allocate_connection_on_interconnect(client, input)

Specs:

AllocateConnectionOnInterconnect

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.

Source
allocate_connection_on_interconnect!(client, input)

Specs:

Same as allocate_connection_on_interconnect/2 but raise on error.

Source
allocate_private_virtual_interface(client, input)

Specs:

AllocatePrivateVirtualInterface

Provisions a private virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in ‘Confirming’ state, and will not be available for handling traffic.

Source
allocate_private_virtual_interface!(client, input)

Specs:

Same as allocate_private_virtual_interface/2 but raise on error.

Source
allocate_public_virtual_interface(client, input)

Specs:

AllocatePublicVirtualInterface

Provisions a public virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in ‘Confirming’ state, and will not be available for handling traffic.

Source
allocate_public_virtual_interface!(client, input)

Specs:

Same as allocate_public_virtual_interface/2 but raise on error.

Source
confirm_connection(client, input)

Specs:

ConfirmConnection

Confirm the creation of a hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the ‘Ordering’ state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.

Source
confirm_connection!(client, input)

Specs:

  • confirm_connection!(client :: ExAws.DirectConnect.t, input :: confirm_connection_request) :: ExAws.Request.JSON.success_t | no_return

Same as confirm_connection/2 but raise on error.

Source
confirm_private_virtual_interface(client, input)

Specs:

ConfirmPrivateVirtualInterface

Accept ownership of a private virtual interface created by another customer.

After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.

Source
confirm_private_virtual_interface!(client, input)

Specs:

Same as confirm_private_virtual_interface/2 but raise on error.

Source
confirm_public_virtual_interface(client, input)

Specs:

ConfirmPublicVirtualInterface

Accept ownership of a public virtual interface created by another customer.

After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.

Source
confirm_public_virtual_interface!(client, input)

Specs:

Same as confirm_public_virtual_interface/2 but raise on error.

Source
create_connection(client, input)

Specs:

CreateConnection

Creates a new connection between the customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.

Source
create_connection!(client, input)

Specs:

  • create_connection!(client :: ExAws.DirectConnect.t, input :: create_connection_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_connection/2 but raise on error.

Source
create_interconnect(client, input)

Specs:

CreateInterconnect

Creates a new interconnect between a AWS Direct Connect partner’s network and a specific AWS Direct Connect location.

An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner’s network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner’s router, the other to an AWS Direct Connect router.

For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.

Source
create_interconnect!(client, input)

Specs:

  • create_interconnect!(client :: ExAws.DirectConnect.t, input :: create_interconnect_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_interconnect/2 but raise on error.

Source
create_private_virtual_interface(client, input)

Specs:

CreatePrivateVirtualInterface

Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).

Source
create_private_virtual_interface!(client, input)

Specs:

Same as create_private_virtual_interface/2 but raise on error.

Source
create_public_virtual_interface(client, input)

Specs:

CreatePublicVirtualInterface

Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).

Source
create_public_virtual_interface!(client, input)

Specs:

Same as create_public_virtual_interface/2 but raise on error.

Source
delete_connection(client, input)

Specs:

DeleteConnection

Deletes the connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.

Source
delete_connection!(client, input)

Specs:

  • delete_connection!(client :: ExAws.DirectConnect.t, input :: delete_connection_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_connection/2 but raise on error.

Source
delete_interconnect(client, input)

Specs:

DeleteInterconnect

Deletes the specified interconnect.

Source
delete_interconnect!(client, input)

Specs:

  • delete_interconnect!(client :: ExAws.DirectConnect.t, input :: delete_interconnect_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_interconnect/2 but raise on error.

Source
delete_virtual_interface(client, input)

Specs:

DeleteVirtualInterface

Deletes a virtual interface.

Source
delete_virtual_interface!(client, input)

Specs:

Same as delete_virtual_interface/2 but raise on error.

Source
describe_connections(client, input)

Specs:

DescribeConnections

Displays all connections in this region.

If a connection ID is provided, the call returns only that particular connection.

Source
describe_connections!(client, input)

Specs:

Same as describe_connections/2 but raise on error.

Source
describe_connections_on_interconnect(client, input)

Specs:

DescribeConnectionsOnInterconnect

Return a list of connections that have been provisioned on the given interconnect.

Source
describe_connections_on_interconnect!(client, input)

Specs:

Same as describe_connections_on_interconnect/2 but raise on error.

Source
describe_interconnects(client, input)

Specs:

DescribeInterconnects

Returns a list of interconnects owned by the AWS account.

If an interconnect ID is provided, it will only return this particular interconnect.

Source
describe_interconnects!(client, input)

Specs:

Same as describe_interconnects/2 but raise on error.

Source
describe_locations(client)

Specs:

  • describe_locations(client :: ExAws.DirectConnect.t) :: ExAws.Request.JSON.response_t

DescribeLocations

Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.

Source
describe_locations!(client)

Specs:

  • describe_locations!(client :: ExAws.DirectConnect.t) :: ExAws.Request.JSON.success_t | no_return

Same as describe_locations/2 but raise on error.

Source
describe_virtual_gateways(client)

Specs:

  • describe_virtual_gateways(client :: ExAws.DirectConnect.t) :: ExAws.Request.JSON.response_t

DescribeVirtualGateways

Returns a list of virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

Source
describe_virtual_gateways!(client)

Specs:

  • describe_virtual_gateways!(client :: ExAws.DirectConnect.t) :: ExAws.Request.JSON.success_t | no_return

Same as describe_virtual_gateways/2 but raise on error.

Source
describe_virtual_interfaces(client, input)

Specs:

DescribeVirtualInterfaces

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.

Source
describe_virtual_interfaces!(client, input)

Specs:

Same as describe_virtual_interfaces/2 but raise on error.

Source