CreateSiteToSiteVpnAttachment
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.
Request Syntax
POST /site-to-site-vpn-attachments HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"CoreNetworkId": "string",
"NatGatewayRules": [
{
"MatchSourceCidr": "string",
"NatCidr": "string",
"RuleNumber": number
}
],
"NatGatewaySupport": "string",
"NatSystemRouteSupport": boolean,
"RoutingPolicyLabel": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpnConnectionArn": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- 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
- CoreNetworkId
-
The ID of a core network where you're creating a site-to-site VPN attachment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
^core-network-([0-9a-f]{8,17})$Required: Yes
- NatGatewayRules
-
The NAT rules for the Site-to-Site VPN attachment, up to 50 rules.
Type: Array of NatRuleRequest objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
- NatGatewaySupport
-
Specifies whether to enable NAT gateway support on the Site-to-Site VPN attachment. To enable NAT gateway support, you must also specify at least one NAT rule. If you don't specify a value, NAT gateway support is disabled. Only the core network owner can configure NAT on an attachment.
Type: String
Valid Values:
ENABLE | DISABLERequired: No
- NatSystemRouteSupport
-
Specifies whether the core network installs system routes for the NAT CIDR blocks of the attachment's NAT rules. System routes have a route type of
SYSTEM. NAT is applied to traffic whether or not this option is enabled. The default istruefor VPN connections that use BGP andfalsefor VPN connections that use static routing. If the VPN connection uses static routing, you must specifyfalseor omit this parameter.Type: Boolean
Required: No
- RoutingPolicyLabel
-
The routing policy label to apply to the Site-to-Site VPN attachment for traffic routing decisions.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
[\s\S]*Required: No
- Tags
-
The tags associated with the request.
Type: Array of Tag objects
Required: No
- VpnConnectionArn
-
The ARN identifying the VPN attachment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\/vpn-[0-9a-f]{8,17}$Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"SiteToSiteVpnAttachment": {
"Attachment": {
"AttachmentId": "string",
"AttachmentPolicyRuleNumber": number,
"AttachmentType": "string",
"CoreNetworkArn": "string",
"CoreNetworkId": "string",
"CreatedAt": number,
"EdgeLocation": "string",
"EdgeLocations": [ "string" ],
"LastModificationErrors": [
{
"Code": "string",
"Message": "string",
"RequestId": "string",
"ResourceArn": "string"
}
],
"NatGatewaySupport": "string",
"NatSystemRouteSupport": boolean,
"NetworkFunctionGroupName": "string",
"OwnerAccountId": "string",
"ProposedNetworkFunctionGroupChange": {
"AttachmentPolicyRuleNumber": number,
"NetworkFunctionGroupName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
},
"ProposedSegmentChange": {
"AttachmentPolicyRuleNumber": number,
"SegmentName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
},
"ResourceArn": "string",
"SegmentName": "string",
"State": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UpdatedAt": number
},
"VpnConnectionArn": "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.
- SiteToSiteVpnAttachment
-
Details about a site-to-site VPN attachment.
Type: SiteToSiteVpnAttachment object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- 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.
- ResourceId
-
The ID of the resource.
- ResourceType
-
The resource type.
HTTP Status Code: 409
- InternalServerException
-
The request has failed due to an internal error.
- RetryAfterSeconds
-
Indicates when to retry the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
- Context
-
The specified resource could not be found.
- ResourceId
-
The ID of the resource.
- ResourceType
-
The resource type.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
- RetryAfterSeconds
-
Indicates when to retry the request.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints.
- Fields
-
The fields that caused the error, if applicable.
- Reason
-
The reason for the error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: