DeleteTransitGatewayVpcAttachmentCommand

Suggest an Edit

Deletes the specified VPC attachment.

Example Syntax

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

import { EC2Client, DeleteTransitGatewayVpcAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DeleteTransitGatewayVpcAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DeleteTransitGatewayVpcAttachmentRequest
  TransitGatewayAttachmentId: "STRING_VALUE", // required
  DryRun: true || false,
};
const command = new DeleteTransitGatewayVpcAttachmentCommand(input);
const response = await client.send(command);
// { // DeleteTransitGatewayVpcAttachmentResult
//   TransitGatewayVpcAttachment: { // TransitGatewayVpcAttachment
//     TransitGatewayAttachmentId: "STRING_VALUE",
//     TransitGatewayId: "STRING_VALUE",
//     VpcId: "STRING_VALUE",
//     VpcOwnerId: "STRING_VALUE",
//     State: "initiating" || "initiatingRequest" || "pendingAcceptance" || "rollingBack" || "pending" || "available" || "modifying" || "deleting" || "deleted" || "failed" || "rejected" || "rejecting" || "failing",
//     SubnetIds: [ // ValueStringList
//       "STRING_VALUE",
//     ],
//     CreationTime: new Date("TIMESTAMP"),
//     Options: { // TransitGatewayVpcAttachmentOptions
//       DnsSupport: "enable" || "disable",
//       SecurityGroupReferencingSupport: "enable" || "disable",
//       Ipv6Support: "enable" || "disable",
//       ApplianceModeSupport: "enable" || "disable",
//     },
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//   },
// };

DeleteTransitGatewayVpcAttachmentCommand Input

See DeleteTransitGatewayVpcAttachmentCommandInput for more details

Parameter
Type
Description
TransitGatewayAttachmentId
Required
string | undefined

The ID of the attachment.

DryRun
boolean | undefined

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

DeleteTransitGatewayVpcAttachmentCommand Output

See DeleteTransitGatewayVpcAttachmentCommandOutput for details

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

Information about the deleted VPC attachment.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.