Skip to content

Update Link

networkmanager_update_link R Documentation

Description

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

Usage

networkmanager_update_link(GlobalNetworkId, LinkId, Description, Type,
  Bandwidth, Provider)

Arguments

GlobalNetworkId

[required] The ID of the global network.

LinkId

[required] The ID of the link.

Description

A description of the link.

Constraints: Maximum length of 256 characters.

Type

The type of the link.

Constraints: Maximum length of 128 characters.

Bandwidth

The upload and download speed in Mbps.

Provider

The provider of the link.

Constraints: Maximum length of 128 characters.

Value

A list with the following syntax: 

list(
  Link = list(
    LinkId = "string",
    LinkArn = "string",
    GlobalNetworkId = "string",
    SiteId = "string",
    Description = "string",
    Type = "string",
    Bandwidth = list(
      UploadSpeed = 123,
      DownloadSpeed = 123
    ),
    Provider = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    State = "PENDING"|"AVAILABLE"|"DELETING"|"UPDATING",
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$update_link(
  GlobalNetworkId = "string",
  LinkId = "string",
  Description = "string",
  Type = "string",
  Bandwidth = list(
    UploadSpeed = 123,
    DownloadSpeed = 123
  ),
  Provider = "string"
)