NetworkManager

import { NetworkManager } from "https://aws-api.deno.dev/v0.2/services/networkmanager.ts?docs=full";

class NetworkManager {

constructor(apiFactory: client.ApiFactory);

async associateCustomerGateway(params: AssociateCustomerGatewayRequest, opts?: client.RequestOptions): Promise<AssociateCustomerGatewayResponse>;

async associateLink(params: AssociateLinkRequest, opts?: client.RequestOptions): Promise<AssociateLinkResponse>;

async associateTransitGatewayConnectPeer(params: AssociateTransitGatewayConnectPeerRequest, opts?: client.RequestOptions): Promise<AssociateTransitGatewayConnectPeerResponse>;

async createConnection(params: CreateConnectionRequest, opts?: client.RequestOptions): Promise<CreateConnectionResponse>;

async createDevice(params: CreateDeviceRequest, opts?: client.RequestOptions): Promise<CreateDeviceResponse>;

async createGlobalNetwork(params?: CreateGlobalNetworkRequest, opts?: client.RequestOptions): Promise<CreateGlobalNetworkResponse>;

async createLink(params: CreateLinkRequest, opts?: client.RequestOptions): Promise<CreateLinkResponse>;

async createSite(params: CreateSiteRequest, opts?: client.RequestOptions): Promise<CreateSiteResponse>;

async deleteConnection(params: DeleteConnectionRequest, opts?: client.RequestOptions): Promise<DeleteConnectionResponse>;

async deleteDevice(params: DeleteDeviceRequest, opts?: client.RequestOptions): Promise<DeleteDeviceResponse>;

async deleteGlobalNetwork(params: DeleteGlobalNetworkRequest, opts?: client.RequestOptions): Promise<DeleteGlobalNetworkResponse>;

async deleteLink(params: DeleteLinkRequest, opts?: client.RequestOptions): Promise<DeleteLinkResponse>;

async deleteSite(params: DeleteSiteRequest, opts?: client.RequestOptions): Promise<DeleteSiteResponse>;

async deregisterTransitGateway(params: DeregisterTransitGatewayRequest, opts?: client.RequestOptions): Promise<DeregisterTransitGatewayResponse>;

async describeGlobalNetworks(params?: DescribeGlobalNetworksRequest, opts?: client.RequestOptions): Promise<DescribeGlobalNetworksResponse>;

async disassociateCustomerGateway(params: DisassociateCustomerGatewayRequest, opts?: client.RequestOptions): Promise<DisassociateCustomerGatewayResponse>;

async disassociateLink(params: DisassociateLinkRequest, opts?: client.RequestOptions): Promise<DisassociateLinkResponse>;

async disassociateTransitGatewayConnectPeer(params: DisassociateTransitGatewayConnectPeerRequest, opts?: client.RequestOptions): Promise<DisassociateTransitGatewayConnectPeerResponse>;

async getConnections(params: GetConnectionsRequest, opts?: client.RequestOptions): Promise<GetConnectionsResponse>;

async getCustomerGatewayAssociations(params: GetCustomerGatewayAssociationsRequest, opts?: client.RequestOptions): Promise<GetCustomerGatewayAssociationsResponse>;

async getDevices(params: GetDevicesRequest, opts?: client.RequestOptions): Promise<GetDevicesResponse>;

async getLinkAssociations(params: GetLinkAssociationsRequest, opts?: client.RequestOptions): Promise<GetLinkAssociationsResponse>;

async getLinks(params: GetLinksRequest, opts?: client.RequestOptions): Promise<GetLinksResponse>;

async getSites(params: GetSitesRequest, opts?: client.RequestOptions): Promise<GetSitesResponse>;

async getTransitGatewayConnectPeerAssociations(params: GetTransitGatewayConnectPeerAssociationsRequest, opts?: client.RequestOptions): Promise<GetTransitGatewayConnectPeerAssociationsResponse>;

async getTransitGatewayRegistrations(params: GetTransitGatewayRegistrationsRequest, opts?: client.RequestOptions): Promise<GetTransitGatewayRegistrationsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async registerTransitGateway(params: RegisterTransitGatewayRequest, opts?: client.RequestOptions): Promise<RegisterTransitGatewayResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateConnection(params: UpdateConnectionRequest, opts?: client.RequestOptions): Promise<UpdateConnectionResponse>;

async updateDevice(params: UpdateDeviceRequest, opts?: client.RequestOptions): Promise<UpdateDeviceResponse>;

async updateGlobalNetwork(params: UpdateGlobalNetworkRequest, opts?: client.RequestOptions): Promise<UpdateGlobalNetworkResponse>;

async updateLink(params: UpdateLinkRequest, opts?: client.RequestOptions): Promise<UpdateLinkResponse>;

async updateSite(params: UpdateSiteRequest, opts?: client.RequestOptions): Promise<UpdateSiteResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new NetworkManager(apiFactory: client.ApiFactory)

[src]

§Methods

associateCustomerGateway(params: AssociateCustomerGatewayRequest, opts?: client.RequestOptions): Promise<AssociateCustomerGatewayResponse>

[src]

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.

associateLink(params: AssociateLinkRequest, opts?: client.RequestOptions): Promise<AssociateLinkResponse>

[src]

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.

associateTransitGatewayConnectPeer(params: AssociateTransitGatewayConnectPeerRequest, opts?: client.RequestOptions): Promise<AssociateTransitGatewayConnectPeerResponse>

[src]

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.

createConnection(params: CreateConnectionRequest, opts?: client.RequestOptions): Promise<CreateConnectionResponse>

[src]

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.

createDevice(params: CreateDeviceRequest, opts?: client.RequestOptions): Promise<CreateDeviceResponse>

[src]

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.

createGlobalNetwork(params?: CreateGlobalNetworkRequest, opts?: client.RequestOptions): Promise<CreateGlobalNetworkResponse>

[src]

Creates a new, empty global network.

createLink(params: CreateLinkRequest, opts?: client.RequestOptions): Promise<CreateLinkResponse>

[src]

Creates a new link for a specified site.

createSite(params: CreateSiteRequest, opts?: client.RequestOptions): Promise<CreateSiteResponse>

[src]

Creates a new site in a global network.

deleteConnection(params: DeleteConnectionRequest, opts?: client.RequestOptions): Promise<DeleteConnectionResponse>

[src]

Deletes the specified connection in your global network.

deleteDevice(params: DeleteDeviceRequest, opts?: client.RequestOptions): Promise<DeleteDeviceResponse>

[src]

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

deleteGlobalNetwork(params: DeleteGlobalNetworkRequest, opts?: client.RequestOptions): Promise<DeleteGlobalNetworkResponse>

[src]

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

deleteLink(params: DeleteLinkRequest, opts?: client.RequestOptions): Promise<DeleteLinkResponse>

[src]

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

deleteSite(params: DeleteSiteRequest, opts?: client.RequestOptions): Promise<DeleteSiteResponse>

[src]

Deletes an existing site. The site cannot be associated with any device or link.

deregisterTransitGateway(params: DeregisterTransitGatewayRequest, opts?: client.RequestOptions): Promise<DeregisterTransitGatewayResponse>

[src]

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.

describeGlobalNetworks(params?: DescribeGlobalNetworksRequest, opts?: client.RequestOptions): Promise<DescribeGlobalNetworksResponse>

[src]

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".

disassociateCustomerGateway(params: DisassociateCustomerGatewayRequest, opts?: client.RequestOptions): Promise<DisassociateCustomerGatewayResponse>

[src]

Disassociates a customer gateway from a device and a link.

disassociateLink(params: DisassociateLinkRequest, opts?: client.RequestOptions): Promise<DisassociateLinkResponse>

[src]

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

disassociateTransitGatewayConnectPeer(params: DisassociateTransitGatewayConnectPeerRequest, opts?: client.RequestOptions): Promise<DisassociateTransitGatewayConnectPeerResponse>

[src]

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

getConnections(params: GetConnectionsRequest, opts?: client.RequestOptions): Promise<GetConnectionsResponse>

[src]

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

getCustomerGatewayAssociations(params: GetCustomerGatewayAssociationsRequest, opts?: client.RequestOptions): Promise<GetCustomerGatewayAssociationsResponse>

[src]

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

getDevices(params: GetDevicesRequest, opts?: client.RequestOptions): Promise<GetDevicesResponse>

[src]

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

getLinkAssociations(params: GetLinkAssociationsRequest, opts?: client.RequestOptions): Promise<GetLinkAssociationsResponse>

[src]

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

getLinks(params: GetLinksRequest, opts?: client.RequestOptions): Promise<GetLinksResponse>

[src]

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.

getSites(params: GetSitesRequest, opts?: client.RequestOptions): Promise<GetSitesResponse>

[src]

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

getTransitGatewayConnectPeerAssociations(params: GetTransitGatewayConnectPeerAssociationsRequest, opts?: client.RequestOptions): Promise<GetTransitGatewayConnectPeerAssociationsResponse>

[src]

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

getTransitGatewayRegistrations(params: GetTransitGatewayRegistrationsRequest, opts?: client.RequestOptions): Promise<GetTransitGatewayRegistrationsResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags for a specified resource.

registerTransitGateway(params: RegisterTransitGatewayRequest, opts?: client.RequestOptions): Promise<RegisterTransitGatewayResponse>

[src]

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.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Tags a specified resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes tags from a specified resource.

updateConnection(params: UpdateConnectionRequest, opts?: client.RequestOptions): Promise<UpdateConnectionResponse>

[src]

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

updateDevice(params: UpdateDeviceRequest, opts?: client.RequestOptions): Promise<UpdateDeviceResponse>

[src]

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

updateGlobalNetwork(params: UpdateGlobalNetworkRequest, opts?: client.RequestOptions): Promise<UpdateGlobalNetworkResponse>

[src]

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

updateLink(params: UpdateLinkRequest, opts?: client.RequestOptions): Promise<UpdateLinkResponse>

[src]

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

updateSite(params: UpdateSiteRequest, opts?: client.RequestOptions): Promise<UpdateSiteResponse>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]