CREATEDBBACKUP()`¶

About CreateDbBackup¶

Creates a new on-demand backup of a Timestream for InfluxDB resource.

Method Signature¶

METHODS /AWS1/IF_TSI~CREATEDBBACKUP
  IMPORTING
    !IV_NAME TYPE /AWS1/TSIDBBACKUPNAME OPTIONAL
    !IV_DBRESOURCEID TYPE /AWS1/TSIDBRESOURCEID OPTIONAL
    !IV_RETENTIONDAYS TYPE /AWS1/TSIRETENTIONDAYS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_TSIREQUESTTAGMAP_W=>TT_REQUESTTAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tsicrtdbbackupoutput
  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/TSIDBBACKUPNAME` `/AWS1/TSIDBBACKUPNAME`¶

The name of the backup. Must be unique within the account and region.

`iv_dbresourceid` `TYPE /AWS1/TSIDBRESOURCEID` `/AWS1/TSIDBRESOURCEID`¶

The id of the DB instance or DB cluster to back up.

Optional arguments:¶

`iv_retentiondays` `TYPE /AWS1/TSIRETENTIONDAYS` `/AWS1/TSIRETENTIONDAYS`¶

The number of days to retain the backup. Valid values are 1 to 3650.

`it_tags` `TYPE /AWS1/CL_TSIREQUESTTAGMAP_W=>TT_REQUESTTAGMAP` `TT_REQUESTTAGMAP`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_tsicrtdbbackupoutput` `/AWS1/CL_TSICRTDBBACKUPOUTPUT`¶

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->createdbbackup(
  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| )
      )
    )
  )
  iv_dbresourceid = |string|
  iv_name = |string|
  iv_retentiondays = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_dbbackupid = lo_result->get_id( ).
  lv_dbbackupname = lo_result->get_name( ).
  lv_arn = lo_result->get_arn( ).
  lv_dbbackupstatus = lo_result->get_status( ).
  lv_timestamp = lo_result->get_createdat( ).
  lv_date = lo_result->get_expiresafter( ).
  lv_dbresourceid = lo_result->get_dbresourceid( ).
  lv_dbbackuptype = lo_result->get_type( ).
  lv_enginetype = lo_result->get_enginetype( ).
  lv_resourcedeploymenttype = lo_result->get_deploymenttype( ).
  lv_kmskeyid = lo_result->get_kmskeyid( ).
  lo_clusterconfiguration = lo_result->get_clusterconfiguration( ).
  IF lo_clusterconfiguration IS NOT INITIAL.
    lv_integer = lo_clusterconfiguration->get_ingestqueryinstances( ).
    lv_integer = lo_clusterconfiguration->get_queryonlyinstances( ).
    lv_boolean = lo_clusterconfiguration->get_dedicatedcompactor( ).
  ENDIF.
  lv_dbparametergroupid = lo_result->get_dbparametergroupid00( ).
  lv_dbinstancetype = lo_result->get_dbinstancetype( ).
  lo_logdeliveryconfiguratio = lo_result->get_logdeliveryconfiguration( ).
  IF lo_logdeliveryconfiguratio IS NOT INITIAL.
    lo_s3configuration = lo_logdeliveryconfiguratio->get_s3configuration( ).
    IF lo_s3configuration IS NOT INITIAL.
      lv_string = lo_s3configuration->get_bucketname( ).
      lv_boolean = lo_s3configuration->get_enabled( ).
    ENDIF.
  ENDIF.
  lv_failovermode = lo_result->get_failovermode( ).
  lv_dbstoragetype = lo_result->get_dbstoragetype( ).
  lv_allocatedstorage = lo_result->get_allocatedstorage( ).
  LOOP AT lo_result->get_vpcsubnetids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_vpcsubnetid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_vpcsecuritygroupids( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_vpcsecuritygroupid = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_boolean = lo_result->get_publiclyaccessible( ).
  lv_integer = lo_result->get_port( ).
  lv_networktype = lo_result->get_networktype( ).
  lv_string = lo_result->get_influxauthparmssecretarn( ).
  lo_maintenanceschedule = lo_result->get_maintenanceschedule( ).
  IF lo_maintenanceschedule IS NOT INITIAL.
    lv_ianatimezone = lo_maintenanceschedule->get_timezone( ).
    lv_maintenancewindow = lo_maintenanceschedule->get_preferredmaintwindow( ).
  ENDIF.
ENDIF.

/AWS1/IF_TSI=>CREATEDBBACKUP()¶