applications

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

Overview

Name	applications
Type	Resource
Id	aws.ssm_sap.applications

Fields

The following fields are returned by SELECT queries:

get_application

Name	Datatype	Description
application	object	Returns all of the metadata of an application registered with AWS Systems Manager for SAP.
tags	object	The tags of a registered application.

list_applications

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the application. (pattern: <code>arn:(.+:){2,4}.+$|^arn:(.+:){1,3}.+/.+</code>)
discovery_status	string	The status of the latest discovery. (SUCCESS, REGISTRATION_FAILED, REFRESH_FAILED, REGISTERING, DELETING)
id	string	The ID of the application. (pattern: <code>[\w\d.-]+</code>)
tags	object	The tags on the application.
type	string	The type of the application. (HANA, SAP_ABAP)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application	select	region		Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
list_applications	select	region		Lists all the applications registered with AWS Systems Manager for SAP.
register_application	insert	region, ApplicationId, ApplicationType, Instances		Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering. The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2. AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions. Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.
update_application_settings	update	region, ApplicationId		Updates the settings of an application registered with AWS Systems Manager for SAP.
deregister_application	delete	region		Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.
start_application	exec	region, ApplicationId		Request is an operation which starts an application. Parameter ApplicationId is required.
start_application_refresh	exec	region, ApplicationId		Refreshes a registered application.
start_configuration_checks	exec	region, ApplicationId		Initiates configuration check operations against a specified application.
stop_application	exec	region, ApplicationId		Request is an operation to stop an application. Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

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

get_application

Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.

SELECT
application,
tags
FROM aws.ssm_sap.applications
WHERE region = '{{ region }}' -- required
;

list_applications

Lists all the applications registered with AWS Systems Manager for SAP.

SELECT
arn,
discovery_status,
id,
tags,
type
FROM aws.ssm_sap.applications
WHERE region = '{{ region }}' -- required
;

INSERT examples

register_application

Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering. The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2. AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions. Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.

INSERT INTO aws.ssm_sap.applications (
ApplicationId,
ApplicationType,
Instances,
SapInstanceNumber,
Sid,
Tags,
Credentials,
DatabaseArn,
ComponentsInfo,
region
)
SELECT 
'{{ ApplicationId }}' /* required */,
'{{ ApplicationType }}' /* required */,
'{{ Instances }}' /* required */,
'{{ SapInstanceNumber }}',
'{{ Sid }}',
'{{ Tags }}',
'{{ Credentials }}',
'{{ DatabaseArn }}',
'{{ ComponentsInfo }}',
'{{ region }}'
RETURNING
application,
operation_id
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: ApplicationId
    value: "{{ ApplicationId }}"
  - name: ApplicationType
    value: "{{ ApplicationType }}"
    valid_values: ['HANA', 'SAP_ABAP']
  - name: Instances
    value:
      - "{{ Instances }}"
  - name: SapInstanceNumber
    value: "{{ SapInstanceNumber }}"
  - name: Sid
    value: "{{ Sid }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: Credentials
    value:
      - DatabaseName: "{{ DatabaseName }}"
        CredentialType: "{{ CredentialType }}"
        SecretId: "{{ SecretId }}"
  - name: DatabaseArn
    value: "{{ DatabaseArn }}"
  - name: ComponentsInfo
    value:
      - ComponentType: "{{ ComponentType }}"
        Sid: "{{ Sid }}"
        Ec2InstanceId: "{{ Ec2InstanceId }}"

UPDATE examples

update_application_settings

Updates the settings of an application registered with AWS Systems Manager for SAP.

UPDATE aws.ssm_sap.applications
SET 
ApplicationId = '{{ ApplicationId }}',
CredentialsToAddOrUpdate = '{{ CredentialsToAddOrUpdate }}',
CredentialsToRemove = '{{ CredentialsToRemove }}',
Backint = '{{ Backint }}',
DatabaseArn = '{{ DatabaseArn }}'
WHERE 
region = '{{ region }}' --required
AND ApplicationId = '{{ ApplicationId }}' --required
RETURNING
message,
operation_ids;

DELETE examples

deregister_application

Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.

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

Lifecycle Methods

start_application

Request is an operation which starts an application. Parameter ApplicationId is required.

EXEC aws.ssm_sap.applications.start_application 
@region='{{ region }}' --required 
@@json=
'{
"ApplicationId": "{{ ApplicationId }}"
}'
;

start_application_refresh

Refreshes a registered application.

EXEC aws.ssm_sap.applications.start_application_refresh 
@region='{{ region }}' --required 
@@json=
'{
"ApplicationId": "{{ ApplicationId }}"
}'
;

start_configuration_checks

Initiates configuration check operations against a specified application.

EXEC aws.ssm_sap.applications.start_configuration_checks 
@region='{{ region }}' --required 
@@json=
'{
"ApplicationId": "{{ ApplicationId }}", 
"ConfigurationCheckIds": "{{ ConfigurationCheckIds }}"
}'
;

stop_application

Request is an operation to stop an application. Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

EXEC aws.ssm_sap.applications.stop_application 
@region='{{ region }}' --required 
@@json=
'{
"ApplicationId": "{{ ApplicationId }}", 
"StopConnectedEntity": "{{ StopConnectedEntity }}", 
"IncludeEc2InstanceShutdown": {{ IncludeEc2InstanceShutdown }}
}'
;