CreateSiteToSiteVpnAttachment - AWS Network Manager

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", "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

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", "OwnerAccountId": "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 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: