Skip to content

/AWS1/IF_EC2=>CREATEFPGAIMAGE()

About CreateFpgaImage

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI was successfully created and is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.

Method Signature

METHODS /AWS1/IF_EC2~CREATEFPGAIMAGE
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IO_INPUTSTORAGELOCATION TYPE REF TO /AWS1/CL_EC2STORAGELOCATION OPTIONAL
    !IO_LOGSSTORAGELOCATION TYPE REF TO /AWS1/CL_EC2STORAGELOCATION OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/EC2STRING OPTIONAL
    !IV_NAME TYPE /AWS1/EC2STRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2crefpgaimagerslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_inputstoragelocation TYPE REF TO /AWS1/CL_EC2STORAGELOCATION /AWS1/CL_EC2STORAGELOCATION

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

Optional arguments:

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

io_logsstoragelocation TYPE REF TO /AWS1/CL_EC2STORAGELOCATION /AWS1/CL_EC2STORAGELOCATION

The location in Amazon S3 for the output logs.

iv_description TYPE /AWS1/EC2STRING /AWS1/EC2STRING

A description for the AFI.

iv_name TYPE /AWS1/EC2STRING /AWS1/EC2STRING

A name for the AFI.

iv_clienttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

it_tagspecifications TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The tags to apply to the FPGA image during creation.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2crefpgaimagerslt /AWS1/CL_EC2CREFPGAIMAGERSLT

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->createfpgaimage(
  io_inputstoragelocation = new /aws1/cl_ec2storagelocation(
    iv_bucket = |string|
    iv_key = |string|
  )
  io_logsstoragelocation = new /aws1/cl_ec2storagelocation(
    iv_bucket = |string|
    iv_key = |string|
  )
  it_tagspecifications = VALUE /aws1/cl_ec2tagspecification=>tt_tagspecificationlist(
    (
      new /aws1/cl_ec2tagspecification(
        it_tags = VALUE /aws1/cl_ec2tag=>tt_taglist(
          (
            new /aws1/cl_ec2tag(
              iv_key = |string|
              iv_value = |string|
            )
          )
        )
        iv_resourcetype = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_description = |string|
  iv_dryrun = ABAP_TRUE
  iv_name = |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_fpgaimageid( ).
  lv_string = lo_result->get_fpgaimageglobalid( ).
ENDIF.