DeleteDBProxyEndpointCommand

Suggest an Edit

Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.

Example Syntax

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

import { RDSClient, DeleteDBProxyEndpointCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, DeleteDBProxyEndpointCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // DeleteDBProxyEndpointRequest
  DBProxyEndpointName: "STRING_VALUE", // required
};
const command = new DeleteDBProxyEndpointCommand(input);
const response = await client.send(command);
// { // DeleteDBProxyEndpointResponse
//   DBProxyEndpoint: { // DBProxyEndpoint
//     DBProxyEndpointName: "STRING_VALUE",
//     DBProxyEndpointArn: "STRING_VALUE",
//     DBProxyName: "STRING_VALUE",
//     Status: "available" || "modifying" || "incompatible-network" || "insufficient-resource-limits" || "creating" || "deleting",
//     VpcId: "STRING_VALUE",
//     VpcSecurityGroupIds: [ // StringList
//       "STRING_VALUE",
//     ],
//     VpcSubnetIds: [
//       "STRING_VALUE",
//     ],
//     Endpoint: "STRING_VALUE",
//     CreatedDate: new Date("TIMESTAMP"),
//     TargetRole: "READ_WRITE" || "READ_ONLY",
//     IsDefault: true || false,
//   },
// };

DeleteDBProxyEndpointCommand Input

See DeleteDBProxyEndpointCommandInput for more details

Parameter
Type
Description
DBProxyEndpointName
Required
string | undefined

The name of the DB proxy endpoint to delete.

DeleteDBProxyEndpointCommand Output

See DeleteDBProxyEndpointCommandOutput for details

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

The data structure representing the details of the DB proxy endpoint that you delete.

Throws

Name
Fault
Details
DBProxyEndpointNotFoundFault
client

The DB proxy endpoint doesn't exist.

InvalidDBProxyEndpointStateFault
client

You can't perform this operation while the DB proxy endpoint is in a particular state.

RDSServiceException
Base exception class for all service exceptions from RDS service.