CREATECONTAINERSERVICE()`¶

About CreateContainerService¶

Creates an Amazon Lightsail container service.

A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.

Method Signature¶

METHODS /AWS1/IF_LSA~CREATECONTAINERSERVICE
  IMPORTING
    !IV_SERVICENAME TYPE /AWS1/LSACONTAINERSERVICENAME OPTIONAL
    !IV_POWER TYPE /AWS1/LSACONTAINERSVCPOWERNAME OPTIONAL
    !IV_SCALE TYPE /AWS1/LSACONTAINERSERVICESCALE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LSATAG=>TT_TAGLIST OPTIONAL
    !IT_PUBLICDOMAINNAMES TYPE /AWS1/CL_LSACONTAINERSVCPUBD00=>TT_CONTAINERSVCPUBLICDOMAINS OPTIONAL
    !IO_DEPLOYMENT TYPE REF TO /AWS1/CL_LSACONTAINERSVCDEPL00 OPTIONAL
    !IO_PRIVATEREGISTRYACCESS TYPE REF TO /AWS1/CL_LSAPVTREGACCESSREQ OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsacrecontainersvcrs
  RAISING
    /AWS1/CX_LSAACCESSDENIEDEX
    /AWS1/CX_LSAINVALIDINPUTEX
    /AWS1/CX_LSANOTFOUNDEXCEPTION
    /AWS1/CX_LSARGNSETUPINPRGSSEX
    /AWS1/CX_LSASERVICEEXCEPTION
    /AWS1/CX_LSAUNAUTHNTCTDEX
    /AWS1/CX_LSACLIENTEXC
    /AWS1/CX_LSASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_servicename` `TYPE /AWS1/LSACONTAINERSERVICENAME` `/AWS1/LSACONTAINERSERVICENAME`¶

The name for the container service.

The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically https://...cs.amazonlightsail.com. If the name of your container service is container-service-1, and it's located in the US East (Ohio) Amazon Web Services Region (us-east-2), then the domain for your container service will be like the following example: https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com

The following are the requirements for container service names:

Must be unique within each Amazon Web Services Region in your Lightsail account.

Must contain 1 to 63 characters.

Must contain only alphanumeric characters and hyphens.

A hyphen (-) can separate words but cannot be at the start or end of the name.

`iv_power` `TYPE /AWS1/LSACONTAINERSVCPOWERNAME` `/AWS1/LSACONTAINERSVCPOWERNAME`¶

The power specification for the container service.

The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Use the GetContainerServicePowers action to get a list of power options that you can specify using this parameter, and their base monthly cost.

`iv_scale` `TYPE /AWS1/LSACONTAINERSERVICESCALE` `/AWS1/LSACONTAINERSERVICESCALE`¶

The scale specification for the container service.

The scale specifies the allocated compute nodes of the container service. The power and scale of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the power with the scale (the number of nodes) of the service.

Optional arguments:¶

`it_tags` `TYPE /AWS1/CL_LSATAG=>TT_TAGLIST` `TT_TAGLIST`¶

The tag keys and optional values to add to the container service during create.

Use the TagResource action to tag a resource after it's created.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

`it_publicdomainnames` `TYPE /AWS1/CL_LSACONTAINERSVCPUBD00=>TT_CONTAINERSVCPUBLICDOMAINS` `TT_CONTAINERSVCPUBLICDOMAINS`¶

The public domain names to use with the container service, such as example.com and www.example.com.

You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.

If you don't specify public domain names, then you can use the default domain of the container service.

You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the CreateCertificate action to create a certificate for the public domain names you want to use with your container service.

You can specify public domain names using a string to array map as shown in the example later on this page.

`io_deployment` `TYPE REF TO /AWS1/CL_LSACONTAINERSVCDEPL00` `/AWS1/CL_LSACONTAINERSVCDEPL00`¶

An object that describes a deployment for the container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

`io_privateregistryaccess` `TYPE REF TO /AWS1/CL_LSAPVTREGACCESSREQ` `/AWS1/CL_LSAPVTREGACCESSREQ`¶

An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_lsacrecontainersvcrs` `/AWS1/CL_LSACRECONTAINERSVCRS`¶

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->createcontainerservice(
  io_deployment = new /aws1/cl_lsacontainersvcdepl00(
    io_publicendpoint = new /aws1/cl_lsaendpointrequest(
      io_healthcheck = new /aws1/cl_lsacontainersvcheal00(
        iv_healthythreshold = 123
        iv_intervalseconds = 123
        iv_path = |string|
        iv_successcodes = |string|
        iv_timeoutseconds = 123
        iv_unhealthythreshold = 123
      )
      iv_containername = |string|
      iv_containerport = 123
    )
    it_containers = VALUE /aws1/cl_lsacontainer=>tt_containermap(
      (
        VALUE /aws1/cl_lsacontainer=>ts_containermap_maprow(
          value = new /aws1/cl_lsacontainer(
            it_command = VALUE /aws1/cl_lsastringlist_w=>tt_stringlist(
              ( new /aws1/cl_lsastringlist_w( |string| ) )
            )
            it_environment = VALUE /aws1/cl_lsaenvironment_w=>tt_environment(
              (
                VALUE /aws1/cl_lsaenvironment_w=>ts_environment_maprow(
                  value = new /aws1/cl_lsaenvironment_w( |string| )
                  key = |string|
                )
              )
            )
            it_ports = VALUE /aws1/cl_lsaportmap_w=>tt_portmap(
              (
                VALUE /aws1/cl_lsaportmap_w=>ts_portmap_maprow(
                  key = |string|
                  value = new /aws1/cl_lsaportmap_w( |string| )
                )
              )
            )
            iv_image = |string|
          )
          key = |string|
        )
      )
    )
  )
  io_privateregistryaccess = new /aws1/cl_lsapvtregaccessreq( new /aws1/cl_lsacontainersvcecri00( ABAP_TRUE ) )
  it_publicdomainnames = VALUE /aws1/cl_lsacontainersvcpubd00=>tt_containersvcpublicdomains(
    (
      VALUE /aws1/cl_lsacontainersvcpubd00=>ts_containersvcpubdoms_maprow(
        value = VALUE /aws1/cl_lsacontainersvcpubd00=>tt_containersvcpublicdomslist(
          ( new /aws1/cl_lsacontainersvcpubd00( |string| ) )
        )
        key = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_lsatag=>tt_taglist(
    (
      new /aws1/cl_lsatag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_power = |string|
  iv_scale = 123
  iv_servicename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_containerservice = lo_result->get_containerservice( ).
  IF lo_containerservice IS NOT INITIAL.
    lv_containerservicename = lo_containerservice->get_containerservicename( ).
    lv_nonemptystring = lo_containerservice->get_arn( ).
    lv_isodate = lo_containerservice->get_createdat( ).
    lo_resourcelocation = lo_containerservice->get_location( ).
    IF lo_resourcelocation IS NOT INITIAL.
      lv_string = lo_resourcelocation->get_availabilityzone( ).
      lv_regionname = lo_resourcelocation->get_regionname( ).
    ENDIF.
    lv_resourcetype = lo_containerservice->get_resourcetype( ).
    LOOP AT lo_containerservice->get_tags( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_tagkey = lo_row_1->get_key( ).
        lv_tagvalue = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_containerservicepowerna = lo_containerservice->get_power( ).
    lv_string = lo_containerservice->get_powerid( ).
    lv_containerservicestate = lo_containerservice->get_state( ).
    lo_containerservicestatede = lo_containerservice->get_statedetail( ).
    IF lo_containerservicestatede IS NOT INITIAL.
      lv_containerservicestatede_1 = lo_containerservicestatede->get_code( ).
      lv_string = lo_containerservicestatede->get_message( ).
    ENDIF.
    lv_containerservicescale = lo_containerservice->get_scale( ).
    lo_containerservicedeploym = lo_containerservice->get_currentdeployment( ).
    IF lo_containerservicedeploym IS NOT INITIAL.
      lv_integer = lo_containerservicedeploym->get_version( ).
      lv_containerservicedeploym_1 = lo_containerservicedeploym->get_state( ).
      LOOP AT lo_containerservicedeploym->get_containers( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_image( ).
          LOOP AT lo_value->get_command( ) into lo_row_3.
            lo_row_4 = lo_row_3.
            IF lo_row_4 IS NOT INITIAL.
              lv_string = lo_row_4->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_value->get_environment( ) into ls_row_5.
            lv_key_1 = ls_row_5-key.
            lo_value_1 = ls_row_5-value.
            IF lo_value_1 IS NOT INITIAL.
              lv_string = lo_value_1->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_value->get_ports( ) into ls_row_6.
            lv_key_1 = ls_row_6-key.
            lo_value_2 = ls_row_6-value.
            IF lo_value_2 IS NOT INITIAL.
              lv_containerserviceprotoco = lo_value_2->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lo_containerserviceendpoin = lo_containerservicedeploym->get_publicendpoint( ).
      IF lo_containerserviceendpoin IS NOT INITIAL.
        lv_string = lo_containerserviceendpoin->get_containername( ).
        lv_integer = lo_containerserviceendpoin->get_containerport( ).
        lo_containerservicehealthc = lo_containerserviceendpoin->get_healthcheck( ).
        IF lo_containerservicehealthc IS NOT INITIAL.
          lv_integer = lo_containerservicehealthc->get_healthythreshold( ).
          lv_integer = lo_containerservicehealthc->get_unhealthythreshold( ).
          lv_integer = lo_containerservicehealthc->get_timeoutseconds( ).
          lv_integer = lo_containerservicehealthc->get_intervalseconds( ).
          lv_string = lo_containerservicehealthc->get_path( ).
          lv_string = lo_containerservicehealthc->get_successcodes( ).
        ENDIF.
      ENDIF.
      lv_isodate = lo_containerservicedeploym->get_createdat( ).
    ENDIF.
    lo_containerservicedeploym = lo_containerservice->get_nextdeployment( ).
    IF lo_containerservicedeploym IS NOT INITIAL.
      lv_integer = lo_containerservicedeploym->get_version( ).
      lv_containerservicedeploym_1 = lo_containerservicedeploym->get_state( ).
      LOOP AT lo_containerservicedeploym->get_containers( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_image( ).
          LOOP AT lo_value->get_command( ) into lo_row_3.
            lo_row_4 = lo_row_3.
            IF lo_row_4 IS NOT INITIAL.
              lv_string = lo_row_4->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_value->get_environment( ) into ls_row_5.
            lv_key_1 = ls_row_5-key.
            lo_value_1 = ls_row_5-value.
            IF lo_value_1 IS NOT INITIAL.
              lv_string = lo_value_1->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_value->get_ports( ) into ls_row_6.
            lv_key_1 = ls_row_6-key.
            lo_value_2 = ls_row_6-value.
            IF lo_value_2 IS NOT INITIAL.
              lv_containerserviceprotoco = lo_value_2->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lo_containerserviceendpoin = lo_containerservicedeploym->get_publicendpoint( ).
      IF lo_containerserviceendpoin IS NOT INITIAL.
        lv_string = lo_containerserviceendpoin->get_containername( ).
        lv_integer = lo_containerserviceendpoin->get_containerport( ).
        lo_containerservicehealthc = lo_containerserviceendpoin->get_healthcheck( ).
        IF lo_containerservicehealthc IS NOT INITIAL.
          lv_integer = lo_containerservicehealthc->get_healthythreshold( ).
          lv_integer = lo_containerservicehealthc->get_unhealthythreshold( ).
          lv_integer = lo_containerservicehealthc->get_timeoutseconds( ).
          lv_integer = lo_containerservicehealthc->get_intervalseconds( ).
          lv_string = lo_containerservicehealthc->get_path( ).
          lv_string = lo_containerservicehealthc->get_successcodes( ).
        ENDIF.
      ENDIF.
      lv_isodate = lo_containerservicedeploym->get_createdat( ).
    ENDIF.
    lv_boolean = lo_containerservice->get_isdisabled( ).
    lv_string = lo_containerservice->get_principalarn( ).
    lv_string = lo_containerservice->get_privatedomainname( ).
    LOOP AT lo_containerservice->get_publicdomainnames( ) into ls_row_7.
      lv_key_1 = ls_row_7-key.
      LOOP AT ls_row_7-value into lo_row_8.
        lo_row_9 = lo_row_8.
        IF lo_row_9 IS NOT INITIAL.
          lv_string = lo_row_9->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDLOOP.
    lv_string = lo_containerservice->get_url( ).
    lo_privateregistryaccess = lo_containerservice->get_privateregistryaccess( ).
    IF lo_privateregistryaccess IS NOT INITIAL.
      lo_containerserviceecrimag = lo_privateregistryaccess->get_ecrimagepullerrole( ).
      IF lo_containerserviceecrimag IS NOT INITIAL.
        lv_boolean = lo_containerserviceecrimag->get_isactive( ).
        lv_string = lo_containerserviceecrimag->get_principalarn( ).
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_LSA=>CREATECONTAINERSERVICE()¶

About CreateContainerService¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_servicename TYPE /AWS1/LSACONTAINERSERVICENAME /AWS1/LSACONTAINERSERVICENAME¶

iv_power TYPE /AWS1/LSACONTAINERSVCPOWERNAME /AWS1/LSACONTAINERSVCPOWERNAME¶

iv_scale TYPE /AWS1/LSACONTAINERSERVICESCALE /AWS1/LSACONTAINERSERVICESCALE¶