View Source aws_networkmanager (aws v0.3.1)
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 theus-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 link to a device.
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.
Deletes an existing device.
Deletes an existing global network.
Deletes an existing link.
Deletes an existing site.
Deregisters a transit gateway from your global network.
Describes one or more global networks.
Disassociates an existing device from a link.
Gets the link associations for a device or a link.
Gets information about one or more links in a specified global network.
Registers a transit gateway in your global network.
Updates the information for an existing connection.
Updates the details for an existing device.
Updates an existing global network.
Updates the details for an existing link.
Updates the information for an existing site.
Link to this section Functions
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
.
associate_customer_gateway(Client, GlobalNetworkId, Input0, Options0)
View SourceAssociates 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.associate_transit_gateway_connect_peer(Client, GlobalNetworkId, Input)
View SourceAssociates 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.associate_transit_gateway_connect_peer(Client, GlobalNetworkId, Input0, Options0)
View SourceCreates 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.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.delete_connection(Client, ConnectionId, GlobalNetworkId, Input0, Options0)
View SourceDeletes an existing device.
You must first disassociate the device from any links and customer gateways.delete_device(Client, DeviceId, GlobalNetworkId, Input0, Options0)
View SourceDeletes an existing global network.
You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.Deletes an existing link.
You must first disassociate the link from any devices and customer gateways.Deletes an existing site.
The site cannot be associated with any device or link.deregister_transit_gateway(Client, GlobalNetworkId, TransitGatewayArn, Input)
View SourceDeregisters 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.deregister_transit_gateway(Client, GlobalNetworkId, TransitGatewayArn, Input0, Options0)
View SourceDescribes one or more global networks.
By default, all global networks are described. To describe the objects in your global network, you must use the appropriateGet*
action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations
.
disassociate_customer_gateway(Client, CustomerGatewayArn, GlobalNetworkId, Input)
View Sourcedisassociate_customer_gateway(Client, CustomerGatewayArn, GlobalNetworkId, Input0, Options0)
View SourceDisassociates an existing device from a link.
You must first disassociate any customer gateways that are associated with the link.disassociate_transit_gateway_connect_peer(Client, GlobalNetworkId, TransitGatewayConnectPeerArn, Input)
View Sourcedisassociate_transit_gateway_connect_peer(Client, GlobalNetworkId, TransitGatewayConnectPeerArn, Input0, Options0)
View Sourceget_connections(Client, GlobalNetworkId, QueryMap, HeadersMap, Options0)
View Sourceget_customer_gateway_associations(Client, GlobalNetworkId, QueryMap, HeadersMap)
View Sourceget_customer_gateway_associations(Client, GlobalNetworkId, QueryMap, HeadersMap, Options0)
View Sourceget_devices(Client, GlobalNetworkId, QueryMap, HeadersMap, Options0)
View SourceGets the link associations for a device or a link.
Either the device ID or the link ID must be specified.get_link_associations(Client, GlobalNetworkId, QueryMap, HeadersMap)
View Sourceget_link_associations(Client, GlobalNetworkId, QueryMap, HeadersMap, Options0)
View SourceGets 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.get_links(Client, GlobalNetworkId, QueryMap, HeadersMap, Options0)
View Sourceget_sites(Client, GlobalNetworkId, QueryMap, HeadersMap, Options0)
View Sourceget_transit_gateway_connect_peer_associations(Client, GlobalNetworkId)
View Sourceget_transit_gateway_connect_peer_associations(Client, GlobalNetworkId, QueryMap, HeadersMap)
View Sourceget_transit_gateway_connect_peer_associations(Client, GlobalNetworkId, QueryMap, HeadersMap, Options0)
View Sourceget_transit_gateway_registrations(Client, GlobalNetworkId, QueryMap, HeadersMap)
View Sourceget_transit_gateway_registrations(Client, GlobalNetworkId, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceRegisters 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.register_transit_gateway(Client, GlobalNetworkId, Input0, Options0)
View SourceUpdates the information for an existing connection.
To remove information for any of the parameters, specify an empty string.update_connection(Client, ConnectionId, GlobalNetworkId, Input0, Options0)
View SourceUpdates the details for an existing device.
To remove information for any of the parameters, specify an empty string.update_device(Client, DeviceId, GlobalNetworkId, Input0, Options0)
View SourceUpdates an existing global network.
To remove information for any of the parameters, specify an empty string.Updates the details for an existing link.
To remove information for any of the parameters, specify an empty string.Updates the information for an existing site.
To remove information for any of the parameters, specify an empty string.