Skip to content

Starts executing a Recovery Plan in DRILL or RECOVERY mode

Description

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.

Usage

drs_start_recovery_plan_execution(recoveryPlanArn, mode, clientToken,
  sourceServers, tags)

Arguments

  • recoveryPlanArn

    [required] The ARN of the Recovery Plan to execute.

  • mode

    [required] The execution mode (DRILL or RECOVERY).

  • clientToken

    A unique string provided to ensure request idempotency.

  • sourceServers

    Optional list of source servers with specific recovery snapshots. If not provided, the latest snapshot is used for each server.

  • tags

    The tags to apply to the Recovery Plan execution.

Value

A list with the following syntax:

list(
  recoveryPlanExecution = list(
    recoveryPlanExecutionArn = "string",
    recoveryPlanArn = "string",
    mode = "DRILL"|"RECOVERY",
    status = "CREATED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELLING"|"CANCELLED",
    startedAt = "string",
    completedAt = "string",
    errorDetail = list(
      message = "string",
      code = "string"
    ),
    tags = list(
      "string"
    )
  )
)

Request syntax

svc$start_recovery_plan_execution(
  recoveryPlanArn = "string",
  mode = "DRILL"|"RECOVERY",
  clientToken = "string",
  sourceServers = list(
    list(
      sourceServerID = "string",
      recoverySnapshotID = "string"
    )
  ),
  tags = list(
    "string"
  )
)