Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
Request Syntax
POST /connect-peers HTTP/1.1
Content-type: application/json
{
"BgpOptions": {
"PeerAsn": number
},
"ClientToken": "string",
"ConnectAttachmentId": "string",
"CoreNetworkAddress": "string",
"InsideCidrBlocks": [ "string" ],
"PeerAddress": "string",
"SubnetArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- BgpOptions
-
The Connect peer BGP options. This only applies only when the protocol is
GRE.Type: BgpOptions object
Required: No
- ClientToken
-
The client token associated with the request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\s\S]*Required: No
- ConnectAttachmentId
-
The ID of the connection attachment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
^attachment-([0-9a-f]{8,17})$Required: Yes
- CoreNetworkAddress
-
A Connect peer core network address. This only applies only when the protocol is
GRE.Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[\s\S]*Required: No
- InsideCidrBlocks
-
The inside IP addresses used for BGP peering.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\s\S]*Required: No
- PeerAddress
-
The Connect peer address.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[\s\S]*Required: Yes
- SubnetArn
-
The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\/subnet-[0-9a-f]{8,17}$|^$Required: No
- Tags
-
The tags associated with the peer request.
Type: Array of Tag objects
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ConnectPeer": {
"Configuration": {
"BgpConfigurations": [
{
"CoreNetworkAddress": "string",
"CoreNetworkAsn": number,
"PeerAddress": "string",
"PeerAsn": number
}
],
"CoreNetworkAddress": "string",
"InsideCidrBlocks": [ "string" ],
"PeerAddress": "string",
"Protocol": "string"
},
"ConnectAttachmentId": "string",
"ConnectPeerId": "string",
"CoreNetworkId": "string",
"CreatedAt": number,
"EdgeLocation": "string",
"LastModificationErrors": [
{
"Code": "string",
"Message": "string",
"RequestId": "string",
"ResourceArn": "string"
}
],
"State": "string",
"SubnetArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ConnectPeer
-
The response to the request.
Type: ConnectPeer object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
The request has failed due to an internal error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
