API for AWS OpsWorks CM¶
|ABAP SDK "TLA"||
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 OpsWorks CM is
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the OpsWorksCM 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¶
AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove nodes for the servers to manage.
Glossary of terms
Server: A configuration management server that can be highly-available. The configuration management server runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you create servers, they continue to run until they are deleted.
Engine: The engine is the specific configuration manager that you want to use. Valid values in this release include
Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's configuration-related attributes at the time the backup starts.
Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's events are also deleted.
Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.
AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers can only be accessed or managed within the endpoint in which they are created.
For more information, see AWS OpsWorks endpoints and quotas in the AWS General Reference.
All API operations allow for five requests per second with a burst of 10 requests per second.
Using the SDK¶
In your code, create a client using the SDK module for AWS OpsWorks CM, which is created with
In this example we will assume you have configured
an SDK profile in transaction
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ). DATA(go_owc) = /aws1/cl_owc_factory=>create( go_session ).
For an overview of ABAP method calls corresponding to API operations in AWS OpsWorks CM, see the Operation List.
Creates an object of type
TYPE REF TO
TYPE REF TO
/AWS1/IF_OWCrepresents the ABAP client for the OpsWorksCM service, representing each operation as a method call. For more information see the API Page page.
DATA(lo_config) = DATA(go_owc)->get_config( ).
Waiters for Implementation can be accessed via
get_waiter() method followed by the waiter method to be called.
Details about the waiter methods available for service Implementation can be found in interface
Paginators for AWS OpsWorks CM can be created via
get_paginator() which returns a paginator object of type
/AWS1/IF_OWC_PAGINATOR. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using
Details about the paginator methods available for service AWS OpsWorks CM can be found in interface