[ aws . apigatewayv2 ]

create-vpc-link

Description

Creates a VPC link.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-vpc-link
--name <value>
[--security-group-ids <value>]
--subnet-ids <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

The name of the VPC link.

--security-group-ids (list)

A list of security group IDs for the VPC link.

(string)

Syntax:

"string" "string" ...

--subnet-ids (list)

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

(string)

Syntax:

"string" "string" ...

--tags (map)

A list of tags.

key -> (string)

value -> (string)

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

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a VPC link for an HTTP API

The following create-vpc-link example creates a VPC link for HTTP APIs.

aws apigatewayv2 create-vpc-link \
    --name MyVpcLink \
    --subnet-ids subnet-aaaa subnet-bbbb \
    --security-group-ids sg1234 sg5678

Output:

{
    "CreatedDate": "2020-04-07T00:11:46Z",
    "Name": "MyVpcLink",
    "SecurityGroupIds": [
        "sg1234",
        "sg5678"
    ],
    "SubnetIds": [
        "subnet-aaaa",
        "subnet-bbbb"
    ],
    "Tags": {},
    "VpcLinkId": "abcd123",
    "VpcLinkStatus": "PENDING",
    "VpcLinkStatusMessage": "VPC link is provisioning ENIs",
    "VpcLinkVersion": "V2"
}

For more information, see Working with VPC links for HTTP APIs in the Amazon API Gateway Developer Guide.

Output

CreatedDate -> (timestamp)

The timestamp when the VPC link was created.

Name -> (string)

The name of the VPC link.

SecurityGroupIds -> (list)

A list of security group IDs for the VPC link.

(string)

SubnetIds -> (list)

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

(string)

Tags -> (map)

Tags for the VPC link.

key -> (string)

value -> (string)

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

VpcLinkId -> (string)

The ID of the VPC link.

VpcLinkStatus -> (string)

The status of the VPC link.

VpcLinkStatusMessage -> (string)

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

VpcLinkVersion -> (string)

The version of the VPC link.