/AWS1/CL_RDS=>DESCRIBEDBINSTANCES()

About DescribeDBInstances

Describes provisioned RDS instances. This API supports pagination.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Method Signature

IMPORTING

Optional arguments:

iv_dbinstanceidentifier TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DB instance.

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

A filter that specifies one or more DB instances to describe.

Supported Filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.

• dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

iv_maxrecords TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

iv_marker TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdsdbinstancemessage /AWS1/CL_RDSDBINSTANCEMESSAGE

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_rds~describedbinstances(
  it_filters = VALUE /aws1/cl_rdsfilter=>tt_filterlist(
    (
      new /aws1/cl_rdsfilter(
        it_values = VALUE /aws1/cl_rdsfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_rdsfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dbinstanceidentifier = |string|
  iv_marker = |string|
  iv_maxrecords = 123
).

This is an example of reading all possible response values

lv_string = lo_result->get_marker( ).
LOOP AT lo_result->get_dbinstances( ) into lo_row.
  lv_string = lo_row_1->get_dbinstanceidentifier( ).
  lv_string = lo_row_1->get_dbinstanceclass( ).
  lv_string = lo_row_1->get_engine( ).
  lv_string = lo_row_1->get_dbinstancestatus( ).
  lv_tstamp = lo_row_1->get_automaticrestarttime( ).
  lv_string = lo_row_1->get_masterusername( ).
  lv_string = lo_row_1->get_dbname( ).
  lv_string = lo_endpoint->get_address( ).
  lv_integer = lo_endpoint->get_port( ).
  lv_string = lo_endpoint->get_hostedzoneid( ).
  lv_integer = lo_row_1->get_allocatedstorage( ).
  lv_tstamp = lo_row_1->get_instancecreatetime( ).
  lv_string = lo_row_1->get_preferredbackupwindow( ).
  lv_integer = lo_row_1->get_backupretentionperiod( ).
  LOOP AT lo_row_1->get_dbsecuritygroups( ) into lo_row_2.
    lv_string = lo_row_3->get_dbsecuritygroupname( ).
    lv_string = lo_row_3->get_status( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_vpcsecuritygroups( ) into lo_row_4.
    lv_string = lo_row_5->get_vpcsecuritygroupid( ).
    lv_string = lo_row_5->get_status( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_dbparametergroups( ) into lo_row_6.
    lv_string = lo_row_7->get_dbparametergroupname( ).
    lv_string = lo_row_7->get_parameterapplystatus( ).
  ENDLOOP.
  lv_string = lo_row_1->get_availabilityzone( ).
  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_8.
    lv_string = lo_row_9->get_subnetidentifier( ).
    lv_string = lo_availabilityzone->get_name( ).
    lv_string = lo_outpost->get_arn( ).
    lv_string = lo_row_9->get_subnetstatus( ).
  ENDLOOP.
  lv_string = lo_dbsubnetgroup->get_dbsubnetgrouparn( ).
  LOOP AT lo_dbsubnetgroup->get_supportednetworktypes( ) into lo_row_10.
    lv_string = lo_row_11->get_value( ).
  ENDLOOP.
  lv_string = lo_row_1->get_preferredmaintenancewi00( ).
  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( ).
  LOOP AT lo_pendingcloudwatchlogsex->get_logtypestoenable( ) into lo_row_12.
    lv_string = lo_row_13->get_value( ).
  ENDLOOP.
  LOOP AT lo_pendingcloudwatchlogsex->get_logtypestodisable( ) into lo_row_12.
    lv_string = lo_row_13->get_value( ).
  ENDLOOP.
  LOOP AT lo_pendingmodifiedvalues->get_processorfeatures( ) into lo_row_14.
    lv_string = lo_row_15->get_name( ).
    lv_string = lo_row_15->get_value( ).
  ENDLOOP.
  lv_booleanoptional = lo_pendingmodifiedvalues->get_iamdatabaseauthntctnenbd( ).
  lv_automationmode = lo_pendingmodifiedvalues->get_automationmode( ).
  lv_tstamp = lo_pendingmodifiedvalues->get_resfullautomationmdetime( ).
  lv_integeroptional = lo_pendingmodifiedvalues->get_storagethroughput( ).
  lv_string = lo_pendingmodifiedvalues->get_engine( ).
  lv_booleanoptional = lo_pendingmodifiedvalues->get_dedicatedlogvolume( ).
  lv_booleanoptional = lo_pendingmodifiedvalues->get_multitenant( ).
  lv_tstamp = lo_row_1->get_latestrestorabletime( ).
  lv_boolean = lo_row_1->get_multiaz( ).
  lv_string = lo_row_1->get_engineversion( ).
  lv_boolean = lo_row_1->get_autominorversionupgrade( ).
  lv_string = lo_row_1->get_readrplsourcedbinstid( ).
  LOOP AT lo_row_1->get_readreplicadbinstanceids( ) into lo_row_16.
    lv_string = lo_row_17->get_value( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_readreplicadbclusterids( ) into lo_row_18.
    lv_string = lo_row_19->get_value( ).
  ENDLOOP.
  lv_replicamode = lo_row_1->get_replicamode( ).
  lv_string = lo_row_1->get_licensemodel( ).
  lv_integeroptional = lo_row_1->get_iops( ).
  LOOP AT lo_row_1->get_optiongroupmemberships( ) into lo_row_20.
    lv_string = lo_row_21->get_optiongroupname( ).
    lv_string = lo_row_21->get_status( ).
  ENDLOOP.
  lv_string = lo_row_1->get_charactersetname( ).
  lv_string = lo_row_1->get_ncharcharactersetname( ).
  lv_string = lo_row_1->get_secondaryaz( ).
  lv_boolean = lo_row_1->get_publiclyaccessible( ).
  LOOP AT lo_row_1->get_statusinfos( ) into lo_row_22.
    lv_string = lo_row_23->get_statustype( ).
    lv_boolean = lo_row_23->get_normal( ).
    lv_string = lo_row_23->get_status( ).
    lv_string = lo_row_23->get_message( ).
  ENDLOOP.
  lv_string = lo_row_1->get_storagetype( ).
  lv_string = lo_row_1->get_tdecredentialarn( ).
  lv_integer = lo_row_1->get_dbinstanceport( ).
  lv_string = lo_row_1->get_dbclusteridentifier( ).
  lv_boolean = lo_row_1->get_storageencrypted( ).
  lv_string = lo_row_1->get_kmskeyid( ).
  lv_string = lo_row_1->get_dbiresourceid( ).
  lv_string = lo_row_1->get_cacertificateidentifier( ).
  LOOP AT lo_row_1->get_domainmemberships( ) into lo_row_24.
    lv_string = lo_row_25->get_domain( ).
    lv_string = lo_row_25->get_status( ).
    lv_string = lo_row_25->get_fqdn( ).
    lv_string = lo_row_25->get_iamrolename( ).
    lv_string = lo_row_25->get_ou( ).
    lv_string = lo_row_25->get_authsecretarn( ).
    LOOP AT lo_row_25->get_dnsips( ) into lo_row_10.
      lv_string = lo_row_11->get_value( ).
    ENDLOOP.
  ENDLOOP.
  lv_boolean = lo_row_1->get_copytagstosnapshot( ).
  lv_integeroptional = lo_row_1->get_monitoringinterval( ).
  lv_string = lo_row_1->get_enhancedmonresourcearn( ).
  lv_string = lo_row_1->get_monitoringrolearn( ).
  lv_integeroptional = lo_row_1->get_promotiontier( ).
  lv_string = lo_row_1->get_dbinstancearn( ).
  lv_string = lo_row_1->get_timezone( ).
  lv_boolean = lo_row_1->get_iamdatabaseauthntctnenbd( ).
  lv_databaseinsightsmode = lo_row_1->get_databaseinsightsmode( ).
  lv_booleanoptional = lo_row_1->get_performanceinsightsenbd( ).
  lv_string = lo_row_1->get_performanceinsightskms00( ).
  lv_integeroptional = lo_row_1->get_performanceinsightsret00( ).
  LOOP AT lo_row_1->get_enabledcloudwatchlogsexp( ) into lo_row_12.
    lv_string = lo_row_13->get_value( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_processorfeatures( ) into lo_row_14.
    lv_string = lo_row_15->get_name( ).
    lv_string = lo_row_15->get_value( ).
  ENDLOOP.
  lv_boolean = lo_row_1->get_deletionprotection( ).
  LOOP AT lo_row_1->get_associatedroles( ) into lo_row_26.
    lv_string = lo_row_27->get_rolearn( ).
    lv_string = lo_row_27->get_featurename( ).
    lv_string = lo_row_27->get_status( ).
  ENDLOOP.
  lv_string = lo_endpoint->get_address( ).
  lv_integer = lo_endpoint->get_port( ).
  lv_string = lo_endpoint->get_hostedzoneid( ).
  lv_integeroptional = lo_row_1->get_maxallocatedstorage( ).
  LOOP AT lo_row_1->get_taglist( ) into lo_row_28.
    lv_string = lo_row_29->get_key( ).
    lv_string = lo_row_29->get_value( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_dbinstautomatedbackups01( ) into lo_row_30.
    lv_string = lo_row_31->get_dbinstautomatedbackups00( ).
  ENDLOOP.
  lv_booleanoptional = lo_row_1->get_customerownedipenabled( ).
  lv_string = lo_row_1->get_awsbackuprecpointarn( ).
  lv_activitystreamstatus = lo_row_1->get_activitystreamstatus( ).
  lv_string = lo_row_1->get_activitystreamkmskeyid( ).
  lv_string = lo_row_1->get_activitystrmkinesisstr00( ).
  lv_activitystreammode = lo_row_1->get_activitystreammode( ).
  lv_booleanoptional = lo_row_1->get_activitystrmenginenati00( ).
  lv_automationmode = lo_row_1->get_automationmode( ).
  lv_tstamp = lo_row_1->get_resfullautomationmdetime( ).
  lv_string = lo_row_1->get_customiaminstanceprofile( ).
  lv_string = lo_row_1->get_backuptarget( ).
  lv_string = lo_row_1->get_networktype( ).
  lv_activitystreampolicysta = lo_row_1->get_activitystreamplystatus( ).
  lv_integeroptional = lo_row_1->get_storagethroughput( ).
  lv_string = lo_row_1->get_dbsystemid( ).
  lv_string = lo_masterusersecret->get_secretarn( ).
  lv_string = lo_masterusersecret->get_secretstatus( ).
  lv_string = lo_masterusersecret->get_kmskeyid( ).
  lv_string = lo_certificatedetails->get_caidentifier( ).
  lv_tstamp = lo_certificatedetails->get_validtill( ).
  lv_string = lo_row_1->get_readrplsourcedbclustid( ).
  lv_string = lo_row_1->get_percentprogress( ).
  lv_boolean = lo_row_1->get_dedicatedlogvolume( ).
  lv_booleanoptional = lo_row_1->get_isstrgcfgupgradeavaila00( ).
  lv_booleanoptional = lo_row_1->get_multitenant( ).
  lv_string = lo_row_1->get_enginelifecyclesupport( ).
ENDLOOP.

To describe a DB instance

The following example retrieves details about the specified DB instance.

DATA(lo_result) = lo_client->/aws1/if_rds~describedbinstances( iv_dbinstanceidentifier = |mydbinstancecf| ) .