DELETEDBCLUSTER()`¶

About DeleteDbCluster¶

Deletes a Timestream for InfluxDB cluster.

Method Signature¶

METHODS /AWS1/IF_TSI~DELETEDBCLUSTER
  IMPORTING
    !IV_DBCLUSTERID TYPE /AWS1/TSIDBCLUSTERID OPTIONAL
    !IV_RETAINAUTOMATEDBACKUPS TYPE /AWS1/TSIBOOLEAN OPTIONAL
  PREFERRED PARAMETER iv_dbclusterid
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tsideletedbclustout
  RAISING
    /AWS1/CX_TSIACCESSDENIEDEX
    /AWS1/CX_TSICONFLICTEXCEPTION
    /AWS1/CX_TSIINTERNALSERVEREX
    /AWS1/CX_TSIRESOURCENOTFOUNDEX
    /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_dbclusterid` `TYPE /AWS1/TSIDBCLUSTERID` `/AWS1/TSIDBCLUSTERID`¶

Service-generated unique identifier of the DB cluster.

Optional arguments:¶

`iv_retainautomatedbackups` `TYPE /AWS1/TSIBOOLEAN` `/AWS1/TSIBOOLEAN`¶

Specifies whether to retain automated backups after the DB cluster is deleted. If set to true, automated backups are not deleted and can be restored later.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_tsideletedbclustout` `/AWS1/CL_TSIDELETEDBCLUSTOUT`¶

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->deletedbcluster(
  iv_dbclusterid = |string|
  iv_retainautomatedbackups = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_clusterstatus = lo_result->get_dbclusterstatus( ).
ENDIF.

/AWS1/IF_TSI=>DELETEDBCLUSTER()¶