AmazonApiGatewayV2

/v2/vpclinks

POST

/v2/vpclinks

Creates a VPC link.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/vpclinks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "securityGroupIds": [
        "string"
    ],
    "subnetIds": [
        "string"
    ],
    "tags": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

201 - Example 1

{
  "CreatedDate": "string",
  "Name": "string",
  "SecurityGroupIds": [],
  "SubnetIds": [],
  "Tags": {
    "property1": "string",
    "property2": "string"
  },
  "VpcLinkId": "string",
  "VpcLinkStatus": "PENDING",
  "VpcLinkStatusMessage": "string",
  "VpcLinkVersion": "V2"
}

Request

Body Params application/json

name

string

required

A string with a length between [1-128].

securityGroupIds

array[string]

optional

A list of security group IDs for the VPC link.

subnetIds

array[string]

required

A list of subnet IDs to include in the VPC link.

tags

object

optional

Represents a collection of tags associated with the resource.

Additional properties

string

optional

A string with a length between [0-1600].

Examples

Responses

🟢201Success

application/json

Body

CreatedDate

string <date-time>

optional

The timestamp when the VPC link was created.

Name

string

optional

The name of the VPC link.

SecurityGroupIds

array[string]

optional

A list of security group IDs for the VPC link.

SubnetIds

array[string]

optional

A list of subnet IDs to include in the VPC link.

Tags

object

optional

Tags for the VPC link.

VpcLinkId

string

optional

The ID of the VPC link.

VpcLinkStatus

enum<string>

optional

The status of the VPC link.

Allowed values:

PENDINGAVAILABLEDELETINGFAILEDINACTIVE

VpcLinkStatusMessage

string

optional

A message summarizing the cause of the status of the VPC link.

VpcLinkVersion

enum<string>

optional

The version of the VPC link.

Allowed value:

V2

🟠480BadRequestException

🟠481TooManyRequestsException

Modified at 2023-08-15 05:49:07

/v2/apis/{apiId}/stages