Associate Customer Gateway
networkmanager_associate_customer_gateway | R Documentation |
Associates a customer gateway with a device and optionally, with a link¶
Description¶
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.
You can only associate customer gateways that are connected to a VPN
attachment on a transit gateway or core network registered in your
global network. When you register a transit gateway or core network,
customer gateways that are connected to the transit gateway are
automatically included in the global network. To list customer gateways
that are connected to a transit gateway, use the
DescribeVpnConnections
EC2 API and filter by transit-gateway-id
.
You cannot associate a customer gateway with more than one device and link.
Usage¶
networkmanager_associate_customer_gateway(CustomerGatewayArn,
GlobalNetworkId, DeviceId, LinkId)
Arguments¶
CustomerGatewayArn |
[required] The Amazon Resource Name (ARN) of the customer gateway. |
GlobalNetworkId |
[required] The ID of the global network. |
DeviceId |
[required] The ID of the device. |
LinkId |
The ID of the link. |
Value¶
A list with the following syntax:
list(
CustomerGatewayAssociation = list(
CustomerGatewayArn = "string",
GlobalNetworkId = "string",
DeviceId = "string",
LinkId = "string",
State = "PENDING"|"AVAILABLE"|"DELETING"|"DELETED"
)
)
Request syntax¶
svc$associate_customer_gateway(
CustomerGatewayArn = "string",
GlobalNetworkId = "string",
DeviceId = "string",
LinkId = "string"
)