applications

Creates, updates, deletes or gets an application resource or lists applications in a region

Overview

Name	applications
Type	Resource
Description	Represents an application that runs on an AWS Mainframe Modernization Environment
Id	aws.m2.applications

Fields

Name	Datatype	Description
application_arn	string
application_id	string
definition	undefined
description	string
engine_type	string	The target platform for the environment.
kms_key_id	string	The ID or the Amazon Resource Name (ARN) of the customer managed KMS Key used for encrypting application-related resources.
name	string
role_arn	string
tags	object	Defines tags associated to an environment.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Definition, EngineType, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all applications in a region.

SELECT
region,
application_arn,
application_id,
definition,
description,
engine_type,
kms_key_id,
name,
role_arn,
tags
FROM aws.m2.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
application_arn,
application_id,
definition,
description,
engine_type,
kms_key_id,
name,
role_arn,
tags
FROM aws.m2.applications
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationArn>';

INSERT example

Use the following StackQL query and manifest file to create a new application resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.m2.applications (
 Definition,
 EngineType,
 Name,
 region
)
SELECT 
'{{ Definition }}',
 '{{ EngineType }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.m2.applications (
 Definition,
 Description,
 EngineType,
 KmsKeyId,
 Name,
 RoleArn,
 Tags,
 region
)
SELECT 
 '{{ Definition }}',
 '{{ Description }}',
 '{{ EngineType }}',
 '{{ KmsKeyId }}',
 '{{ Name }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: application
    props:
      - name: Definition
        value: null
      - name: Description
        value: '{{ Description }}'
      - name: EngineType
        value: '{{ EngineType }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: Name
        value: '{{ Name }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.m2.applications
WHERE data__Identifier = '<ApplicationArn>'
AND region = 'us-east-1';

Permissions

To operate on the applications resource, the following permissions are required:

Create

m2:CreateApplication,
m2:GetApplication,
m2:ListTagsForResource,
m2:TagResource,
s3:GetObject,
s3:ListBucket,
kms:DescribeKey,
kms:CreateGrant,
iam:PassRole

Read

m2:GetApplication,
m2:ListTagsForResource

Update

m2:UpdateApplication,
m2:GetApplication,
m2:ListTagsForResource,
m2:TagResource,
m2:UntagResource,
s3:GetObject,
s3:ListBucket

Delete

elasticloadbalancing:DeleteListener,
elasticloadbalancing:DeleteTargetGroup,
logs:DeleteLogDelivery,
m2:GetApplication,
m2:DeleteApplication

List

m2:ListApplications