- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteDBInstanceCommand
Deletes a previously provisioned instance.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DocDBClient, DeleteDBInstanceCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, DeleteDBInstanceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // DeleteDBInstanceMessage
DBInstanceIdentifier: "STRING_VALUE", // required
};
const command = new DeleteDBInstanceCommand(input);
const response = await client.send(command);
// { // DeleteDBInstanceResult
// DBInstance: { // DBInstance
// DBInstanceIdentifier: "STRING_VALUE",
// DBInstanceClass: "STRING_VALUE",
// Engine: "STRING_VALUE",
// DBInstanceStatus: "STRING_VALUE",
// Endpoint: { // Endpoint
// Address: "STRING_VALUE",
// Port: Number("int"),
// HostedZoneId: "STRING_VALUE",
// },
// InstanceCreateTime: new Date("TIMESTAMP"),
// PreferredBackupWindow: "STRING_VALUE",
// BackupRetentionPeriod: Number("int"),
// VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
// { // VpcSecurityGroupMembership
// VpcSecurityGroupId: "STRING_VALUE",
// Status: "STRING_VALUE",
// },
// ],
// AvailabilityZone: "STRING_VALUE",
// DBSubnetGroup: { // DBSubnetGroup
// DBSubnetGroupName: "STRING_VALUE",
// DBSubnetGroupDescription: "STRING_VALUE",
// VpcId: "STRING_VALUE",
// SubnetGroupStatus: "STRING_VALUE",
// Subnets: [ // SubnetList
// { // Subnet
// SubnetIdentifier: "STRING_VALUE",
// SubnetAvailabilityZone: { // AvailabilityZone
// Name: "STRING_VALUE",
// },
// SubnetStatus: "STRING_VALUE",
// },
// ],
// DBSubnetGroupArn: "STRING_VALUE",
// },
// PreferredMaintenanceWindow: "STRING_VALUE",
// PendingModifiedValues: { // PendingModifiedValues
// DBInstanceClass: "STRING_VALUE",
// AllocatedStorage: Number("int"),
// MasterUserPassword: "STRING_VALUE",
// Port: Number("int"),
// BackupRetentionPeriod: Number("int"),
// MultiAZ: true || false,
// EngineVersion: "STRING_VALUE",
// LicenseModel: "STRING_VALUE",
// Iops: Number("int"),
// DBInstanceIdentifier: "STRING_VALUE",
// StorageType: "STRING_VALUE",
// CACertificateIdentifier: "STRING_VALUE",
// DBSubnetGroupName: "STRING_VALUE",
// PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
// LogTypesToEnable: [ // LogTypeList
// "STRING_VALUE",
// ],
// LogTypesToDisable: [
// "STRING_VALUE",
// ],
// },
// },
// LatestRestorableTime: new Date("TIMESTAMP"),
// EngineVersion: "STRING_VALUE",
// AutoMinorVersionUpgrade: true || false,
// PubliclyAccessible: true || false,
// StatusInfos: [ // DBInstanceStatusInfoList
// { // DBInstanceStatusInfo
// StatusType: "STRING_VALUE",
// Normal: true || false,
// Status: "STRING_VALUE",
// Message: "STRING_VALUE",
// },
// ],
// DBClusterIdentifier: "STRING_VALUE",
// StorageEncrypted: true || false,
// KmsKeyId: "STRING_VALUE",
// DbiResourceId: "STRING_VALUE",
// CACertificateIdentifier: "STRING_VALUE",
// CopyTagsToSnapshot: true || false,
// PromotionTier: Number("int"),
// DBInstanceArn: "STRING_VALUE",
// EnabledCloudwatchLogsExports: [
// "STRING_VALUE",
// ],
// CertificateDetails: { // CertificateDetails
// CAIdentifier: "STRING_VALUE",
// ValidTill: new Date("TIMESTAMP"),
// },
// PerformanceInsightsEnabled: true || false,
// PerformanceInsightsKMSKeyId: "STRING_VALUE",
// },
// };
DeleteDBInstanceCommand Input
See DeleteDBInstanceCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
DBInstanceIdentifier Required | string | undefined | The instance identifier for the instance to be deleted. This parameter isn't case sensitive. Constraints:
|
DeleteDBInstanceCommand Output
See DeleteDBInstanceCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
DBInstance | DBInstance | undefined | Detailed information about an instance. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
DBInstanceNotFoundFault | client | |
DBSnapshotAlreadyExistsFault | client | |
InvalidDBClusterStateFault | client | The cluster isn't in a valid state. |
InvalidDBInstanceStateFault | client | The specified instance isn't in the available state. |
SnapshotQuotaExceededFault | client | The request would cause you to exceed the allowed number of snapshots. |
DocDBServiceException | Base exception class for all service exceptions from DocDB service. |