Skip to content

Updates the information for an existing connection

Description

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

Usage

networkmanager_update_connection(GlobalNetworkId, ConnectionId, LinkId,
  ConnectedLinkId, Description)

Arguments

  • GlobalNetworkId

    [required] The ID of the global network.

  • ConnectionId

    [required] The ID of the connection.

  • LinkId

    The ID of the link for the first device in the connection.

  • ConnectedLinkId

    The ID of the link for the second device in the connection.

  • Description

    A description of the connection.

    Length Constraints: Maximum length of 256 characters.

Value

A list with the following syntax:

list(
  Connection = list(
    ConnectionId = "string",
    ConnectionArn = "string",
    GlobalNetworkId = "string",
    DeviceId = "string",
    ConnectedDeviceId = "string",
    LinkId = "string",
    ConnectedLinkId = "string",
    Description = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    State = "PENDING"|"AVAILABLE"|"DELETING"|"UPDATING",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$update_connection(
  GlobalNetworkId = "string",
  ConnectionId = "string",
  LinkId = "string",
  ConnectedLinkId = "string",
  Description = "string"
)