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

Fields

get (all properties)

Name	Datatype	Description
application_id	string
application_type	string
arn	string	The ARN of the SSM-SAP application
▶credentials	array
instances	array
sap_instance_number	string
sid	string
▶tags	array	The tags of a SystemsManagerSAP application.
database_arn	string	The ARN of the SAP HANA database
▶components_info	array	This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The ARN of the SSM-SAP application
region	string	AWS region.

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

Methods

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

list (identifiers only)

Lists all applications in a region.

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

All Properties

/*+ create */
INSERT INTO awscc.systemsmanagersap.applications (
  ApplicationId,
  ApplicationType,
  Credentials,
  Instances,
  SapInstanceNumber,
  Sid,
  Tags,
  DatabaseArn,
  ComponentsInfo,
  region
)
SELECT
  '{{ application_id }}',
  '{{ application_type }}',
  '{{ credentials }}',
  '{{ instances }}',
  '{{ sap_instance_number }}',
  '{{ sid }}',
  '{{ tags }}',
  '{{ database_arn }}',
  '{{ components_info }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: application
    props:
      - name: application_id
        value: '{{ application_id }}'
      - name: application_type
        value: '{{ application_type }}'
      - name: credentials
        value:
          - database_name: '{{ database_name }}'
            credential_type: '{{ credential_type }}'
            secret_id: '{{ secret_id }}'
      - name: instances
        value:
          - '{{ instances[0] }}'
      - name: sap_instance_number
        value: '{{ sap_instance_number }}'
      - name: sid
        value: '{{ sid }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: database_arn
        value: '{{ database_arn }}'
      - name: components_info
        value:
          - component_type: '{{ component_type }}'
            ec2_instance_id: '{{ ec2_instance_id }}'
            sid: '{{ sid }}'

UPDATE example

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

/*+ update */
UPDATE awscc.systemsmanagersap.applications
SET PatchDocument = string('{{ {
    "ApplicationId": application_id,
    "ApplicationType": application_type,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.systemsmanagersap.applications
WHERE
  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,
iam:CreateServiceLinkedRole

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