AWS.NetworkManager (aws-elixir v0.8.0) View Source

Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your AWS and on-premises networks that are built around transit gateways.

The Network Manager APIs are supported in the US West (Oregon) Region only. You must specify the us-west-2 Region in all requests made to Network Manager.

Link to this section Summary

Functions

Associates a customer gateway with a device and optionally, with a link.

Associates a transit gateway Connect peer with a device, and optionally, with a link.

Creates a connection between two devices.

Creates a new device in a global network.

Creates a new, empty global network.

Creates a new link for a specified site.

Creates a new site in a global network.

Deletes the specified connection in your global network.

Disassociates an existing device from a link.

Gets the association information for customer gateways that are associated with devices and links in your global network.

Gets information about one or more of your sites in a global network.

Lists the tags for a specified resource.

Registers a transit gateway in your global network.

Removes tags from a specified resource.

Updates the information for an existing connection.

Updates the information for an existing site.

Link to this section Functions

Link to this function

associate_customer_gateway(client, global_network_id, input, options \\ [])

View Source

Associates a customer gateway with a device and optionally, with a link.

If you specify a link, it must be associated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

Link to this function

associate_link(client, global_network_id, input, options \\ [])

View Source

Associates a link to a device.

A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

Link to this function

associate_transit_gateway_connect_peer(client, global_network_id, input, options \\ [])

View Source

Associates a transit gateway Connect peer with a device, and optionally, with a link.

If you specify a link, it must be associated with the specified device.

You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

Link to this function

create_connection(client, global_network_id, input, options \\ [])

View Source

Creates a connection between two devices.

The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

Link to this function

create_device(client, global_network_id, input, options \\ [])

View Source

Creates a new device in a global network.

If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

Link to this function

create_global_network(client, input, options \\ [])

View Source

Creates a new, empty global network.

Link to this function

create_link(client, global_network_id, input, options \\ [])

View Source

Creates a new link for a specified site.

Link to this function

create_site(client, global_network_id, input, options \\ [])

View Source

Creates a new site in a global network.

Link to this function

delete_connection(client, connection_id, global_network_id, input, options \\ [])

View Source

Deletes the specified connection in your global network.

Link to this function

delete_device(client, device_id, global_network_id, input, options \\ [])

View Source

Deletes an existing device.

You must first disassociate the device from any links and customer gateways.

Link to this function

delete_global_network(client, global_network_id, input, options \\ [])

View Source

Deletes an existing global network.

You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.

Link to this function

delete_link(client, global_network_id, link_id, input, options \\ [])

View Source

Deletes an existing link.

You must first disassociate the link from any devices and customer gateways.

Link to this function

delete_site(client, global_network_id, site_id, input, options \\ [])

View Source

Deletes an existing site.

The site cannot be associated with any device or link.

Link to this function

deregister_transit_gateway(client, global_network_id, transit_gateway_arn, input, options \\ [])

View Source

Deregisters a transit gateway from your global network.

This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

Link to this function

describe_global_networks(client, global_network_ids \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Describes one or more global networks.

By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

Link to this function

disassociate_customer_gateway(client, customer_gateway_arn, global_network_id, input, options \\ [])

View Source

Disassociates a customer gateway from a device and a link.

Link to this function

disassociate_link(client, global_network_id, input, options \\ [])

View Source

Disassociates an existing device from a link.

You must first disassociate any customer gateways that are associated with the link.

Link to this function

disassociate_transit_gateway_connect_peer(client, global_network_id, transit_gateway_connect_peer_arn, input, options \\ [])

View Source

Disassociates a transit gateway Connect peer from a device and link.

Link to this function

get_connections(client, global_network_id, connection_ids \\ nil, device_id \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets information about one or more of your connections in a global network.

Link to this function

get_customer_gateway_associations(client, global_network_id, customer_gateway_arns \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets the association information for customer gateways that are associated with devices and links in your global network.

Link to this function

get_devices(client, global_network_id, device_ids \\ nil, max_results \\ nil, next_token \\ nil, site_id \\ nil, options \\ [])

View Source

Gets information about one or more of your devices in a global network.

Link to this function

get_links(client, global_network_id, link_ids \\ nil, max_results \\ nil, next_token \\ nil, provider \\ nil, site_id \\ nil, type \\ nil, options \\ [])

View Source

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

Link to this function

get_sites(client, global_network_id, max_results \\ nil, next_token \\ nil, site_ids \\ nil, options \\ [])

View Source

Gets information about one or more of your sites in a global network.

Link to this function

get_transit_gateway_connect_peer_associations(client, global_network_id, max_results \\ nil, next_token \\ nil, transit_gateway_connect_peer_arns \\ nil, options \\ [])

View Source

Gets information about one or more of your transit gateway Connect peer associations in a global network.

Link to this function

get_transit_gateway_registrations(client, global_network_id, max_results \\ nil, next_token \\ nil, transit_gateway_arns \\ nil, options \\ [])

View Source

Gets information about the transit gateway registrations in a specified global network.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for a specified resource.

Link to this function

register_transit_gateway(client, global_network_id, input, options \\ [])

View Source

Registers a transit gateway in your global network.

The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Tags a specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from a specified resource.

Link to this function

update_connection(client, connection_id, global_network_id, input, options \\ [])

View Source

Updates the information for an existing connection.

To remove information for any of the parameters, specify an empty string.

Link to this function

update_device(client, device_id, global_network_id, input, options \\ [])

View Source

Updates the details for an existing device.

To remove information for any of the parameters, specify an empty string.

Link to this function

update_global_network(client, global_network_id, input, options \\ [])

View Source

Updates an existing global network.

To remove information for any of the parameters, specify an empty string.

Link to this function

update_link(client, global_network_id, link_id, input, options \\ [])

View Source

Updates the details for an existing link.

To remove information for any of the parameters, specify an empty string.

Link to this function

update_site(client, global_network_id, site_id, input, options \\ [])

View Source

Updates the information for an existing site.

To remove information for any of the parameters, specify an empty string.