source_server_actions

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

Overview

Name	source_server_actions
Type	Resource
Id	aws.mgn.source_server_actions

Fields

The following fields are returned by SELECT queries:

list_source_server_actions

Name	Datatype	Description
action_id	string	Source server post migration custom action ID. (pattern: <code>.*[0-9a-zA-Z]</code>)
action_name	string	Source server post migration custom action name. (pattern: <code>[^\s\x00]( [^\s\x00])</code>)
active	boolean	Source server post migration custom action active status.
category	string	Source server post migration custom action category. (DISASTER_RECOVERY, OPERATING_SYSTEM, LICENSE_AND_SUBSCRIPTION, VALIDATION, OBSERVABILITY, REFACTORING, SECURITY, NETWORKING, CONFIGURATION, BACKUP, OTHER)
description	string	Source server post migration custom action description. (pattern: <code>[0-9a-zA-Z ():/.,'-_#; ]</code>)
document_identifier	string	Source server post migration custom action document identifier.
document_version	string	Source server post migration custom action document version. (pattern: <code>($DEFAULT|$LATEST|[0-9]+)</code>)
external_parameters	object	Source server post migration custom action external parameters.
must_succeed_for_cutover	boolean	Source server post migration custom action must succeed for cutover.
order	integer	Source server post migration custom action order.
parameters	object	Source server post migration custom action parameters.
timeout_seconds	integer	Source server post migration custom action timeout in seconds.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_source_server_actions	select	region		List source server post migration custom actions.
remove_source_server_action	update	region, sourceServerID, actionID		Remove source server post migration custom action.
put_source_server_action	replace	region, sourceServerID, actionName, documentIdentifier, order, actionID		Put source server post migration custom action.

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

list_source_server_actions

List source server post migration custom actions.

SELECT
action_id,
action_name,
active,
category,
description,
document_identifier,
document_version,
external_parameters,
must_succeed_for_cutover,
order,
parameters,
timeout_seconds
FROM aws.mgn.source_server_actions
WHERE region = '{{ region }}' -- required
;

UPDATE examples

remove_source_server_action

Remove source server post migration custom action.

UPDATE aws.mgn.source_server_actions
SET 
sourceServerID = '{{ sourceServerID }}',
actionID = '{{ actionID }}',
accountID = '{{ accountID }}'
WHERE 
region = '{{ region }}' --required
AND sourceServerID = '{{ sourceServerID }}' --required
AND actionID = '{{ actionID }}' --required;

REPLACE examples

put_source_server_action

Put source server post migration custom action.

REPLACE aws.mgn.source_server_actions
SET 
sourceServerID = '{{ sourceServerID }}',
actionName = '{{ actionName }}',
documentIdentifier = '{{ documentIdentifier }}',
order = {{ order }},
actionID = '{{ actionID }}',
documentVersion = '{{ documentVersion }}',
active = {{ active }},
timeoutSeconds = {{ timeoutSeconds }},
mustSucceedForCutover = {{ mustSucceedForCutover }},
parameters = '{{ parameters }}',
externalParameters = '{{ externalParameters }}',
description = '{{ description }}',
category = '{{ category }}',
accountID = '{{ accountID }}'
WHERE 
region = '{{ region }}' --required
AND sourceServerID = '{{ sourceServerID }}' --required
AND actionName = '{{ actionName }}' --required
AND documentIdentifier = '{{ documentIdentifier }}' --required
AND order = '{{ order }}' --required
AND actionID = '{{ actionID }}' --required
RETURNING
action_id,
action_name,
active,
category,
description,
document_identifier,
document_version,
external_parameters,
must_succeed_for_cutover,
order,
parameters,
timeout_seconds;