import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DeleteDBClusterMessage, DeleteDBClusterResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DeleteDBClusterCommand}. */ export interface DeleteDBClusterCommandInput extends DeleteDBClusterMessage { } /** * @public * * The output of {@link DeleteDBClusterCommand}. */ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __MetadataBearer { } declare const DeleteDBClusterCommand_base: { new (input: DeleteDBClusterCommandInput): import("@smithy/core/client").CommandImpl; new (input: DeleteDBClusterCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

*

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DocDBClient, DeleteDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import * // const { DocDBClient, DeleteDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import * // import type { DocDBClientConfig } from "@aws-sdk/client-docdb"; * const config = {}; // type is DocDBClientConfig * const client = new DocDBClient(config); * const input = { // DeleteDBClusterMessage * DBClusterIdentifier: "STRING_VALUE", // required * SkipFinalSnapshot: true || false, * FinalDBSnapshotIdentifier: "STRING_VALUE", * }; * const command = new DeleteDBClusterCommand(input); * const response = await client.send(command); * // { // DeleteDBClusterResult * // DBCluster: { // DBCluster * // AvailabilityZones: [ // AvailabilityZones * // "STRING_VALUE", * // ], * // BackupRetentionPeriod: Number("int"), * // DBClusterIdentifier: "STRING_VALUE", * // DBClusterParameterGroup: "STRING_VALUE", * // DBSubnetGroup: "STRING_VALUE", * // Status: "STRING_VALUE", * // PercentProgress: "STRING_VALUE", * // EarliestRestorableTime: new Date("TIMESTAMP"), * // Endpoint: "STRING_VALUE", * // ReaderEndpoint: "STRING_VALUE", * // MultiAZ: true || false, * // Engine: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // LatestRestorableTime: new Date("TIMESTAMP"), * // Port: Number("int"), * // MasterUsername: "STRING_VALUE", * // PreferredBackupWindow: "STRING_VALUE", * // PreferredMaintenanceWindow: "STRING_VALUE", * // ReplicationSourceIdentifier: "STRING_VALUE", * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList * // "STRING_VALUE", * // ], * // DBClusterMembers: [ // DBClusterMemberList * // { // DBClusterMember * // DBInstanceIdentifier: "STRING_VALUE", * // IsClusterWriter: true || false, * // DBClusterParameterGroupStatus: "STRING_VALUE", * // PromotionTier: Number("int"), * // }, * // ], * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList * // { // VpcSecurityGroupMembership * // VpcSecurityGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // HostedZoneId: "STRING_VALUE", * // StorageEncrypted: true || false, * // KmsKeyId: "STRING_VALUE", * // DbClusterResourceId: "STRING_VALUE", * // DBClusterArn: "STRING_VALUE", * // AssociatedRoles: [ // DBClusterRoles * // { // DBClusterRole * // RoleArn: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // CloneGroupId: "STRING_VALUE", * // ClusterCreateTime: new Date("TIMESTAMP"), * // EnabledCloudwatchLogsExports: [ // LogTypeList * // "STRING_VALUE", * // ], * // DeletionProtection: true || false, * // IOOptimizedNextAllowedModificationTime: new Date("TIMESTAMP"), * // StorageType: "STRING_VALUE", * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo * // MinCapacity: Number("double"), * // MaxCapacity: Number("double"), * // }, * // MasterUserSecret: { // ClusterMasterUserSecret * // SecretArn: "STRING_VALUE", * // SecretStatus: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // }, * // NetworkType: "STRING_VALUE", * // }, * // }; * * ``` * * @param DeleteDBClusterCommandInput - {@link DeleteDBClusterCommandInput} * @returns {@link DeleteDBClusterCommandOutput} * @see {@link DeleteDBClusterCommandInput} for command's `input` shape. * @see {@link DeleteDBClusterCommandOutput} for command's `response` shape. * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape. * * @throws {@link DBClusterNotFoundFault} (client fault) *

* DBClusterIdentifier doesn't refer to an existing cluster.

* * @throws {@link DBClusterSnapshotAlreadyExistsFault} (client fault) *

You already have a cluster snapshot with the given identifier.

* * @throws {@link InvalidDBClusterSnapshotStateFault} (client fault) *

The provided value isn't a valid cluster snapshot state.

* * @throws {@link InvalidDBClusterStateFault} (client fault) *

The cluster isn't in a valid state.

* * @throws {@link SnapshotQuotaExceededFault} (client fault) *

The request would cause you to exceed the allowed number of snapshots.

* * @throws {@link DocDBServiceException} *

Base exception class for all service exceptions from DocDB service.

* * * @public */ export declare class DeleteDBClusterCommand extends DeleteDBClusterCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteDBClusterMessage; output: DeleteDBClusterResult; }; sdk: { input: DeleteDBClusterCommandInput; output: DeleteDBClusterCommandOutput; }; }; }