Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateConnectAttachment

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

Request Syntax


POST /connect-attachments HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "CoreNetworkId": "string",
   "EdgeLocation": "string",
   "Options": { 
      "Protocol": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TransportAttachmentId": "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 want to create the attachment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: ^core-network-([0-9a-f]{8,17})$

Required: Yes

EdgeLocation

The Region where the edge is located.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [\s\S]*

Required: Yes

Options

Options for creating an attachment.

Type: ConnectAttachmentOptions object

Required: Yes

Tags

The list of key-value tags associated with the request.

Type: Array of Tag objects

Required: No

TransportAttachmentId

The ID of the attachment between the two connections.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: ^attachment-([0-9a-f]{8,17})$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConnectAttachment": { 
      "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
      },
      "Options": { 
         "Protocol": "string"
      },
      "TransportAttachmentId": "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.

ConnectAttachment

The response to a Connect attachment request.

Type: ConnectAttachment 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