Skip to content

/AWS1/IF_TSI=>RESTOREFROMDBBACKUP()

About RestoreFromDbBackup

Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode.

Method Signature

METHODS /AWS1/IF_TSI~RESTOREFROMDBBACKUP
  IMPORTING
    !IV_NAME TYPE /AWS1/TSIDBRESOURCENAME OPTIONAL
    !IV_DBBACKUPID TYPE /AWS1/TSIDBBACKUPID OPTIONAL
    !IV_RESTORETOTIME TYPE /AWS1/TSITIMESTAMP OPTIONAL
    !IV_RESTOREMODE TYPE /AWS1/TSIRESTOREMODE OPTIONAL
    !IT_VPCSUBNETIDS TYPE /AWS1/CL_TSIVPCSUBNETIDLIST_W=>TT_VPCSUBNETIDLIST OPTIONAL
    !IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_TSIVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST OPTIONAL
    !IV_PUBLICLYACCESSIBLE TYPE /AWS1/TSIBOOLEAN OPTIONAL
    !IO_LOGDELIVERYCONFIGURATION TYPE REF TO /AWS1/CL_TSILOGDELIVERYCONF OPTIONAL
    !IO_MAINTENANCESCHEDULE TYPE REF TO /AWS1/CL_TSIMAINTSCHEDULE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_TSIREQUESTTAGMAP_W=>TT_REQUESTTAGMAP OPTIONAL
    !IV_PORT TYPE /AWS1/TSIPORT OPTIONAL
    !IV_NETWORKTYPE TYPE /AWS1/TSINETWORKTYPE OPTIONAL
    !IV_DEPLOYMENTTYPE TYPE /AWS1/TSIRESOURCEDEPLOYTYPE OPTIONAL
    !IT_DBBACKUPCONFIGURATIONS TYPE /AWS1/CL_TSIDBBACKUPCONF=>TT_DBBACKUPCONFINPUTLIST OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/TSIKMSKEYID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tsirestfromdbbkupout
  RAISING
    /AWS1/CX_TSIACCESSDENIEDEX
    /AWS1/CX_TSICONFLICTEXCEPTION
    /AWS1/CX_TSIINTERNALSERVEREX
    /AWS1/CX_TSIRESOURCENOTFOUNDEX
    /AWS1/CX_TSISERVICEQUOTAEXCDEX
    /AWS1/CX_TSITHROTTLINGEX
    /AWS1/CX_TSIVALIDATIONEX
    /AWS1/CX_TSICLIENTEXC
    /AWS1/CX_TSISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/TSIDBRESOURCENAME /AWS1/TSIDBRESOURCENAME

The name of the new resource to create from the restore. If restoring to an existing resource, the name must match the existing resource name.

iv_dbbackupid TYPE /AWS1/TSIDBBACKUPID /AWS1/TSIDBBACKUPID

The identifier of the backup to restore from.

Optional arguments:

iv_restoretotime TYPE /AWS1/TSITIMESTAMP /AWS1/TSITIMESTAMP

The point in time to restore to, for continuous backups. Must be within the backup's retention window.

iv_restoremode TYPE /AWS1/TSIRESTOREMODE /AWS1/TSIRESTOREMODE

Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.

it_vpcsubnetids TYPE /AWS1/CL_TSIVPCSUBNETIDLIST_W=>TT_VPCSUBNETIDLIST TT_VPCSUBNETIDLIST

A list of VPC subnet IDs for the restored resource. If not specified, the restored resource uses the same subnets as the backup.

it_vpcsecuritygroupids TYPE /AWS1/CL_TSIVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST

A list of VPC security group IDs for the restored resource. If not specified, the restored resource uses the same security groups as the backup.

iv_publiclyaccessible TYPE /AWS1/TSIBOOLEAN /AWS1/TSIBOOLEAN

Specifies whether the restored resource is publicly accessible.

io_logdeliveryconfiguration TYPE REF TO /AWS1/CL_TSILOGDELIVERYCONF /AWS1/CL_TSILOGDELIVERYCONF

Configuration for sending InfluxDB engine logs to the specified S3 bucket for the restored resource.

io_maintenanceschedule TYPE REF TO /AWS1/CL_TSIMAINTSCHEDULE /AWS1/CL_TSIMAINTSCHEDULE

The maintenance schedule for the restored resource.

it_tags TYPE /AWS1/CL_TSIREQUESTTAGMAP_W=>TT_REQUESTTAGMAP TT_REQUESTTAGMAP

A list of key-value pairs to associate with the restored resource.

iv_port TYPE /AWS1/TSIPORT /AWS1/TSIPORT

The port number on which the restored InfluxDB resource accepts connections.

iv_networktype TYPE /AWS1/TSINETWORKTYPE /AWS1/TSINETWORKTYPE

Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.

iv_deploymenttype TYPE /AWS1/TSIRESOURCEDEPLOYTYPE /AWS1/TSIRESOURCEDEPLOYTYPE

Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.

it_dbbackupconfigurations TYPE /AWS1/CL_TSIDBBACKUPCONF=>TT_DBBACKUPCONFINPUTLIST TT_DBBACKUPCONFINPUTLIST

A list of backup configurations to apply to the restored resource.

iv_kmskeyid TYPE /AWS1/TSIKMSKEYID /AWS1/TSIKMSKEYID

The Amazon Web Services KMS key identifier to use for encryption of the restored resource. Can be a key ID, key ARN, alias name, or alias ARN.

RETURNING

oo_output TYPE REF TO /aws1/cl_tsirestfromdbbkupout /AWS1/CL_TSIRESTFROMDBBKUPOUT

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->restorefromdbbackup(
  io_logdeliveryconfiguration = new /aws1/cl_tsilogdeliveryconf(
    io_s3configuration = new /aws1/cl_tsis3configuration(
      iv_bucketname = |string|
      iv_enabled = ABAP_TRUE
    )
  )
  io_maintenanceschedule = new /aws1/cl_tsimaintschedule(
    iv_preferredmaintwindow = |string|
    iv_timezone = |string|
  )
  it_dbbackupconfigurations = VALUE /aws1/cl_tsidbbackupconf=>tt_dbbackupconfinputlist(
    (
      new /aws1/cl_tsidbbackupconf(
        iv_customschedule = |string|
        iv_enabled = ABAP_TRUE
        iv_retentiondays = 123
        iv_type = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_tsirequesttagmap_w=>tt_requesttagmap(
    (
      VALUE /aws1/cl_tsirequesttagmap_w=>ts_requesttagmap_maprow(
        key = |string|
        value = new /aws1/cl_tsirequesttagmap_w( |string| )
      )
    )
  )
  it_vpcsecuritygroupids = VALUE /aws1/cl_tsivpcsecgrpidlist_w=>tt_vpcsecuritygroupidlist(
    ( new /aws1/cl_tsivpcsecgrpidlist_w( |string| ) )
  )
  it_vpcsubnetids = VALUE /aws1/cl_tsivpcsubnetidlist_w=>tt_vpcsubnetidlist(
    ( new /aws1/cl_tsivpcsubnetidlist_w( |string| ) )
  )
  iv_dbbackupid = |string|
  iv_deploymenttype = |string|
  iv_kmskeyid = |string|
  iv_name = |string|
  iv_networktype = |string|
  iv_port = 123
  iv_publiclyaccessible = ABAP_TRUE
  iv_restoremode = |string|
  iv_restoretotime = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_dbresourceid = lo_result->get_restoreddbresourceid( ).
  lv_restorestatus = lo_result->get_restorestatus( ).
  lv_resourcetype = lo_result->get_resourcetype( ).
  lv_enginetype = lo_result->get_enginetype( ).
  lv_resourcedeploymenttype = lo_result->get_deploymenttype( ).
ENDIF.