waves

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

Overview

Name	waves
Type	Resource
Id	aws.mgn.waves

Fields

The following fields are returned by SELECT queries:

list_waves

Name	Datatype	Description
name	string	Wave name. (pattern: <code>[^\s\x00]( [^\s\x00])</code>)
arn	string	Wave ARN.
creation_date_time	string	Wave creation dateTime. (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>)
description	string	Wave description. (pattern: <code>[^\x00]*</code>)
is_archived	boolean	Wave archival status.
last_modified_date_time	string	Wave last modified dateTime. (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>)
tags	object	Wave tags.
wave_aggregated_status	object	Wave aggregated status.
wave_id	string	Wave ID. (pattern: <code>wave-[0-9a-zA-Z]{17}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_waves	select	region		Retrieves all waves or multiple waves by ID.
create_wave	insert	region, name		Create wave.
update_wave	update	region, waveID		Update wave.
delete_wave	delete	region		Delete wave.
archive_wave	exec	region, waveID		Archive wave.
unarchive_wave	exec	region, waveID		Unarchive wave.

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_waves

Retrieves all waves or multiple waves by ID.

SELECT
name,
arn,
creation_date_time,
description,
is_archived,
last_modified_date_time,
tags,
wave_aggregated_status,
wave_id
FROM aws.mgn.waves
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_wave

Create wave.

INSERT INTO aws.mgn.waves (
name,
description,
tags,
accountID,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ accountID }}',
'{{ region }}'
RETURNING
name,
arn,
creation_date_time,
description,
is_archived,
last_modified_date_time,
tags,
wave_aggregated_status,
wave_id
;

Manifest

# Description fields are for documentation purposes
- name: waves
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the waves resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"
  - name: accountID
    value: "{{ accountID }}"

UPDATE examples

update_wave

Update wave.

UPDATE aws.mgn.waves
SET 
waveID = '{{ waveID }}',
name = '{{ name }}',
description = '{{ description }}',
accountID = '{{ accountID }}'
WHERE 
region = '{{ region }}' --required
AND waveID = '{{ waveID }}' --required
RETURNING
name,
arn,
creation_date_time,
description,
is_archived,
last_modified_date_time,
tags,
wave_aggregated_status,
wave_id;

DELETE examples

delete_wave

Delete wave.

DELETE FROM aws.mgn.waves
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

archive_wave

Archive wave.

EXEC aws.mgn.waves.archive_wave 
@region='{{ region }}' --required 
@@json=
'{
"waveID": "{{ waveID }}", 
"accountID": "{{ accountID }}"
}'
;

unarchive_wave

Unarchive wave.

EXEC aws.mgn.waves.unarchive_wave 
@region='{{ region }}' --required 
@@json=
'{
"waveID": "{{ waveID }}", 
"accountID": "{{ accountID }}"
}'
;