DELETEDBINSTANCE()`¶

About DeleteDBInstance¶

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_dbinstanceidentifier` `TYPE /AWS1/NEPSTRING` `/AWS1/NEPSTRING`¶

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

Must match the name of an existing DB instance.

Optional arguments:¶

`iv_skipfinalsnapshot` `TYPE /AWS1/NEPBOOLEAN` `/AWS1/NEPBOOLEAN`¶

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

Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

`iv_finaldbsnapshotidentifier` `TYPE /AWS1/NEPSTRING` `/AWS1/NEPSTRING`¶

The DBSnapshotIdentifier of the new DBSnapshot 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 1 to 255 letters or numbers.

First character must be a letter

Cannot end with a hyphen or contain two consecutive hyphens

Cannot be specified when deleting a Read Replica.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_nepdeletedbinstresult` `/AWS1/CL_NEPDELETEDBINSTRESULT`¶

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->/aws1/if_nep~deletedbinstance(
  iv_dbinstanceidentifier = |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_dbinstance = lo_result->get_dbinstance( ).
  IF lo_dbinstance IS NOT INITIAL.
    lv_string = lo_dbinstance->get_dbinstanceidentifier( ).
    lv_string = lo_dbinstance->get_dbinstanceclass( ).
    lv_string = lo_dbinstance->get_engine( ).
    lv_string = lo_dbinstance->get_dbinstancestatus( ).
    lv_string = lo_dbinstance->get_masterusername( ).
    lv_string = lo_dbinstance->get_dbname( ).
    lo_endpoint = lo_dbinstance->get_endpoint( ).
    IF lo_endpoint IS NOT INITIAL.
      lv_string = lo_endpoint->get_address( ).
      lv_integer = lo_endpoint->get_port( ).
      lv_string = lo_endpoint->get_hostedzoneid( ).
    ENDIF.
    lv_integer = lo_dbinstance->get_allocatedstorage( ).
    lv_tstamp = lo_dbinstance->get_instancecreatetime( ).
    lv_string = lo_dbinstance->get_preferredbackupwindow( ).
    lv_integer = lo_dbinstance->get_backupretentionperiod( ).
    LOOP AT lo_dbinstance->get_dbsecuritygroups( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_dbsecuritygroupname( ).
        lv_string = lo_row_1->get_status( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_dbinstance->get_vpcsecuritygroups( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_string = lo_row_3->get_vpcsecuritygroupid( ).
        lv_string = lo_row_3->get_status( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_dbinstance->get_dbparametergroups( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_string = lo_row_5->get_dbparametergroupname( ).
        lv_string = lo_row_5->get_parameterapplystatus( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbinstance->get_availabilityzone( ).
    lo_dbsubnetgroup = lo_dbinstance->get_dbsubnetgroup( ).
    IF lo_dbsubnetgroup IS NOT INITIAL.
      lv_string = lo_dbsubnetgroup->get_dbsubnetgroupname( ).
      lv_string = lo_dbsubnetgroup->get_dbsubnetgroupdescription( ).
      lv_string = lo_dbsubnetgroup->get_vpcid( ).
      lv_string = lo_dbsubnetgroup->get_subnetgroupstatus( ).
      LOOP AT lo_dbsubnetgroup->get_subnets( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_string = lo_row_7->get_subnetidentifier( ).
          lo_availabilityzone = lo_row_7->get_subnetavailabilityzone( ).
          IF lo_availabilityzone IS NOT INITIAL.
            lv_string = lo_availabilityzone->get_name( ).
          ENDIF.
          lv_string = lo_row_7->get_subnetstatus( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_dbsubnetgroup->get_dbsubnetgrouparn( ).
    ENDIF.
    lv_string = lo_dbinstance->get_preferredmaintenancewi00( ).
    lo_pendingmodifiedvalues = lo_dbinstance->get_pendingmodifiedvalues( ).
    IF lo_pendingmodifiedvalues IS NOT INITIAL.
      lv_string = lo_pendingmodifiedvalues->get_dbinstanceclass( ).
      lv_integeroptional = lo_pendingmodifiedvalues->get_allocatedstorage( ).
      lv_string = lo_pendingmodifiedvalues->get_masteruserpassword( ).
      lv_integeroptional = lo_pendingmodifiedvalues->get_port( ).
      lv_integeroptional = lo_pendingmodifiedvalues->get_backupretentionperiod( ).
      lv_booleanoptional = lo_pendingmodifiedvalues->get_multiaz( ).
      lv_string = lo_pendingmodifiedvalues->get_engineversion( ).
      lv_string = lo_pendingmodifiedvalues->get_licensemodel( ).
      lv_integeroptional = lo_pendingmodifiedvalues->get_iops( ).
      lv_string = lo_pendingmodifiedvalues->get_dbinstanceidentifier( ).
      lv_string = lo_pendingmodifiedvalues->get_storagetype( ).
      lv_string = lo_pendingmodifiedvalues->get_cacertificateidentifier( ).
      lv_string = lo_pendingmodifiedvalues->get_dbsubnetgroupname( ).
      lo_pendingcloudwatchlogsex = lo_pendingmodifiedvalues->get_pendingcloudwatchlogsexp( ).
      IF lo_pendingcloudwatchlogsex IS NOT INITIAL.
        LOOP AT lo_pendingcloudwatchlogsex->get_logtypestoenable( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_string = lo_row_9->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_pendingcloudwatchlogsex->get_logtypestodisable( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_string = lo_row_9->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
    lv_tstamp = lo_dbinstance->get_latestrestorabletime( ).
    lv_boolean = lo_dbinstance->get_multiaz( ).
    lv_string = lo_dbinstance->get_engineversion( ).
    lv_boolean = lo_dbinstance->get_autominorversionupgrade( ).
    lv_string = lo_dbinstance->get_readrplsourcedbinstid( ).
    LOOP AT lo_dbinstance->get_readreplicadbinstanceids( ) 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.
    LOOP AT lo_dbinstance->get_readreplicadbclusterids( ) into lo_row_12.
      lo_row_13 = lo_row_12.
      IF lo_row_13 IS NOT INITIAL.
        lv_string = lo_row_13->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbinstance->get_licensemodel( ).
    lv_integeroptional = lo_dbinstance->get_iops( ).
    LOOP AT lo_dbinstance->get_optiongroupmemberships( ) into lo_row_14.
      lo_row_15 = lo_row_14.
      IF lo_row_15 IS NOT INITIAL.
        lv_string = lo_row_15->get_optiongroupname( ).
        lv_string = lo_row_15->get_status( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbinstance->get_charactersetname( ).
    lv_string = lo_dbinstance->get_secondaryaz( ).
    lv_boolean = lo_dbinstance->get_publiclyaccessible( ).
    LOOP AT lo_dbinstance->get_statusinfos( ) into lo_row_16.
      lo_row_17 = lo_row_16.
      IF lo_row_17 IS NOT INITIAL.
        lv_string = lo_row_17->get_statustype( ).
        lv_boolean = lo_row_17->get_normal( ).
        lv_string = lo_row_17->get_status( ).
        lv_string = lo_row_17->get_message( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbinstance->get_storagetype( ).
    lv_string = lo_dbinstance->get_tdecredentialarn( ).
    lv_integer = lo_dbinstance->get_dbinstanceport( ).
    lv_string = lo_dbinstance->get_dbclusteridentifier( ).
    lv_boolean = lo_dbinstance->get_storageencrypted( ).
    lv_string = lo_dbinstance->get_kmskeyid( ).
    lv_string = lo_dbinstance->get_dbiresourceid( ).
    lv_string = lo_dbinstance->get_cacertificateidentifier( ).
    LOOP AT lo_dbinstance->get_domainmemberships( ) into lo_row_18.
      lo_row_19 = lo_row_18.
      IF lo_row_19 IS NOT INITIAL.
        lv_string = lo_row_19->get_domain( ).
        lv_string = lo_row_19->get_status( ).
        lv_string = lo_row_19->get_fqdn( ).
        lv_string = lo_row_19->get_iamrolename( ).
      ENDIF.
    ENDLOOP.
    lv_boolean = lo_dbinstance->get_copytagstosnapshot( ).
    lv_integeroptional = lo_dbinstance->get_monitoringinterval( ).
    lv_string = lo_dbinstance->get_enhancedmonresourcearn( ).
    lv_string = lo_dbinstance->get_monitoringrolearn( ).
    lv_integeroptional = lo_dbinstance->get_promotiontier( ).
    lv_string = lo_dbinstance->get_dbinstancearn( ).
    lv_string = lo_dbinstance->get_timezone( ).
    lv_boolean = lo_dbinstance->get_iamdatabaseauthntctnenbd( ).
    lv_booleanoptional = lo_dbinstance->get_performanceinsightsenbd( ).
    lv_string = lo_dbinstance->get_performanceinsightskms00( ).
    LOOP AT lo_dbinstance->get_enabledcloudwatchlogsexp( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_string = lo_row_9->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_booleanoptional = lo_dbinstance->get_deletionprotection( ).
  ENDIF.
ENDIF.

/AWS1/IF_NEP=>DELETEDBINSTANCE()¶