DisconnectRecoveryInstanceCommand

Suggest an Edit

Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Example Syntax

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

import { DrsClient, DisconnectRecoveryInstanceCommand } from "@aws-sdk/client-drs"; // ES Modules import
// const { DrsClient, DisconnectRecoveryInstanceCommand } = require("@aws-sdk/client-drs"); // CommonJS import
const client = new DrsClient(config);
const input = { // DisconnectRecoveryInstanceRequest
  recoveryInstanceID: "STRING_VALUE", // required
};
const command = new DisconnectRecoveryInstanceCommand(input);
const response = await client.send(command);
// {};

DisconnectRecoveryInstanceCommand Input

See DisconnectRecoveryInstanceCommandInput for more details

Parameter
Type
Description
recoveryInstanceID
Required
string | undefined

The ID of the Recovery Instance to disconnect.

DisconnectRecoveryInstanceCommand Output

See DisconnectRecoveryInstanceCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

The request could not be completed due to a conflict with the current state of the target resource.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The resource for this operation was not found.

ThrottlingException
client

The request was denied due to request throttling.

UninitializedAccountException
client

The account performing the request has not been initialized.

DrsServiceException
Base exception class for all service exceptions from Drs service.