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	awscc.m2.applications

Fields

get (all properties)

Name	Datatype	Description
application_arn	string
application_id	string
definition	object
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.

list (identifiers only)

Name	Datatype	Description
application_arn	string
region	string	AWS region.

For more information, see AWS::M2::Application.

Methods

Name	Resource	Accessible by	Required Params
create_resource	applications	INSERT	EngineType, Name, region
delete_resource	applications	DELETE	Identifier, region
update_resource	applications	UPDATE	Identifier, PatchDocument, region
list_resources	applications_list_only	SELECT	region
get_resource	applications	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.m2.applications
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ application_arn }}';

list (identifiers only)

Lists all applications in a region.

SELECT
  region,
  application_arn
FROM awscc.m2.applications_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.m2.applications (
  Definition,
  Description,
  EngineType,
  KmsKeyId,
  Name,
  RoleArn,
  Tags,
  region
)
SELECT
  '{{ definition }}',
  '{{ description }}',
  '{{ engine_type }}',
  '{{ kms_key_id }}',
  '{{ name }}',
  '{{ role_arn }}',
  '{{ 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: engine_type
        value: '{{ engine_type }}'
      - name: kms_key_id
        value: '{{ kms_key_id }}'
      - name: name
        value: '{{ name }}'
      - name: role_arn
        value: '{{ role_arn }}'
      - name: tags
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.m2.applications
SET PatchDocument = string('{{ {
    "Definition": definition,
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.m2.applications
WHERE
  Identifier = '{{ application_arn }}' 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