Skip to content

/AWS1/IF_LSA=>CRERELATIONALDATABASEFRMSNAP()

About CreateRelationalDatabaseFromSnapshot

Creates a new database from an existing database snapshot in Amazon Lightsail.

You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

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

Method Signature

METHODS /AWS1/IF_LSA~CRERELATIONALDATABASEFRMSNAP
  IMPORTING
    !IV_RELATIONALDATABASENAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_AVAILABILITYZONE TYPE /AWS1/LSASTRING OPTIONAL
    !IV_PUBLICLYACCESSIBLE TYPE /AWS1/LSABOOLEAN OPTIONAL
    !IV_RELATIONALDATABASESNAPN00 TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_RELATIONALDATABASEBUNDL00 TYPE /AWS1/LSASTRING OPTIONAL
    !IV_SRCRELATIONALDATABASENAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_RESTORETIME TYPE /AWS1/LSAISODATE OPTIONAL
    !IV_USELATESTRESTORABLETIME TYPE /AWS1/LSABOOLEAN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LSATAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsacrerelationaldat03
  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_relationaldatabasename TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name to use for your new Lightsail database resource.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

Optional arguments:

iv_availabilityzone TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

iv_publiclyaccessible TYPE /AWS1/LSABOOLEAN /AWS1/LSABOOLEAN

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

iv_relationaldatabasesnapn00 TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the database snapshot from which to create your new database.

iv_relationaldatabasebundl00 TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

iv_srcrelationaldatabasename TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the source database.

iv_restoretime TYPE /AWS1/LSAISODATE /AWS1/LSAISODATE

The date and time to restore your database from.

Constraints:

  • Must be before the latest restorable time for the database.

  • Cannot be specified if the use latest restorable time parameter is true.

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.

iv_uselatestrestorabletime TYPE /AWS1/LSABOOLEAN /AWS1/LSABOOLEAN

Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time.

Default: false

Constraints: Cannot be specified if the restore time parameter is provided.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_lsacrerelationaldat03 /AWS1/CL_LSACRERELATIONALDAT03

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->crerelationaldatabasefrmsnap(
  it_tags = VALUE /aws1/cl_lsatag=>tt_taglist(
    (
      new /aws1/cl_lsatag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_availabilityzone = |string|
  iv_publiclyaccessible = ABAP_TRUE
  iv_relationaldatabasebundl00 = |string|
  iv_relationaldatabasename = |string|
  iv_relationaldatabasesnapn00 = |string|
  iv_restoretime = '20150101000000.0000000'
  iv_srcrelationaldatabasename = |string|
  iv_uselatestrestorabletime = ABAP_TRUE
).

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.