launch_actions

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

Overview

Name	launch_actions
Type	Resource
Id	aws.drs.launch_actions

Fields

The following fields are returned by SELECT queries:

list_launch_actions

Name	Datatype	Description
name	string	Launch action name. (pattern: <code>[A-Za-z0-9][A-Za-z0-9 /_-]*</code>)
action_code	string	Launch action code. (pattern: <code>([A-Za-z0-9-/:])+</code>)
action_id	string	Launch action Id. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
action_version	string	Launch action version. (pattern: <code>($DEFAULT|$LATEST|[0-9]+)</code>)
active	boolean	Whether the launch action is active.
category	string	Launch action category. (MONITORING, VALIDATION, CONFIGURATION, SECURITY, OTHER)
description	string	Launch action description. (pattern: <code>[0-9a-zA-Z ():/.,'-_#; ]</code>)
optional	boolean	Whether the launch will not be marked as failed if this action fails.
order	integer	Launch action order.
parameters	object
type_	string	Launch action type. (SSM_AUTOMATION, SSM_COMMAND)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_launch_actions	select	region		Lists resource launch actions.
put_launch_action	replace	region, resourceId, actionCode, order, actionId, optional, active, name, actionVersion, category, description		Puts a resource launch action.
delete_launch_action	delete	region		Deletes a resource launch 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_launch_actions

Lists resource launch actions.

SELECT
name,
action_code,
action_id,
action_version,
active,
category,
description,
optional,
order,
parameters,
type_
FROM aws.drs.launch_actions
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_launch_action

Puts a resource launch action.

REPLACE aws.drs.launch_actions
SET 
resourceId = '{{ resourceId }}',
actionCode = '{{ actionCode }}',
order = {{ order }},
actionId = '{{ actionId }}',
optional = {{ optional }},
active = {{ active }},
name = '{{ name }}',
actionVersion = '{{ actionVersion }}',
category = '{{ category }}',
parameters = '{{ parameters }}',
description = '{{ description }}'
WHERE 
region = '{{ region }}' --required
AND resourceId = '{{ resourceId }}' --required
AND actionCode = '{{ actionCode }}' --required
AND order = '{{ order }}' --required
AND actionId = '{{ actionId }}' --required
AND optional = {{ optional }} --required
AND active = {{ active }} --required
AND name = '{{ name }}' --required
AND actionVersion = '{{ actionVersion }}' --required
AND category = '{{ category }}' --required
AND description = '{{ description }}' --required
RETURNING
name,
action_code,
action_id,
action_version,
active,
category,
description,
optional,
order,
parameters,
resource_id,
type_;

DELETE examples

delete_launch_action

Deletes a resource launch action.

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