Skip to content

/AWS1/IF_IMG=>CREATEIMAGE()

About CreateImage

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

Method Signature

METHODS /AWS1/IF_IMG~CREATEIMAGE
  IMPORTING
    !IV_IMAGERECIPEARN TYPE /AWS1/IMGIMAGERECIPEARN OPTIONAL
    !IV_CONTAINERRECIPEARN TYPE /AWS1/IMGCONTAINERRECIPEARN OPTIONAL
    !IV_DISTRIBUTIONCONFARN TYPE /AWS1/IMGDISTRIBUTIONCONFARN OPTIONAL
    !IV_INFRASTRUCTURECONFARN TYPE /AWS1/IMGINFRASTRUCTURECONFARN OPTIONAL
    !IO_IMAGETESTSCONFIGURATION TYPE REF TO /AWS1/CL_IMGIMAGETESTSCONF OPTIONAL
    !IV_ENHANCEDIMAGEMETENABLED TYPE /AWS1/IMGNULLABLEBOOLEAN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IMGTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IMGCLIENTTOKEN OPTIONAL
    !IO_IMAGESCANNINGCONF TYPE REF TO /AWS1/CL_IMGIMAGESCANNINGCONF OPTIONAL
    !IT_WORKFLOWS TYPE /AWS1/CL_IMGWORKFLOWCONF=>TT_WORKFLOWCONFIGURATIONLIST OPTIONAL
    !IV_EXECUTIONROLE TYPE /AWS1/IMGROLENAMEORARN OPTIONAL
    !IO_LOGGINGCONFIGURATION TYPE REF TO /AWS1/CL_IMGIMAGELOGGINGCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_imgcreateimagersp
  RAISING
    /AWS1/CX_IMGCALLRLIMEXCEEDEDEX
    /AWS1/CX_IMGCLIENTEXCEPTION
    /AWS1/CX_IMGFORBIDDENEXCEPTION
    /AWS1/CX_IMGIDEMPOTENTPRMMIS00
    /AWS1/CX_IMGINVALIDREQUESTEX
    /AWS1/CX_IMGRESOURCEINUSEEX
    /AWS1/CX_IMGSERVICEEXCEPTION
    /AWS1/CX_IMGSERVICEQUOTAEXCDEX
    /AWS1/CX_IMGSERVICEUNAVAILEX
    /AWS1/CX_IMGCLIENTEXC
    /AWS1/CX_IMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_infrastructureconfarn TYPE /AWS1/IMGINFRASTRUCTURECONFARN /AWS1/IMGINFRASTRUCTURECONFARN

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

iv_clienttoken TYPE /AWS1/IMGCLIENTTOKEN /AWS1/IMGCLIENTTOKEN

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Optional arguments:

iv_imagerecipearn TYPE /AWS1/IMGIMAGERECIPEARN /AWS1/IMGIMAGERECIPEARN

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

iv_containerrecipearn TYPE /AWS1/IMGCONTAINERRECIPEARN /AWS1/IMGCONTAINERRECIPEARN

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

iv_distributionconfarn TYPE /AWS1/IMGDISTRIBUTIONCONFARN /AWS1/IMGDISTRIBUTIONCONFARN

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

io_imagetestsconfiguration TYPE REF TO /AWS1/CL_IMGIMAGETESTSCONF /AWS1/CL_IMGIMAGETESTSCONF

The image tests configuration of the image.

iv_enhancedimagemetenabled TYPE /AWS1/IMGNULLABLEBOOLEAN /AWS1/IMGNULLABLEBOOLEAN

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

it_tags TYPE /AWS1/CL_IMGTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags of the image.

io_imagescanningconf TYPE REF TO /AWS1/CL_IMGIMAGESCANNINGCONF /AWS1/CL_IMGIMAGESCANNINGCONF

Contains settings for vulnerability scans.

it_workflows TYPE /AWS1/CL_IMGWORKFLOWCONF=>TT_WORKFLOWCONFIGURATIONLIST TT_WORKFLOWCONFIGURATIONLIST

Contains an array of workflow configuration objects.

iv_executionrole TYPE /AWS1/IMGROLENAMEORARN /AWS1/IMGROLENAMEORARN

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

io_loggingconfiguration TYPE REF TO /AWS1/CL_IMGIMAGELOGGINGCONF /AWS1/CL_IMGIMAGELOGGINGCONF

Define logging configuration for the image build process.

RETURNING

oo_output TYPE REF TO /aws1/cl_imgcreateimagersp /AWS1/CL_IMGCREATEIMAGERSP

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->createimage(
  io_imagescanningconf = new /aws1/cl_imgimagescanningconf(
    io_ecrconfiguration = new /aws1/cl_imgecrconfiguration(
      it_containertags = VALUE /aws1/cl_imgstringlist_w=>tt_stringlist(
        ( new /aws1/cl_imgstringlist_w( |string| ) )
      )
      iv_repositoryname = |string|
    )
    iv_imagescanningenabled = ABAP_TRUE
  )
  io_imagetestsconfiguration = new /aws1/cl_imgimagetestsconf(
    iv_imagetestsenabled = ABAP_TRUE
    iv_timeoutminutes = 123
  )
  io_loggingconfiguration = new /aws1/cl_imgimageloggingconf( |string| )
  it_tags = VALUE /aws1/cl_imgtagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_imgtagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_imgtagmap_w( |string| )
        key = |string|
      )
    )
  )
  it_workflows = VALUE /aws1/cl_imgworkflowconf=>tt_workflowconfigurationlist(
    (
      new /aws1/cl_imgworkflowconf(
        it_parameters = VALUE /aws1/cl_imgworkflowparameter=>tt_workflowparameterlist(
          (
            new /aws1/cl_imgworkflowparameter(
              it_value = VALUE /aws1/cl_imgworkflowprmvalls00=>tt_workflowparametervaluelist(
                ( new /aws1/cl_imgworkflowprmvalls00( |string| ) )
              )
              iv_name = |string|
            )
          )
        )
        iv_onfailure = |string|
        iv_parallelgroup = |string|
        iv_workflowarn = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_containerrecipearn = |string|
  iv_distributionconfarn = |string|
  iv_enhancedimagemetenabled = ABAP_TRUE
  iv_executionrole = |string|
  iv_imagerecipearn = |string|
  iv_infrastructureconfarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nonemptystring = lo_result->get_requestid( ).
  lv_clienttoken = lo_result->get_clienttoken( ).
  lv_imagebuildversionarn = lo_result->get_imagebuildversionarn( ).
  lo_latestversionreferences = lo_result->get_latestversionreferences( ).
  IF lo_latestversionreferences IS NOT INITIAL.
    lv_imagebuilderarn = lo_latestversionreferences->get_latestversionarn( ).
    lv_imagebuilderarn = lo_latestversionreferences->get_latestmajorversionarn( ).
    lv_imagebuilderarn = lo_latestversionreferences->get_latestminorversionarn( ).
    lv_imagebuilderarn = lo_latestversionreferences->get_latestpatchversionarn( ).
  ENDIF.
ENDIF.