API for AWS Control Tower¶

ABAP Package	`/AWS1/API_CTT`
ABAP SDK "TLA"	`CTT`
ABAP Interface	`/AWS1/IF_CTT`

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 Control Tower is CTT. 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 ControlTower 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¶

These interfaces allow you to apply the AWS library of pre-defined controls to your organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.

To call these APIs, you'll need to know:

the ControlARN for the control--that is, the guardrail--you are targeting,
and the ARN associated with the target organizational unit (OU).

To get the ControlARN for your AWS Control Tower guardrail:

The ControlARN contains the control name which is specified in each guardrail. For a list of control names for Strongly recommended and Elective guardrails, see Resource identifiers for APIs and guardrails in the Automating tasks section of the AWS Control Tower User Guide. Remember that Mandatory guardrails cannot be added or removed.

ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}

Example:

arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED

To get the ARN for an OU:

In the AWS Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

OU ARN format:

arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}

Details and examples

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower

Recording API Requests

AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see Logging AWS Control Tower Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS Control Tower, which is created with factory method /AWS1/CL_CTT_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_ctt)       = /aws1/cl_ctt_factory=>create( go_session ).

Your variable go_ctt is an instance of /AWS1/IF_CTT, and all of the operations in the AWS Control Tower service are accessed by calling methods in /AWS1/IF_CTT.

API Operations¶

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

Factory Method¶

`/AWS1/CL_CTT_FACTORY=>CREATE( )`¶

Creates an object of type /AWS1/IF_CTT.

IMPORTING¶

Required arguments:¶

`IO_SESSION` `TYPE REF TO` `/AWS1/CL_RT_SESSION_BASE`¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE` `/AWS1/RT_PROTOCOL`¶

`IV_REGION` `TYPE` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO` `/AWS1/IF_CTT`¶

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