DELETEDBCLUSTER()`¶

About DeleteDBCluster¶

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

Method Signature¶

METHODS /AWS1/IF_DOD~DELETEDBCLUSTER
  IMPORTING
    !IV_DBCLUSTERIDENTIFIER TYPE /AWS1/DODSTRING OPTIONAL
    !IV_SKIPFINALSNAPSHOT TYPE /AWS1/DODBOOLEAN OPTIONAL
    !IV_FINALDBSNAPSHOTIDENTIFIER TYPE /AWS1/DODSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_doddeletedbclustrslt
  RAISING
    /AWS1/CX_DODDBCLUSTNOTFNDFAULT
    /AWS1/CX_DODDBCLSTSNAPALREXF00
    /AWS1/CX_DODINVDBCLSTSNAPSTA00
    /AWS1/CX_DODINVDBCLSTSTATEFA00
    /AWS1/CX_DODSNAPQUOTAEXCDFAULT
    /AWS1/CX_DODCLIENTEXC
    /AWS1/CX_DODSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_dbclusteridentifier` `TYPE /AWS1/DODSTRING` `/AWS1/DODSTRING`¶

The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.

Constraints:

Must match an existing DBClusterIdentifier.

Optional arguments:¶

`iv_skipfinalsnapshot` `TYPE /AWS1/DODBOOLEAN` `/AWS1/DODBOOLEAN`¶

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

`iv_finaldbsnapshotidentifier` `TYPE /AWS1/DODSTRING` `/AWS1/DODSTRING`¶

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

Must be from 1 to 255 letters, numbers, or hyphens.

The first character must be a letter.

Cannot end with a hyphen or contain two consecutive hyphens.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_doddeletedbclustrslt` `/AWS1/CL_DODDELETEDBCLUSTRSLT`¶

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->deletedbcluster(
  iv_dbclusteridentifier = |string|
  iv_finaldbsnapshotidentifier = |string|
  iv_skipfinalsnapshot = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_dbcluster = lo_result->get_dbcluster( ).
  IF lo_dbcluster IS NOT INITIAL.
    LOOP AT lo_dbcluster->get_availabilityzones( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_integeroptional = lo_dbcluster->get_backupretentionperiod( ).
    lv_string = lo_dbcluster->get_dbclusteridentifier( ).
    lv_string = lo_dbcluster->get_dbclusterparametergroup( ).
    lv_string = lo_dbcluster->get_dbsubnetgroup( ).
    lv_string = lo_dbcluster->get_status( ).
    lv_string = lo_dbcluster->get_percentprogress( ).
    lv_tstamp = lo_dbcluster->get_earliestrestorabletime( ).
    lv_string = lo_dbcluster->get_endpoint( ).
    lv_string = lo_dbcluster->get_readerendpoint( ).
    lv_boolean = lo_dbcluster->get_multiaz( ).
    lv_string = lo_dbcluster->get_engine( ).
    lv_string = lo_dbcluster->get_engineversion( ).
    lv_tstamp = lo_dbcluster->get_latestrestorabletime( ).
    lv_integeroptional = lo_dbcluster->get_port( ).
    lv_string = lo_dbcluster->get_masterusername( ).
    lv_string = lo_dbcluster->get_preferredbackupwindow( ).
    lv_string = lo_dbcluster->get_preferredmaintenancewi00( ).
    lv_string = lo_dbcluster->get_replsourceidentifier( ).
    LOOP AT lo_dbcluster->get_readreplicaidentifiers( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_string = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_dbcluster->get_dbclustermembers( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_string = lo_row_5->get_dbinstanceidentifier( ).
        lv_boolean = lo_row_5->get_isclusterwriter( ).
        lv_string = lo_row_5->get_dbclustparamgroupstatus( ).
        lv_integeroptional = lo_row_5->get_promotiontier( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_dbcluster->get_vpcsecuritygroups( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_string = lo_row_7->get_vpcsecuritygroupid( ).
        lv_string = lo_row_7->get_status( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbcluster->get_hostedzoneid( ).
    lv_boolean = lo_dbcluster->get_storageencrypted( ).
    lv_string = lo_dbcluster->get_kmskeyid( ).
    lv_string = lo_dbcluster->get_dbclusterresourceid( ).
    lv_string = lo_dbcluster->get_dbclusterarn( ).
    LOOP AT lo_dbcluster->get_associatedroles( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_string = lo_row_9->get_rolearn( ).
        lv_string = lo_row_9->get_status( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbcluster->get_clonegroupid( ).
    lv_tstamp = lo_dbcluster->get_clustercreatetime( ).
    LOOP AT lo_dbcluster->get_enabledcloudwatchlogsexp( ) into lo_row_10.
      lo_row_11 = lo_row_10.
      IF lo_row_11 IS NOT INITIAL.
        lv_string = lo_row_11->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_boolean = lo_dbcluster->get_deletionprotection( ).
    lv_tstamp = lo_dbcluster->get_iooptmzdnextalwdmodtime( ).
    lv_string = lo_dbcluster->get_storagetype( ).
    lo_serverlessv2scalingconf = lo_dbcluster->get_serverlessv2scalingconf( ).
    IF lo_serverlessv2scalingconf IS NOT INITIAL.
      lv_doubleoptional = lo_serverlessv2scalingconf->get_mincapacity( ).
      lv_doubleoptional = lo_serverlessv2scalingconf->get_maxcapacity( ).
    ENDIF.
    lo_clustermasterusersecret = lo_dbcluster->get_masterusersecret( ).
    IF lo_clustermasterusersecret IS NOT INITIAL.
      lv_string = lo_clustermasterusersecret->get_secretarn( ).
      lv_string = lo_clustermasterusersecret->get_secretstatus( ).
      lv_string = lo_clustermasterusersecret->get_kmskeyid( ).
    ENDIF.
    lv_string = lo_dbcluster->get_networktype( ).
  ENDIF.
ENDIF.

/AWS1/IF_DOD=>DELETEDBCLUSTER()¶