Skip to content

/AWS1/IF_OWX=>REGISTERINSTANCE()

About RegisterInstance

Registers instances that were created outside of OpsWorks Stacks with a specified stack.

We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an OpsWorks Stacks Stack.

Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Method Signature

IMPORTING

Required arguments:

iv_stackid TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The ID of the stack that the instance is to be registered with.

Optional arguments:

iv_hostname TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's host name. The following are character limits for instance host names.

  • Linux-based instances: 63 characters

  • Windows-based instances: 15 characters

iv_publicip TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's public IP address.

iv_privateip TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instance's private IP address.

iv_rsapublickey TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

iv_rsapublickeyfingerprint TYPE /AWS1/OWXSTRING /AWS1/OWXSTRING

The instances public RSA key fingerprint.

io_instanceidentity TYPE REF TO /AWS1/CL_OWXINSTANCEIDENTITY /AWS1/CL_OWXINSTANCEIDENTITY

An InstanceIdentity object that contains the instance's identity.

RETURNING

oo_output TYPE REF TO /aws1/cl_owxreginstanceresult /AWS1/CL_OWXREGINSTANCERESULT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_owx~registerinstance(
  io_instanceidentity = new /aws1/cl_owxinstanceidentity(
    iv_document = |string|
    iv_signature = |string|
  )
  iv_hostname = |string|
  iv_privateip = |string|
  iv_publicip = |string|
  iv_rsapublickey = |string|
  iv_rsapublickeyfingerprint = |string|
  iv_stackid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_instanceid( ).
ENDIF.