NetworkManager class

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.

Constructors

NetworkManager({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

associateCustomerGateway({required String customerGatewayArn, required String deviceId, required String globalNetworkId, String? linkId}) → Future<AssociateCustomerGatewayResponse>
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.
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({required String deviceId, required String globalNetworkId, required String transitGatewayConnectPeerArn, String? linkId}) → Future<AssociateTransitGatewayConnectPeerResponse>
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.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createConnection({required String connectedDeviceId, required String deviceId, required String globalNetworkId, String? connectedLinkId, String? description, String? linkId, List<Tag>? tags}) → Future<CreateConnectionResponse>
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({required String globalNetworkId, AWSLocation? awsLocation, String? description, Location? location, String? model, String? serialNumber, String? siteId, List<Tag>? tags, String? type, String? vendor}) → Future<CreateDeviceResponse>
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({String? description, List<Tag>? tags}) → Future<CreateGlobalNetworkResponse>
Creates a new, empty global network.
Creates a new link for a specified site.
createSite({required String globalNetworkId, String? description, Location? location, List<Tag>? tags}) → Future<CreateSiteResponse>
Creates a new site in a global network.
deleteConnection({required String connectionId, required String globalNetworkId}) → Future<DeleteConnectionResponse>
Deletes the specified connection in your global network.
deleteDevice({required String deviceId, required String globalNetworkId}) → Future<DeleteDeviceResponse>
Deletes an existing device. You must first disassociate the device from any links and customer gateways.
deleteGlobalNetwork({required String globalNetworkId}) → Future<DeleteGlobalNetworkResponse>
Deletes 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.
deleteSite({required String globalNetworkId, required String siteId}) → Future<DeleteSiteResponse>
Deletes an existing site. The site cannot be associated with any device or link.
deregisterTransitGateway({required String globalNetworkId, required String transitGatewayArn}) → Future<DeregisterTransitGatewayResponse>
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({List<String>? globalNetworkIds, int? maxResults, String? nextToken}) → Future<DescribeGlobalNetworksResponse>
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({required String customerGatewayArn, required String globalNetworkId}) → Future<DisassociateCustomerGatewayResponse>
Disassociates a customer gateway from a device and a link.
Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
disassociateTransitGatewayConnectPeer({required String globalNetworkId, required String transitGatewayConnectPeerArn}) → Future<DisassociateTransitGatewayConnectPeerResponse>
Disassociates a transit gateway Connect peer from a device and link.
getConnections({required String globalNetworkId, List<String>? connectionIds, String? deviceId, int? maxResults, String? nextToken}) → Future<GetConnectionsResponse>
Gets information about one or more of your connections in a global network.
getCustomerGatewayAssociations({required String globalNetworkId, List<String>? customerGatewayArns, int? maxResults, String? nextToken}) → Future<GetCustomerGatewayAssociationsResponse>
Gets the association information for customer gateways that are associated with devices and links in your global network.
getDevices({required String globalNetworkId, List<String>? deviceIds, int? maxResults, String? nextToken, String? siteId}) → Future<GetDevicesResponse>
Gets information about one or more of your devices in a global network.
getLinkAssociations({required String globalNetworkId, String? deviceId, String? linkId, int? maxResults, String? nextToken}) → Future<GetLinkAssociationsResponse>
Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
Gets information about one or more links in a specified global network.
getSites({required String globalNetworkId, int? maxResults, String? nextToken, List<String>? siteIds}) → Future<GetSitesResponse>
Gets information about one or more of your sites in a global network.
getTransitGatewayConnectPeerAssociations({required String globalNetworkId, int? maxResults, String? nextToken, List<String>? transitGatewayConnectPeerArns}) → Future<GetTransitGatewayConnectPeerAssociationsResponse>
Gets information about one or more of your transit gateway Connect peer associations in a global network.
getTransitGatewayRegistrations({required String globalNetworkId, int? maxResults, String? nextToken, List<String>? transitGatewayArns}) → Future<GetTransitGatewayRegistrationsResponse>
Gets information about the transit gateway registrations in a specified global network.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists the tags for a specified resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerTransitGateway({required String globalNetworkId, required String transitGatewayArn}) → Future<RegisterTransitGatewayResponse>
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({required String resourceArn, required List<Tag> tags}) → Future<void>
Tags a specified resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes tags from a specified resource.
updateConnection({required String connectionId, required String globalNetworkId, String? connectedLinkId, String? description, String? linkId}) → Future<UpdateConnectionResponse>
Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.
updateDevice({required String deviceId, required String globalNetworkId, AWSLocation? awsLocation, String? description, Location? location, String? model, String? serialNumber, String? siteId, String? type, String? vendor}) → Future<UpdateDeviceResponse>
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
updateGlobalNetwork({required String globalNetworkId, String? description}) → Future<UpdateGlobalNetworkResponse>
Updates 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.
updateSite({required String globalNetworkId, required String siteId, String? description, Location? location}) → Future<UpdateSiteResponse>
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

Operators

operator ==(Object other) → bool
The equality operator.
inherited