Skip to content

/AWS1/IF_IMG=>CREATECONTAINERRECIPE()

About CreateContainerRecipe

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

Method Signature

METHODS /AWS1/IF_IMG~CREATECONTAINERRECIPE
  IMPORTING
    !IV_CONTAINERTYPE TYPE /AWS1/IMGCONTAINERTYPE OPTIONAL
    !IV_NAME TYPE /AWS1/IMGRESOURCENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/IMGNONEMPTYSTRING OPTIONAL
    !IV_SEMANTICVERSION TYPE /AWS1/IMGWILDCARDVERSIONNUMBER OPTIONAL
    !IT_COMPONENTS TYPE /AWS1/CL_IMGCOMPONENTCONF=>TT_COMPONENTCONFIGURATIONLIST OPTIONAL
    !IO_INSTANCECONFIGURATION TYPE REF TO /AWS1/CL_IMGINSTANCECONF OPTIONAL
    !IV_DOCKERFILETEMPLATEDATA TYPE /AWS1/IMGINLINEDOCKERFILETMPL OPTIONAL
    !IV_DOCKERFILETEMPLATEURI TYPE /AWS1/IMGURI OPTIONAL
    !IV_PLATFORMOVERRIDE TYPE /AWS1/IMGPLATFORM OPTIONAL
    !IV_IMAGEOSVERSIONOVERRIDE TYPE /AWS1/IMGNONEMPTYSTRING OPTIONAL
    !IV_PARENTIMAGE TYPE /AWS1/IMGNONEMPTYSTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IMGTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_WORKINGDIRECTORY TYPE /AWS1/IMGNONEMPTYSTRING OPTIONAL
    !IO_TARGETREPOSITORY TYPE REF TO /AWS1/CL_IMGTGTCONTAINERREPO00 OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/IMGNONEMPTYSTRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IMGCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_imgcrecontainerreci01
  RAISING
    /AWS1/CX_IMGCALLRLIMEXCEEDEDEX
    /AWS1/CX_IMGCLIENTEXCEPTION
    /AWS1/CX_IMGFORBIDDENEXCEPTION
    /AWS1/CX_IMGIDEMPOTENTPRMMIS00
    /AWS1/CX_IMGINVALIDREQUESTEX
    /AWS1/CX_IMGINVALIDVRSNUMBEREX
    /AWS1/CX_IMGRESRCALRDYEXISTSEX
    /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_containertype TYPE /AWS1/IMGCONTAINERTYPE /AWS1/IMGCONTAINERTYPE

The type of container to create.

iv_name TYPE /AWS1/IMGRESOURCENAME /AWS1/IMGRESOURCENAME

The name of the container recipe.

iv_semanticversion TYPE /AWS1/IMGWILDCARDVERSIONNUMBER /AWS1/IMGWILDCARDVERSIONNUMBER

The semantic version of the container recipe. This version follows the semantic version syntax.

The semantic version has four nodes: ../. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

iv_parentimage TYPE /AWS1/IMGNONEMPTYSTRING /AWS1/IMGNONEMPTYSTRING

The base image for the container recipe.

io_targetrepository TYPE REF TO /AWS1/CL_IMGTGTCONTAINERREPO00 /AWS1/CL_IMGTGTCONTAINERREPO00

The destination repository for the container image.

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_description TYPE /AWS1/IMGNONEMPTYSTRING /AWS1/IMGNONEMPTYSTRING

The description of the container recipe.

it_components TYPE /AWS1/CL_IMGCOMPONENTCONF=>TT_COMPONENTCONFIGURATIONLIST TT_COMPONENTCONFIGURATIONLIST

The components included in the container recipe.

io_instanceconfiguration TYPE REF TO /AWS1/CL_IMGINSTANCECONF /AWS1/CL_IMGINSTANCECONF

A group of options that can be used to configure an instance for building and testing container images.

iv_dockerfiletemplatedata TYPE /AWS1/IMGINLINEDOCKERFILETMPL /AWS1/IMGINLINEDOCKERFILETMPL

The Dockerfile template used to build your image as an inline data blob.

iv_dockerfiletemplateuri TYPE /AWS1/IMGURI /AWS1/IMGURI

The Amazon S3 URI for the Dockerfile that will be used to build your container image.

iv_platformoverride TYPE /AWS1/IMGPLATFORM /AWS1/IMGPLATFORM

Specifies the operating system platform when you use a custom base image.

iv_imageosversionoverride TYPE /AWS1/IMGNONEMPTYSTRING /AWS1/IMGNONEMPTYSTRING

Specifies the operating system version for the base image.

it_tags TYPE /AWS1/CL_IMGTAGMAP_W=>TT_TAGMAP TT_TAGMAP

Tags that are attached to the container recipe.

iv_workingdirectory TYPE /AWS1/IMGNONEMPTYSTRING /AWS1/IMGNONEMPTYSTRING

The working directory for use during build and test workflows.

iv_kmskeyid TYPE /AWS1/IMGNONEMPTYSTRING /AWS1/IMGNONEMPTYSTRING

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile template. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_imgcrecontainerreci01 /AWS1/CL_IMGCRECONTAINERRECI01

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->createcontainerrecipe(
  io_instanceconfiguration = new /aws1/cl_imginstanceconf(
    it_blockdevicemappings = VALUE /aws1/cl_imginstblockdevicemap=>tt_instanceblockdevicemappings(
      (
        new /aws1/cl_imginstblockdevicemap(
          io_ebs = new /aws1/cl_imgebsinstblkdevspec(
            iv_deleteontermination = ABAP_TRUE
            iv_encrypted = ABAP_TRUE
            iv_iops = 123
            iv_kmskeyid = |string|
            iv_snapshotid = |string|
            iv_throughput = 123
            iv_volumesize = 123
            iv_volumetype = |string|
          )
          iv_devicename = |string|
          iv_nodevice = |string|
          iv_virtualname = |string|
        )
      )
    )
    iv_image = |string|
  )
  io_targetrepository = new /aws1/cl_imgtgtcontainerrepo00(
    iv_repositoryname = |string|
    iv_service = |string|
  )
  it_components = VALUE /aws1/cl_imgcomponentconf=>tt_componentconfigurationlist(
    (
      new /aws1/cl_imgcomponentconf(
        it_parameters = VALUE /aws1/cl_imgcomponentparameter=>tt_componentparameterlist(
          (
            new /aws1/cl_imgcomponentparameter(
              it_value = VALUE /aws1/cl_imgcomponentprmvall00=>tt_componentparametervaluelist(
                ( new /aws1/cl_imgcomponentprmvall00( |string| ) )
              )
              iv_name = |string|
            )
          )
        )
        iv_componentarn = |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|
      )
    )
  )
  iv_clienttoken = |string|
  iv_containertype = |string|
  iv_description = |string|
  iv_dockerfiletemplatedata = |string|
  iv_dockerfiletemplateuri = |string|
  iv_imageosversionoverride = |string|
  iv_kmskeyid = |string|
  iv_name = |string|
  iv_parentimage = |string|
  iv_platformoverride = |string|
  iv_semanticversion = |string|
  iv_workingdirectory = |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_containerrecipearn = lo_result->get_containerrecipearn( ).
  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.