StartDBClusterCommand

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster .

Example Syntax

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

import { DocDBClient, StartDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, StartDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // StartDBClusterMessage
  DBClusterIdentifier: "STRING_VALUE", // required
};
const command = new StartDBClusterCommand(input);
const response = await client.send(command);
// { // StartDBClusterResult
//   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,
//     StorageType: "STRING_VALUE",
//     MasterUserSecret: { // ClusterMasterUserSecret
//       SecretArn: "STRING_VALUE",
//       SecretStatus: "STRING_VALUE",
//       KmsKeyId: "STRING_VALUE",
//     },
//   },
// };

StartDBClusterCommand Input

See StartDBClusterCommandInput for more details

Parameter
Type
Description
DBClusterIdentifier
Required
string | undefined

The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

StartDBClusterCommand Output

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

Detailed information about a cluster.

Throws

Name
Fault
Details
DBClusterNotFoundFault
client

DBClusterIdentifier doesn't refer to an existing cluster.

InvalidDBClusterStateFault
client

The cluster isn't in a valid state.

InvalidDBInstanceStateFault
client

The specified instance isn't in the available state.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.