API for AWS CloudFormation¶

ABAP Package	`/AWS1/API_FRM_IMPL`
ABAP SDK "TLA"	`FRM`
ABAP Interface	`/AWS1/IF_FRM`

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 CloudFormation is FRM. 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 CloudFormation 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¶

CloudFormation

CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.

With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.

For more information about CloudFormation, see the CloudFormation product page.

CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.

Using the SDK¶

In your code, create a client using the SDK module for AWS CloudFormation, which is created with factory method /AWS1/CL_FRM_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_frm)       = /aws1/cl_frm_factory=>create( go_session ).

Your variable go_frm is an instance of /AWS1/IF_FRM, and all of the operations in the AWS CloudFormation service are accessed by calling methods in /AWS1/IF_FRM.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS CloudFormation, see the Operation List.

Factory Method¶

`/AWS1/CL_FRM_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_FRM.

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_FRM` `/AWS1/IF_FRM`¶

/AWS1/IF_FRM represents the ABAP client for the CloudFormation service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically¶

DATA(lo_config) = DATA(go_frm)->get_config( ).

lo_config is a variable of type /AWS1/CL_FRM_CONFIG. See the documentation for /AWS1/CL_FRM_CONFIG for details on the settings that can be configured.

Waiters¶

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 /AWS1/IF_FRM_WAITER.

Paginators¶

Paginators for AWS CloudFormation can be created via get_paginator() which returns a paginator object of type /AWS1/IF_FRM_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 has_next() and get_next() methods.

Details about the paginator methods available for service AWS CloudFormation can be found in interface /AWS1/IF_FRM_PAGINATOR.