CreateTransitGatewayConnectPeer - Amazon Elastic Compute Cloud


Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

For more information, see Connect peers in the AWS Transit Gateways Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.


The BGP options for the Connect peer.

Type: TransitGatewayConnectRequestBgpOptions object

Required: No


Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No


The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the fd00::/8 range.

Type: Array of strings

Required: Yes


The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

Type: String

Required: Yes


The tags to apply to the Connect peer.

Type: Array of TagSpecification objects

Required: No


The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.

Type: String

Required: No


The ID of the Connect attachment.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.


The ID of the request.

Type: String


Information about the Connect peer.

Type: TransitGatewayConnectPeer object


For information about the errors that are common to all actions, see Common client error codes.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: