recovery_plan_steps

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

Overview

Name	recovery_plan_steps
Type	Resource
Id	aws.drs.recovery_plan_steps

Fields

The following fields are returned by SELECT queries:

get_recovery_plan_step

Name	Datatype	Description
configuration	object	Type-specific configuration for a recovery plan step. Exactly one member must be set.
created_at	string	The timestamp when the 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>)
recovery_plan_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>)
step_name	string	The name of a Recovery Plan Step. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9 _-]*</code>)
step_order	integer	The order of a step within a Recovery Plan (1-based).
updated_at	string	The timestamp when the 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_steps

Name	Datatype	Description
configuration	object	Type-specific configuration for a recovery plan step. Exactly one member must be set.
created_at	string	The timestamp when the 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>)
recovery_plan_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>)
step_name	string	The name of a Recovery Plan Step. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9 _-]*</code>)
step_order	integer	The order of a step within a Recovery Plan (1-based).
updated_at	string	The timestamp when the 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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recovery_plan_step	select	region		Gets a Recovery Plan step by ARN.
list_recovery_plan_steps	select	region		Lists all steps in a Recovery Plan.
create_recovery_plan_step	insert	region, recoveryPlanArn, stepName, configuration		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).
update_recovery_plan_step	update	region, recoveryPlanStepArn		Updates a Recovery Plan step's name or configuration. Step type is immutable.
delete_recovery_plan_step	delete	region		Deletes a step from a Recovery Plan.
reorder_recovery_plan_steps	exec	region, recoveryPlanArn, orderedStepArns		Reorders steps in a Recovery Plan. Accepts a complete ordered list of step ARNs.

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_step

Gets a Recovery Plan step by ARN.

SELECT
configuration,
created_at,
recovery_plan_step_arn,
step_name,
step_order,
updated_at
FROM aws.drs.recovery_plan_steps
WHERE region = '{{ region }}' -- required
;

list_recovery_plan_steps

Lists all steps in a Recovery Plan.

SELECT
configuration,
created_at,
recovery_plan_step_arn,
step_name,
step_order,
updated_at
FROM aws.drs.recovery_plan_steps
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_recovery_plan_step

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).

INSERT INTO aws.drs.recovery_plan_steps (
recoveryPlanArn,
stepName,
stepOrder,
configuration,
clientToken,
region
)
SELECT 
'{{ recoveryPlanArn }}' /* required */,
'{{ stepName }}' /* required */,
{{ stepOrder }},
'{{ configuration }}' /* required */,
'{{ clientToken }}',
'{{ region }}'
RETURNING
recovery_plan_step
;

Manifest

# Description fields are for documentation purposes
- name: recovery_plan_steps
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the recovery_plan_steps resource.
  - name: recoveryPlanArn
    value: "{{ recoveryPlanArn }}"
    description: |
      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).
  - name: stepName
    value: "{{ stepName }}"
    description: |
      The name of a Recovery Plan Step.
  - name: stepOrder
    value: {{ stepOrder }}
    description: |
      The order of a step within a Recovery Plan (1-based).
  - name: configuration
    description: |
      Type-specific configuration for a recovery plan step. Exactly one member must be set.
    value:
      serverStepConfiguration:
        servers:
          - serverArn: "{{ serverArn }}"
            impactLevel: "{{ impactLevel }}"
      waitStepConfiguration:
        waitDurationMinutes: {{ waitDurationMinutes }}
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_recovery_plan_step

Updates a Recovery Plan step's name or configuration. Step type is immutable.

UPDATE aws.drs.recovery_plan_steps
SET 
recoveryPlanStepArn = '{{ recoveryPlanStepArn }}',
stepName = '{{ stepName }}',
configuration = '{{ configuration }}'
WHERE 
region = '{{ region }}' --required
AND recoveryPlanStepArn = '{{ recoveryPlanStepArn }}' --required
RETURNING
recovery_plan_step;

DELETE examples

delete_recovery_plan_step

Deletes a step from a Recovery Plan.

DELETE FROM aws.drs.recovery_plan_steps
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

reorder_recovery_plan_steps

Reorders steps in a Recovery Plan. Accepts a complete ordered list of step ARNs.

EXEC aws.drs.recovery_plan_steps.reorder_recovery_plan_steps 
@region='{{ region }}' --required 
@@json=
'{
"recoveryPlanArn": "{{ recoveryPlanArn }}", 
"orderedStepArns": "{{ orderedStepArns }}"
}'
;