Skip to content

/AWS1/IF_LSA=>CREATEINSTANCESFROMSNAPSHOT()

About CreateInstancesFromSnapshot

Creates one or more new instances from a manual or automatic snapshot of an instance.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

Method Signature

METHODS /AWS1/IF_LSA~CREATEINSTANCESFROMSNAPSHOT
  IMPORTING
    !IT_INSTANCENAMES TYPE /AWS1/CL_LSASTRINGLIST_W=>TT_STRINGLIST OPTIONAL
    !IT_ATTACHEDDISKMAPPING TYPE /AWS1/CL_LSADISKMAP=>TT_ATTACHEDDISKMAP OPTIONAL
    !IV_AVAILABILITYZONE TYPE /AWS1/LSASTRING OPTIONAL
    !IV_INSTANCESNAPSHOTNAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_BUNDLEID TYPE /AWS1/LSANONEMPTYSTRING OPTIONAL
    !IV_USERDATA TYPE /AWS1/LSASTRING OPTIONAL
    !IV_KEYPAIRNAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LSATAG=>TT_TAGLIST OPTIONAL
    !IT_ADDONS TYPE /AWS1/CL_LSAADDONREQUEST=>TT_ADDONREQUESTLIST OPTIONAL
    !IV_IPADDRESSTYPE TYPE /AWS1/LSAIPADDRESSTYPE OPTIONAL
    !IV_SOURCEINSTANCENAME TYPE /AWS1/LSASTRING OPTIONAL
    !IV_RESTOREDATE TYPE /AWS1/LSASTRING OPTIONAL
    !IV_USELATSTRESTORABLEAUTOS00 TYPE /AWS1/LSABOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsacreinstsfromsnaprs
  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:

it_instancenames TYPE /AWS1/CL_LSASTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

The names for your new instances.

iv_availabilityzone TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

iv_bundleid TYPE /AWS1/LSANONEMPTYSTRING /AWS1/LSANONEMPTYSTRING

The bundle of specification information for your virtual private server (or instance), including the pricing plan (micro_x_x).

Optional arguments:

it_attacheddiskmapping TYPE /AWS1/CL_LSADISKMAP=>TT_ATTACHEDDISKMAP TT_ATTACHEDDISKMAP

An object containing information about one or more disk mappings.

iv_instancesnapshotname TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

Constraint:

  • This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

iv_userdata TYPE /AWS1/LSASTRING /AWS1/LSASTRING

You can create a launch script that configures a server with additional user data. For example, apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide.

iv_keypairname TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name for your key pair.

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.

it_addons TYPE /AWS1/CL_LSAADDONREQUEST=>TT_ADDONREQUESTLIST TT_ADDONREQUESTLIST

An array of objects representing the add-ons to enable for the new instance.

iv_ipaddresstype TYPE /AWS1/LSAIPADDRESSTYPE /AWS1/LSAIPADDRESSTYPE

The IP address type for the instance.

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

The default value is dualstack.

iv_sourceinstancename TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The name of the source instance from which the source automatic snapshot was created.

Constraints:

  • This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

iv_restoredate TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

iv_uselatstrestorableautos00 TYPE /AWS1/LSABOOLEAN /AWS1/LSABOOLEAN

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

  • Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_lsacreinstsfromsnaprs /AWS1/CL_LSACREINSTSFROMSNAPRS

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->createinstancesfromsnapshot(
  it_addons = VALUE /aws1/cl_lsaaddonrequest=>tt_addonrequestlist(
    (
      new /aws1/cl_lsaaddonrequest(
        io_autosnapshotaddonrequest = new /aws1/cl_lsaautosnapaddonreq( |string| )
        io_stopinstanceonidlerequest = new /aws1/cl_lsastopinstonidlereq(
          iv_duration = |string|
          iv_threshold = |string|
        )
        iv_addontype = |string|
      )
    )
  )
  it_attacheddiskmapping = VALUE /aws1/cl_lsadiskmap=>tt_attacheddiskmap(
    (
      VALUE /aws1/cl_lsadiskmap=>ts_attacheddiskmap_maprow(
        value = VALUE /aws1/cl_lsadiskmap=>tt_diskmaplist(
          (
            new /aws1/cl_lsadiskmap(
              iv_newdiskname = |string|
              iv_originaldiskpath = |string|
            )
          )
        )
        key = |string|
      )
    )
  )
  it_instancenames = VALUE /aws1/cl_lsastringlist_w=>tt_stringlist(
    ( new /aws1/cl_lsastringlist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_lsatag=>tt_taglist(
    (
      new /aws1/cl_lsatag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_availabilityzone = |string|
  iv_bundleid = |string|
  iv_instancesnapshotname = |string|
  iv_ipaddresstype = |string|
  iv_keypairname = |string|
  iv_restoredate = |string|
  iv_sourceinstancename = |string|
  iv_uselatstrestorableautos00 = ABAP_TRUE
  iv_userdata = |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.