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

CreateDirectConnectGatewayAttachment

Creates an AWS Direct Connect gateway attachment

Request Syntax


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

{
   "ClientToken": "string",
   "CoreNetworkId": "string",
   "DirectConnectGatewayArn": "string",
   "EdgeLocations": [ "string" ],
   "NatGatewayRules": [ 
      { 
         "MatchSourceCidr": "string",
         "NatCidr": "string",
         "RuleNumber": number
      }
   ],
   "NatGatewaySupport": "string",
   "NatSystemRouteSupport": boolean,
   "RoutingPolicyLabel": "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.

ClientToken

client token

Type: String

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

Pattern: [\s\S]*

Required: No

CoreNetworkId

The ID of the Cloud WAN core network that the Direct Connect gateway attachment should be attached to.

Type: String

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

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

Required: Yes

DirectConnectGatewayArn

The ARN of the Direct Connect gateway attachment.

Type: String

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

Pattern: ^arn:[^:]{1,63}:directconnect::[^:]{0,63}:dx-gateway\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$

Required: Yes

EdgeLocations

One or more core network edge locations that the Direct Connect gateway attachment is associated with.

Type: Array of strings

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

Pattern: [\s\S]*

Required: Yes

NatGatewayRules

The NAT rules for the Direct Connect gateway 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 Direct Connect gateway 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 | DISABLE

Required: 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 is true.

Type: Boolean

Required: No

RoutingPolicyLabel

The routing policy label to apply to the Direct Connect Gateway attachment for traffic routing decisions.

Type: String

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

Pattern: [\s\S]*

Required: No

Tags

The key value tags to apply to the Direct Connect gateway attachment during creation.

Type: Array of Tag objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DirectConnectGatewayAttachment": { 
      "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
      },
      "DirectConnectGatewayArn": "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.

DirectConnectGatewayAttachment

Describes the details of a CreateDirectConnectGatewayAttachment request.

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