DeleteVpcConnectorCommand

Suggest an Edit

Delete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

Example Syntax

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

import { AppRunnerClient, DeleteVpcConnectorCommand } from "@aws-sdk/client-apprunner"; // ES Modules import
// const { AppRunnerClient, DeleteVpcConnectorCommand } = require("@aws-sdk/client-apprunner"); // CommonJS import
const client = new AppRunnerClient(config);
const input = { // DeleteVpcConnectorRequest
  VpcConnectorArn: "STRING_VALUE", // required
};
const command = new DeleteVpcConnectorCommand(input);
const response = await client.send(command);
// { // DeleteVpcConnectorResponse
//   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"),
//   },
// };

DeleteVpcConnectorCommand Input

See DeleteVpcConnectorCommandInput for more details

Parameter
Type
Description
VpcConnectorArn
Required
string | undefined

The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.

The ARN must be a full VPC connector ARN.

DeleteVpcConnectorCommand Output

See DeleteVpcConnectorCommandOutput 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 this request just deleted.

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.

ResourceNotFoundException
client

A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.

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