recovery_plan_execution_steps

Creates, updates, deletes, gets or lists a recovery_plan_execution_steps resource.

Overview

Name	recovery_plan_execution_steps
Type	Resource
Id	aws.drs.recovery_plan_execution_steps

Fields

The following fields are returned by SELECT queries:

get_recovery_plan_execution_step

Name	Datatype	Description
attempt	integer	The number of times this step has been attempted.
configuration	object	Type-specific configuration for an execution step response. Mirrors RecoveryPlanStepConfiguration but uses execution-enriched server shapes.
created_at	string	The timestamp when the execution step was created. (pattern: <code>[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?Z</code>)
error_detail	object	Error details if the step failed.
recovery_plan_execution_step_arn	string	Strict ARN type for Recovery Plan resources. Only allows safe characters in the resource portion — rejects HTML/script injection characters (<, >, ", ', etc.) per AWS API input validation standards. Resource portion allows: [A-Za-z0-9_/.-] which covers all DRS recovery plan resource identifiers (plan-xxx, st-xxx, exec-xxx, step-xxx). (pattern: <code>arn:aws(-[a-z0-9]+)*:drs:[a-z0-9-]+:[0-9]{12}:[a-zA-Z0-9_/.-]+</code>)
status	string	The status of the execution step. (NOT_STARTED, EXECUTING, WAITING, COMPLETED, FAILED, TIMED_OUT, SKIPPED)
step_index	integer	The order of a step within a Recovery Plan (1-based).
step_name	string	The name of a Recovery Plan Step. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9 _-]*</code>)
updated_at	string	The timestamp when the execution step was last updated. (pattern: <code>[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?Z</code>)

list_recovery_plan_execution_steps

Name	Datatype	Description
configuration	object	Type-specific configuration for an execution step response. Mirrors RecoveryPlanStepConfiguration but uses execution-enriched server shapes.
error_detail	object	Error details if the step failed.
recovery_plan_execution_step_arn	string	Strict ARN type for Recovery Plan resources. Only allows safe characters in the resource portion — rejects HTML/script injection characters (<, >, ", ', etc.) per AWS API input validation standards. Resource portion allows: [A-Za-z0-9_/.-] which covers all DRS recovery plan resource identifiers (plan-xxx, st-xxx, exec-xxx, step-xxx). (pattern: <code>arn:aws(-[a-z0-9]+)*:drs:[a-z0-9-]+:[0-9]{12}:[a-zA-Z0-9_/.-]+</code>)
status	string	The status of the execution step. (NOT_STARTED, EXECUTING, WAITING, COMPLETED, FAILED, TIMED_OUT, SKIPPED)
step_index	integer	The order of a step within a Recovery Plan (1-based).
step_name	string	The name of a Recovery Plan Step. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9 _-]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recovery_plan_execution_step	select	region		Gets the details of a step within a Recovery Plan execution.
list_recovery_plan_execution_steps	select	region		Lists all steps within a Recovery Plan execution.
update_recovery_plan_execution_step	update	region, recoveryPlanExecutionStepArn		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.
retry_recovery_plan_execution_step	exec	region, recoveryPlanExecutionStepArn		Retries a failed SERVER type execution step.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_recovery_plan_execution_step

Gets the details of a step within a Recovery Plan execution.

SELECT
attempt,
configuration,
created_at,
error_detail,
recovery_plan_execution_step_arn,
status,
step_index,
step_name,
updated_at
FROM aws.drs.recovery_plan_execution_steps
WHERE region = '{{ region }}' -- required
;

list_recovery_plan_execution_steps

Lists all steps within a Recovery Plan execution.

SELECT
configuration,
error_detail,
recovery_plan_execution_step_arn,
status,
step_index,
step_name
FROM aws.drs.recovery_plan_execution_steps
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_recovery_plan_execution_step

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.

UPDATE aws.drs.recovery_plan_execution_steps
SET 
recoveryPlanExecutionStepArn = '{{ recoveryPlanExecutionStepArn }}',
status = '{{ status }}',
servers = '{{ servers }}',
waitDurationMinutes = {{ waitDurationMinutes }}
WHERE 
region = '{{ region }}' --required
AND recoveryPlanExecutionStepArn = '{{ recoveryPlanExecutionStepArn }}' --required
RETURNING
recovery_plan_execution_step;

Lifecycle Methods

retry_recovery_plan_execution_step

Retries a failed SERVER type execution step.

EXEC aws.drs.recovery_plan_execution_steps.retry_recovery_plan_execution_step 
@region='{{ region }}' --required 
@@json=
'{
"recoveryPlanExecutionStepArn": "{{ recoveryPlanExecutionStepArn }}"
}'
;