template_steps

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

Overview

Name	template_steps
Type	Resource
Id	aws.migrationhuborchestrator.template_steps

Fields

The following fields are returned by SELECT queries:

get_template_step

Name	Datatype	Description
id	string	The ID of the step. (pattern: <code>[a-zA-Z0-9-]+</code>)
name	string	The name of the step.
creation_time	string	The time at which the step was created.
description	string	The description of the step.
next	array	The next step.
outputs	array	The outputs of the step.
previous	array	The previous step.
step_action_type	string	The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. (MANUAL, AUTOMATED)
step_automation_configuration	object	The custom script to run tests on source or target environments.
step_group_id	string	The ID of the step group. (pattern: <code>[a-zA-Z0-9-]+</code>)
template_id	string	The ID of the template. (pattern: <code>[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*</code>)

list_template_steps

Name	Datatype	Description
id	string	The ID of the step.
name	string	The name of the step.
next	array	The next step.
owner	string	The owner of the step. (AWS_MANAGED, CUSTOM)
previous	array	The previous step.
step_action_type	string	The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step. (MANUAL, AUTOMATED)
step_group_id	string	The ID of the step group.
target_type	string	The servers on which to run the script. (SINGLE, ALL, NONE)
template_id	string	The ID of the template.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_template_step	select	id, templateId, stepGroupId, region		Get a specific step in a template.
list_template_steps	select	templateId, stepGroupId, region	maxResults, nextToken	List the steps in a template.

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
id	string	The ID of the step.
region	string	AWS region (default: us-east-1)
stepGroupId	string	The ID of the step group.
templateId	string	The ID of the template.
maxResults	integer	The maximum number of results that can be returned.
nextToken	string	The pagination token.

SELECT examples

get_template_step

Get a specific step in a template.

SELECT
id,
name,
creation_time,
description,
next,
outputs,
previous,
step_action_type,
step_automation_configuration,
step_group_id,
template_id
FROM aws.migrationhuborchestrator.template_steps
WHERE id = '{{ id }}' -- required
AND templateId = '{{ templateId }}' -- required
AND stepGroupId = '{{ stepGroupId }}' -- required
AND region = '{{ region }}' -- required
;

list_template_steps

List the steps in a template.

SELECT
id,
name,
next,
owner,
previous,
step_action_type,
step_group_id,
target_type,
template_id
FROM aws.migrationhuborchestrator.template_steps
WHERE templateId = '{{ templateId }}' -- required
AND stepGroupId = '{{ stepGroupId }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;