Functions
Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.
Cancels an in-progress Recovery Plan execution. Remaining steps are skipped.
Create an extended source server in the target Account based on the source server in staging account.
Creates a new Launch Configuration Template.
Creates a Recovery Plan to orchestrate multi-server disaster recovery.
Creates a step in a Recovery Plan. A step is either SERVER type (servers to recover in parallel) or WAIT type (timed pause between steps).
Creates a new ReplicationConfigurationTemplate.
Create a new Source Network resource for a provided VPC ID.
Deletes a single Job by ID.
Deletes a resource launch action.
Deletes a single Launch Configuration Template by ID.
Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.
Deletes a Recovery Plan. Cannot delete a plan that has an execution in a non-terminal status (CREATED, IN_PROGRESS).
Deletes a Recovery Plan execution record. Must be in a terminal status.
Deletes a step from a Recovery Plan.
Deletes a single Replication Configuration Template by ID
Delete Source Network resource.
Deletes a single Source Server by ID. The Source Server must be disconnected first.
Retrieves a detailed Job log with pagination.
Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.
Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
Lists all Recovery Instances or multiple Recovery Instances by ID.
Lists all Recovery Snapshots for a single Source Server.
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
Lists all Source Networks or multiple Source Networks filtered by ID.
Lists all Source Servers or multiple Source Servers filtered by ID.
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.
Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server 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 SourceServer 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.
Export the Source Network CloudFormation template to an S3 bucket.
Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
Gets a LaunchConfiguration, filtered by Source Server IDs.
Gets a Recovery Plan by ARN.
Gets the details of a Recovery Plan execution.
Gets the details of a step within a Recovery Plan execution.
Gets a Recovery Plan step by ARN.
Gets a ReplicationConfiguration, filtered by Source Server ID.
Initialize Elastic Disaster Recovery.
Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.
Lists resource launch actions.
Lists executions of Recovery Plans, optionally filtered by plan or status.
Lists all steps within a Recovery Plan execution.
Lists all Recovery Plans in the account.
Lists all steps in a Recovery Plan.
Returns an array of staging accounts for existing extended source servers.
List all tags for your Elastic Disaster Recovery resources.
Puts a resource launch action.
Reorders steps in a Recovery Plan. Accepts a complete ordered list of step ARNs.
WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.
Retries a failed SERVER type execution step.
Start replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them.
Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.
Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.
Starts executing a Recovery Plan in DRILL or RECOVERY mode. A plan cannot have more than one execution in a non-terminal status at a time.
Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.
Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.
Starts replication for a Source Network. This action would make the Source Network protected.
Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.
Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.
Stops replication for a Source Network. This action would make the Source Network unprotected.
Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.
Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.
Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
Allows you to update the failback replication configuration of a Recovery Instance by ID.
Updates a LaunchConfiguration by Source Server ID.
Updates an existing Launch Configuration Template by ID.
Updates a Recovery Plan's name or description.
Updates an execution step. Supports two actions: (1) skip a step that is in NOT_STARTED or FAILED status; (2) update the wait duration of a WAIT type step that is in NOT_STARTED status.
Updates a Recovery Plan step's name or configuration. Step type is immutable.
Allows you to update a ReplicationConfiguration by Source Server ID.
Updates a ReplicationConfigurationTemplate by ID.
Inherited functions
Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.
Cancels an in-progress Recovery Plan execution. Remaining steps are skipped.
Create an extended source server in the target Account based on the source server in staging account.
Creates a new Launch Configuration Template.
Creates a Recovery Plan to orchestrate multi-server disaster recovery.
Creates a step in a Recovery Plan. A step is either SERVER type (servers to recover in parallel) or WAIT type (timed pause between steps).
Creates a new ReplicationConfigurationTemplate.
Create a new Source Network resource for a provided VPC ID.
Deletes a single Job by ID.
Deletes a resource launch action.
Deletes a single Launch Configuration Template by ID.
Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.
Deletes a Recovery Plan. Cannot delete a plan that has an execution in a non-terminal status (CREATED, IN_PROGRESS).
Deletes a Recovery Plan execution record. Must be in a terminal status.
Deletes a step from a Recovery Plan.
Deletes a single Replication Configuration Template by ID
Delete Source Network resource.
Deletes a single Source Server by ID. The Source Server must be disconnected first.
Retrieves a detailed Job log with pagination.
Paginate over DescribeJobLogItemsResponse results.
Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.
Paginate over DescribeJobsResponse results.
Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
Paginate over DescribeLaunchConfigurationTemplatesResponse results.
Lists all Recovery Instances or multiple Recovery Instances by ID.
Paginate over DescribeRecoveryInstancesResponse results.
Lists all Recovery Snapshots for a single Source Server.
Paginate over DescribeRecoverySnapshotsResponse results.
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
Paginate over DescribeReplicationConfigurationTemplatesResponse results.
Lists all Source Networks or multiple Source Networks filtered by ID.
Paginate over DescribeSourceNetworksResponse results.
Lists all Source Servers or multiple Source Servers filtered by ID.
Paginate over DescribeSourceServersResponse results.
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.
Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server 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 SourceServer 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.
Export the Source Network CloudFormation template to an S3 bucket.
Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
Gets a LaunchConfiguration, filtered by Source Server IDs.
Gets a Recovery Plan by ARN.
Gets the details of a Recovery Plan execution.
Gets the details of a step within a Recovery Plan execution.
Gets a Recovery Plan step by ARN.
Gets a ReplicationConfiguration, filtered by Source Server ID.
Initialize Elastic Disaster Recovery.
Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.
Paginate over ListExtensibleSourceServersResponse results.
Lists resource launch actions.
Paginate over ListLaunchActionsResponse results.
Lists executions of Recovery Plans, optionally filtered by plan or status.
Paginate over ListRecoveryPlanExecutionsResponse results.
Lists all steps within a Recovery Plan execution.
Paginate over ListRecoveryPlanExecutionStepsResponse results.
Lists all Recovery Plans in the account.
Paginate over ListRecoveryPlansResponse results.
Lists all steps in a Recovery Plan.
Paginate over ListRecoveryPlanStepsResponse results.
Returns an array of staging accounts for existing extended source servers.
Paginate over ListStagingAccountsResponse results.
List all tags for your Elastic Disaster Recovery resources.
Puts a resource launch action.
Reorders steps in a Recovery Plan. Accepts a complete ordered list of step ARNs.
WARNING: RetryDataReplication is deprecated. Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.
Retries a failed SERVER type execution step.
Start replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them.
Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.
Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.
Starts executing a Recovery Plan in DRILL or RECOVERY mode. A plan cannot have more than one execution in a non-terminal status at a time.
Starts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.
Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.
Starts replication for a Source Network. This action would make the Source Network protected.
Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.
Stops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.
Stops replication for a Source Network. This action would make the Source Network unprotected.
Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.
Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.
Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
Allows you to update the failback replication configuration of a Recovery Instance by ID.
Updates a LaunchConfiguration by Source Server ID.
Updates an existing Launch Configuration Template by ID.
Updates a Recovery Plan's name or description.
Updates an execution step. Supports two actions: (1) skip a step that is in NOT_STARTED or FAILED status; (2) update the wait duration of a WAIT type step that is in NOT_STARTED status.
Updates a Recovery Plan step's name or configuration. Step type is immutable.
Allows you to update a ReplicationConfiguration by Source Server ID.
Updates a ReplicationConfigurationTemplate by ID.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.