applications

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

Overview

Name	applications
Type	Resource
Description	Resource schema for AWS::SystemsManagerSAP::Application
Id	aws.systemsmanagersap.applications

Fields

Name	Datatype	Description
application_id	string
application_type	string
arn	string	The ARN of the Helix application
credentials	array
instances	array
sap_instance_number	string
sid	string
tags	array	The tags of a SystemsManagerSAP application.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationId, ApplicationType, 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_id,
application_type,
arn,
credentials,
instances,
sap_instance_number,
sid,
tags
FROM aws.systemsmanagersap.applications
WHERE region = 'us-east-1';

Gets all properties from an individual application.

SELECT
region,
application_id,
application_type,
arn,
credentials,
instances,
sap_instance_number,
sid,
tags
FROM aws.systemsmanagersap.applications
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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.systemsmanagersap.applications (
 ApplicationId,
 ApplicationType,
 region
)
SELECT 
'{{ ApplicationId }}',
 '{{ ApplicationType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.systemsmanagersap.applications (
 ApplicationId,
 ApplicationType,
 Credentials,
 Instances,
 SapInstanceNumber,
 Sid,
 Tags,
 region
)
SELECT 
 '{{ ApplicationId }}',
 '{{ ApplicationType }}',
 '{{ Credentials }}',
 '{{ Instances }}',
 '{{ SapInstanceNumber }}',
 '{{ Sid }}',
 '{{ 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: ApplicationId
        value: '{{ ApplicationId }}'
      - name: ApplicationType
        value: '{{ ApplicationType }}'
      - name: Credentials
        value:
          - DatabaseName: '{{ DatabaseName }}'
            CredentialType: '{{ CredentialType }}'
            SecretId: '{{ SecretId }}'
      - name: Instances
        value:
          - '{{ Instances[0] }}'
      - name: SapInstanceNumber
        value: '{{ SapInstanceNumber }}'
      - name: Sid
        value: '{{ Sid }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

ssm-sap:RegisterApplication,
ssm-sap:GetApplication,
ssm-sap:TagResource,
ssm-sap:ListTagsForResource

Read

ssm-sap:GetApplication,
ssm-sap:ListTagsForResource

Update

ssm-sap:TagResource,
ssm-sap:UntagResource,
ssm-sap:ListTagsForResource,
ssm-sap:GetApplication

Delete

ssm-sap:DeregisterApplication,
ssm-sap:GetApplication

List

ssm-sap:ListApplications