API for AWS EC2 Instance Connect¶
ABAP Package | /AWS1/API_E2I_IMPL |
---|---|
ABAP SDK "TLA" | E2I |
ABAP Interface | /AWS1/IF_E2I |
The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary
objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for AWS EC2 Instance Connect is E2I
.
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
Installation¶
To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the EC2 Instance Connect module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.
About The Service¶
This is the Amazon EC2 Instance Connect API Reference. It provides descriptions, syntax, and usage examples for each of the actions for Amazon EC2 Instance Connect. Amazon EC2 Instance Connect enables system administrators to publish one-time use SSH public keys to EC2, providing users a simple and secure way to connect to their instances.
To view the Amazon EC2 Instance Connect content in the Amazon EC2 User Guide, see Connect to your Linux instance using EC2 Instance Connect.
For Amazon EC2 APIs, see the Amazon EC2 API Reference.
Using the SDK¶
In your code, create a client using the SDK module for AWS EC2 Instance Connect, which is created with
factory method /AWS1/CL_E2I_FACTORY
=>create()
.
In this example we will assume you have configured
an SDK profile in transaction /AWS1/IMG
called ZFINANCE
.
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_e2i) = /aws1/cl_e2i_factory=>create( go_session ).
Your variable go_e2i
is an instance of /AWS1/IF_E2I
,
and all of the operations
in the AWS EC2 Instance Connect service are accessed by calling methods in /AWS1/IF_E2I
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS EC2 Instance Connect, see the Operation List.
Factory Method¶
/AWS1/CL_E2I_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_E2I
.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL
TYPE /AWS1/RT_PROTOCOL
/AWS1/RT_PROTOCOL
¶
IO_SESSION
TYPE REF TO /AWS1/CL_RT_SESSION_BASE
/AWS1/CL_RT_SESSION_BASE
¶
IV_REGION
TYPE /AWS1/RT_REGION_ID
/AWS1/RT_REGION_ID
¶
IV_CUSTOM_ENDPOINT
TYPE /AWS1/RT_ENDPOINT
/AWS1/RT_ENDPOINT
¶
RETURNING¶
OO_CLIENT
TYPE REF TO /AWS1/IF_E2I
/AWS1/IF_E2I
¶
/AWS1/IF_E2I
represents the ABAP client for the EC2 Instance Connect service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_e2i)->get_config( ).
lo_config
is a variable of type /AWS1/CL_E2I_CONFIG
. See the documentation for /AWS1/CL_E2I_CONFIG
for
details on the settings that can be configured.