CreateVpcConnectorCommand

Suggest an Edit

Create an App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppRunnerClient, CreateVpcConnectorCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, CreateVpcConnectorCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // CreateVpcConnectorRequest
  VpcConnectorName: "STRING_VALUE", // required
  Subnets: [ // StringList // required
    "STRING_VALUE",
  ],
  SecurityGroups: [
    "STRING_VALUE",
  ],
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
};
const command = new CreateVpcConnectorCommand(input);
const response = await client.send(command);
// { // CreateVpcConnectorResponse
//   VpcConnector: { // VpcConnector
//     VpcConnectorName: "STRING_VALUE",
//     VpcConnectorArn: "STRING_VALUE",
//     VpcConnectorRevision: Number("int"),
//     Subnets: [ // StringList
//       "STRING_VALUE",
//     ],
//     SecurityGroups: [
//       "STRING_VALUE",
//     ],
//     Status: "ACTIVE" || "INACTIVE",
//     CreatedAt: new Date("TIMESTAMP"),
//     DeletedAt: new Date("TIMESTAMP"),
//   },
// };

CreateVpcConnectorCommand Input

See CreateVpcConnectorCommandInput for more details

Parameter
Type
Description
Subnets
Required
string[] | undefined

A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

App Runner currently only provides support for IPv4.

VpcConnectorName
Required
string | undefined

A name for the VPC connector.

SecurityGroups
string[] | undefined

A list of IDs of security groups that App Runner should use for access to Amazon Web Services resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

Tags
Tag[] | undefined

A list of metadata items that you can associate with your VPC connector resource. A tag is a key-value pair.

CreateVpcConnectorCommand Output

See CreateVpcConnectorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
VpcConnector
Required
VpcConnector | undefined

A description of the App Runner VPC connector that's created by this request.

Throws

Name
Fault
Details
InternalServiceErrorException
server

An unexpected service exception occurred.

InvalidRequestException
client

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

ServiceQuotaExceededException
client

App Runner can't create this resource. You've reached your account quota for this resource type.

For App Runner per-resource quotas, see App Runner endpoints and quotas  in the Amazon Web Services General Reference.

AppRunnerServiceException
Base exception class for all service exceptions from AppRunner service.