Skip to content

Associate Transit Gateway Connect Peer

networkmanager_associate_transit_gateway_connect_peer R Documentation

Description

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.

Usage

networkmanager_associate_transit_gateway_connect_peer(GlobalNetworkId,
  TransitGatewayConnectPeerArn, DeviceId, LinkId)

Arguments

GlobalNetworkId

[required] The ID of the global network.

TransitGatewayConnectPeerArn

[required] The Amazon Resource Name (ARN) of the Connect peer.

DeviceId

[required] The ID of the device.

LinkId

The ID of the link.

Value

A list with the following syntax:

list(
  TransitGatewayConnectPeerAssociation = list(
    TransitGatewayConnectPeerArn = "string",
    GlobalNetworkId = "string",
    DeviceId = "string",
    LinkId = "string",
    State = "PENDING"|"AVAILABLE"|"DELETING"|"DELETED"
  )
)

Request syntax

svc$associate_transit_gateway_connect_peer(
  GlobalNetworkId = "string",
  TransitGatewayConnectPeerArn = "string",
  DeviceId = "string",
  LinkId = "string"
)