Method: Aws::SsmSap::Client#register_application

Defined in:

lib/aws-sdk-ssmsap/client.rb

#register_application(params = {}) ⇒ Types::RegisterApplicationOutput

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.

Examples:

Request syntax with placeholder values

resp = client.register_application({
  application_id: "ApplicationId", # required
  application_type: "HANA", # required, accepts HANA, SAP_ABAP
  instances: ["InstanceId"], # required
  sap_instance_number: "SAPInstanceNumber",
  sid: "SID",
  tags: {
    "TagKey" => "TagValue",
  },
  credentials: [
    {
      database_name: "DatabaseName", # required
      credential_type: "ADMIN", # required, accepts ADMIN
      secret_id: "SecretId", # required
    },
  ],
  database_arn: "SsmSapArn",
  components_info: [
    {
      component_type: "HANA", # required, accepts HANA, HANA_NODE, ABAP, ASCS, DIALOG, WEBDISP, WD, ERS
      sid: "SID", # required
      ec2_instance_id: "InstanceId", # required
    },
  ],
})

Response structure

resp.application.id #=> String
resp.application.type #=> String, one of "HANA", "SAP_ABAP"
resp.application.arn #=> String
resp.application.app_registry_arn #=> String
resp.application.status #=> String, one of "ACTIVATED", "STARTING", "STOPPED", "STOPPING", "FAILED", "REGISTERING", "DELETING", "UNKNOWN"
resp.application.discovery_status #=> String, one of "SUCCESS", "REGISTRATION_FAILED", "REFRESH_FAILED", "REGISTERING", "DELETING"
resp.application.components #=> Array
resp.application.components[0] #=> String
resp.application.last_updated #=> Time
resp.application.status_message #=> String
resp.application.associated_application_arns #=> Array
resp.application.associated_application_arns[0] #=> String
resp.operation_id #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :application_id (required, String) —

  The ID of the application.

• :application_type (required, String) —

  The type of the application.

• :instances (required, Array<String>) —

  The Amazon EC2 instances on which your SAP application is running.

• :sap_instance_number (String) —

  The SAP instance number of the application.

• :sid (String) —

  The System ID of the application.

• :tags (Hash<String,String>) —

  The tags to be attached to the SAP application.

• :credentials (Array<Types::ApplicationCredential>) —

  The credentials of the SAP application.

• :database_arn (String) —

  The Amazon Resource Name of the SAP HANA database.

• :components_info (Array<Types::ComponentInfo>) —

  This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher.

  This is an array of ApplicationComponent objects. You may input 0 to 5 items.

Returns:

• (Types::RegisterApplicationOutput) —

  Returns a response object which responds to the following methods:

  • #application => Types::Application

  • #operation_id => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-ssmsap/client.rb', line 1241

def register_application(params = {}, options = {})
  req = build_request(:register_application, params)
  req.send_request(options)
end