Skip to content

/AWS1/IF_LSA=>CREATELOADBALANCER()

About CreateLoadBalancer

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 10 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

Method Signature

METHODS /AWS1/IF_LSA~CREATELOADBALANCER
  IMPORTING
    !IV_LOADBALANCERNAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_INSTANCEPORT TYPE /AWS1/LSAPORT OPTIONAL
    !IV_HEALTHCHECKPATH TYPE /AWS1/LSASTRING OPTIONAL
    !IV_CERTIFICATENAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_CERTIFICATEDOMAINNAME TYPE /AWS1/LSADOMAINNAME OPTIONAL
    !IT_CERTALTERNATIVENAMES TYPE /AWS1/CL_LSADOMAINNAMELIST_W=>TT_DOMAINNAMELIST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LSATAG=>TT_TAGLIST OPTIONAL
    !IV_IPADDRESSTYPE TYPE /AWS1/LSAIPADDRESSTYPE OPTIONAL
    !IV_TLSPOLICYNAME TYPE /AWS1/LSASTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsacreloadbalancerrs
  RAISING
    /AWS1/CX_LSAACCESSDENIEDEX
    /AWS1/CX_LSAACCTSETUPINPRGSSEX
    /AWS1/CX_LSAINVALIDINPUTEX
    /AWS1/CX_LSANOTFOUNDEXCEPTION
    /AWS1/CX_LSAOPERATIONFAILUREEX
    /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_loadbalancername TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of your load balancer.

iv_instanceport TYPE /AWS1/LSAPORT /AWS1/LSAPORT

The instance port where you're creating your load balancer.

Optional arguments:

iv_healthcheckpath TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website ("/").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

iv_certificatename TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the SSL/TLS certificate.

If you specify certificateName, then certificateDomainName is required (and vice-versa).

iv_certificatedomainname TYPE /AWS1/LSADOMAINNAME /AWS1/LSADOMAINNAME

The domain name with which your certificate is associated (example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

it_certalternativenames TYPE /AWS1/CL_LSADOMAINNAMELIST_W=>TT_DOMAINNAMELIST TT_DOMAINNAMELIST

The optional alternative domains and subdomains to use with your SSL/TLS certificate (www.example.com, example.com, m.example.com, blog.example.com).

it_tags TYPE /AWS1/CL_LSATAG=>TT_TAGLIST TT_TAGLIST

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

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

iv_ipaddresstype TYPE /AWS1/LSAIPADDRESSTYPE /AWS1/LSAIPADDRESSTYPE

The IP address type for the load balancer.

The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6.

The default value is dualstack.

iv_tlspolicyname TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The name of the TLS policy to apply to the load balancer.

Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.

For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_lsacreloadbalancerrs /AWS1/CL_LSACRELOADBALANCERRS

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->createloadbalancer(
  it_certalternativenames = VALUE /aws1/cl_lsadomainnamelist_w=>tt_domainnamelist(
    ( new /aws1/cl_lsadomainnamelist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_lsatag=>tt_taglist(
    (
      new /aws1/cl_lsatag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_certificatedomainname = |string|
  iv_certificatename = |string|
  iv_healthcheckpath = |string|
  iv_instanceport = 123
  iv_ipaddresstype = |string|
  iv_loadbalancername = |string|
  iv_tlspolicyname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_operations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptystring = lo_row_1->get_id( ).
      lv_resourcename = lo_row_1->get_resourcename( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_isodate = lo_row_1->get_createdat( ).
      lo_resourcelocation = lo_row_1->get_location( ).
      IF lo_resourcelocation IS NOT INITIAL.
        lv_string = lo_resourcelocation->get_availabilityzone( ).
        lv_regionname = lo_resourcelocation->get_regionname( ).
      ENDIF.
      lv_boolean = lo_row_1->get_isterminal( ).
      lv_string = lo_row_1->get_operationdetails( ).
      lv_operationtype = lo_row_1->get_operationtype( ).
      lv_operationstatus = lo_row_1->get_status( ).
      lv_isodate = lo_row_1->get_statuschangedat( ).
      lv_string = lo_row_1->get_errorcode( ).
      lv_string = lo_row_1->get_errordetails( ).
    ENDIF.
  ENDLOOP.
ENDIF.