networkmanager function

AWS Network Manager

AWS Network Manager

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

networkmanager( config = list(), credentials = list(), endpoint = NULL, region = NULL )

Arguments

  • config: Optional configuration of credentials, endpoint, and/or region.

    • credentials :

      • creds :

        • access_key_id : AWS access key ID
        • secret_access_key : AWS secret access key
        • session_token : AWS temporary session token
      • profile : The name of a profile to use. If not given, then the default profile is used.

      • anonymous : Set anonymous credentials.

    • endpoint : The complete URL to use for the constructed client.

    • region : The AWS Region used in instantiating the client.

    • close_connection : Immediately close all HTTP connections.

    • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

    • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

    • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

  • credentials: Optional credentials shorthand for the config parameter

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token
    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint: Optional shorthand for complete URL to use for the constructed client.

  • region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- networkmanager(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

accept_attachmentAccepts a core network attachment request
associate_connect_peerAssociates a core network Connect peer with a device and optionally, with a link
associate_customer_gatewayAssociates a customer gateway with a device and optionally, with a link
associate_linkAssociates a link to a device
associate_transit_gateway_connect_peerAssociates a transit gateway Connect peer with a device, and optionally, with a link
create_connect_attachmentCreates a core network Connect attachment from a specified core network attachment
create_connectionCreates a connection between two devices
create_connect_peerCreates a core network Connect peer for a specified core network connect attachment between a core network and an appliance
create_core_networkCreates a core network as part of your global network, and optionally, with a core network policy
create_deviceCreates a new device in a global network
create_direct_connect_gateway_attachmentCreates an Amazon Web Services Direct Connect gateway attachment
create_global_networkCreates a new, empty global network
create_linkCreates a new link for a specified site
create_siteCreates a new site in a global network
create_site_to_site_vpn_attachmentCreates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network
create_transit_gateway_peeringCreates a transit gateway peering connection
create_transit_gateway_route_table_attachmentCreates a transit gateway route table attachment
create_vpc_attachmentCreates a VPC attachment on an edge location of a core network
delete_attachmentDeletes an attachment
delete_connectionDeletes the specified connection in your global network
delete_connect_peerDeletes a Connect peer
delete_core_networkDeletes a core network along with all core network policies
delete_core_network_policy_versionDeletes a policy version from a core network
delete_deviceDeletes an existing device
delete_global_networkDeletes an existing global network
delete_linkDeletes an existing link
delete_peeringDeletes an existing peering connection
delete_resource_policyDeletes a resource policy for the specified resource
delete_siteDeletes an existing site
deregister_transit_gatewayDeregisters a transit gateway from your global network
describe_global_networksDescribes one or more global networks
disassociate_connect_peerDisassociates a core network Connect peer from a device and a link
disassociate_customer_gatewayDisassociates a customer gateway from a device and a link
disassociate_linkDisassociates an existing device from a link
disassociate_transit_gateway_connect_peerDisassociates a transit gateway Connect peer from a device and link
execute_core_network_change_setExecutes a change set on your core network
get_connect_attachmentReturns information about a core network Connect attachment
get_connectionsGets information about one or more of your connections in a global network
get_connect_peerReturns information about a core network Connect peer
get_connect_peer_associationsReturns information about a core network Connect peer associations
get_core_networkReturns information about the LIVE policy for a core network
get_core_network_change_eventsReturns information about a core network change event
get_core_network_change_setReturns a change set between the LIVE core network policy and a submitted policy
get_core_network_policyReturns details about a core network policy
get_customer_gateway_associationsGets the association information for customer gateways that are associated with devices and links in your global network
get_devicesGets information about one or more of your devices in a global network
get_direct_connect_gateway_attachmentReturns information about a specific Amazon Web Services Direct Connect gateway attachment
get_link_associationsGets the link associations for a device or a link
get_linksGets information about one or more links in a specified global network
get_network_resource_countsGets the count of network resources, by resource type, for the specified global network
get_network_resource_relationshipsGets the network resource relationships for the specified global network
get_network_resourcesDescribes the network resources for the specified global network
get_network_routesGets the network routes of the specified global network
get_network_telemetryGets the network telemetry of the specified global network
get_resource_policyReturns information about a resource policy
get_route_analysisGets information about the specified route analysis
get_sitesGets information about one or more of your sites in a global network
get_site_to_site_vpn_attachmentReturns information about a site-to-site VPN attachment
get_transit_gateway_connect_peer_associationsGets information about one or more of your transit gateway Connect peer associations in a global network
get_transit_gateway_peeringReturns information about a transit gateway peer
get_transit_gateway_registrationsGets information about the transit gateway registrations in a specified global network
get_transit_gateway_route_table_attachmentReturns information about a transit gateway route table attachment
get_vpc_attachmentReturns information about a VPC attachment
list_attachmentsReturns a list of core network attachments
list_connect_peersReturns a list of core network Connect peers
list_core_network_policy_versionsReturns a list of core network policy versions
list_core_networksReturns a list of owned and shared core networks
list_organization_service_access_statusGets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization
list_peeringsLists the peerings for a core network
list_tags_for_resourceLists the tags for a specified resource
put_core_network_policyCreates a new, immutable version of a core network policy
put_resource_policyCreates or updates a resource policy
register_transit_gatewayRegisters a transit gateway in your global network
reject_attachmentRejects a core network attachment request
restore_core_network_policy_versionRestores a previous policy version as a new, immutable version of a core network policy
start_organization_service_access_updateEnables the Network Manager service for an Amazon Web Services Organization
start_route_analysisStarts analyzing the routing path between the specified source and destination
tag_resourceTags a specified resource
untag_resourceRemoves tags from a specified resource
update_connectionUpdates the information for an existing connection
update_core_networkUpdates the description of a core network
update_deviceUpdates the details for an existing device
update_direct_connect_gateway_attachmentUpdates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment
update_global_networkUpdates an existing global network
update_linkUpdates the details for an existing link
update_network_resource_metadataUpdates the resource metadata for the specified global network
update_siteUpdates the information for an existing site
update_vpc_attachmentUpdates a VPC attachment

Examples

## Not run: svc <- networkmanager() svc$accept_attachment( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17