applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	aws.mgn.applications

Fields

The following fields are returned by SELECT queries:

list_applications

Name	Datatype	Description
name	string	Application name. (pattern: <code>[^\s\x00]( [^\s\x00])</code>)
application_aggregated_status	object	Application aggregated status.
application_id	string	Application ID. (pattern: <code>app-[0-9a-zA-Z]{17}</code>)
arn	string	Application ARN.
creation_date_time	string	Application 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	Application description. (pattern: <code>[^\x00]*</code>)
is_archived	boolean	Application archival status.
last_modified_date_time	string	Application 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	Application tags.
wave_id	string	Application 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_applications	select	region		Retrieves all applications or multiple applications by ID.
create_application	insert	region, name		Create application.
associate_applications	update	region, waveID, applicationIDs		Associate applications to wave.
update_application	update	region, applicationID		Update application.
delete_application	delete	region		Delete application.
archive_application	exec	region, applicationID		Archive application.
disassociate_applications	exec	region, waveID, applicationIDs		Disassociate applications from wave.
unarchive_application	exec	region, applicationID		Unarchive application.

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_applications

Retrieves all applications or multiple applications by ID.

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

INSERT examples

create_application

Create application.

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

Manifest

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

UPDATE examples

associate_applications

Associate applications to wave.

UPDATE aws.mgn.applications
SET 
waveID = '{{ waveID }}',
applicationIDs = '{{ applicationIDs }}',
accountID = '{{ accountID }}'
WHERE 
region = '{{ region }}' --required
AND waveID = '{{ waveID }}' --required
AND applicationIDs = '{{ applicationIDs }}' --required;

update_application

Update application.

UPDATE aws.mgn.applications
SET 
applicationID = '{{ applicationID }}',
name = '{{ name }}',
description = '{{ description }}',
accountID = '{{ accountID }}'
WHERE 
region = '{{ region }}' --required
AND applicationID = '{{ applicationID }}' --required
RETURNING
name,
application_aggregated_status,
application_id,
arn,
creation_date_time,
description,
is_archived,
last_modified_date_time,
tags,
wave_id;

DELETE examples

delete_application

Delete application.

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

Lifecycle Methods

archive_application

Archive application.

EXEC aws.mgn.applications.archive_application 
@region='{{ region }}' --required 
@@json=
'{
"applicationID": "{{ applicationID }}", 
"accountID": "{{ accountID }}"
}'
;

disassociate_applications

Disassociate applications from wave.

EXEC aws.mgn.applications.disassociate_applications 
@region='{{ region }}' --required 
@@json=
'{
"waveID": "{{ waveID }}", 
"applicationIDs": "{{ applicationIDs }}", 
"accountID": "{{ accountID }}"
}'
;

unarchive_application

Unarchive application.

EXEC aws.mgn.applications.unarchive_application 
@region='{{ region }}' --required 
@@json=
'{
"applicationID": "{{ applicationID }}", 
"accountID": "{{ accountID }}"
}'
;