DESCRIBEDBCLUSTERS()`¶

About DescribeDBClusters¶

Returns information about provisioned DB clusters, and supports pagination.

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`iv_dbclusteridentifier` `TYPE /AWS1/NEPSTRING` `/AWS1/NEPSTRING`¶

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

`it_filters` `TYPE /AWS1/CL_NEPFILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

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

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

`iv_maxrecords` `TYPE /AWS1/NEPINTEGEROPTIONAL` `/AWS1/NEPINTEGEROPTIONAL`¶

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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

`iv_marker` `TYPE /AWS1/NEPSTRING` `/AWS1/NEPSTRING`¶

An optional pagination token provided by a previous DescribeDBClusters 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_nepdbclustermessage` `/AWS1/CL_NEPDBCLUSTERMESSAGE`¶

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~describedbclusters(
  it_filters = VALUE /aws1/cl_nepfilter=>tt_filterlist(
    (
      new /aws1/cl_nepfilter(
        it_values = VALUE /aws1/cl_nepfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_nepfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dbclusteridentifier = |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_dbclusters( ) into lo_row.
  lv_integeroptional = lo_row_1->get_allocatedstorage( ).
  LOOP AT lo_row_1->get_availabilityzones( ) into lo_row_2.
    lv_string = lo_row_3->get_value( ).
  ENDLOOP.
  lv_integeroptional = lo_row_1->get_backupretentionperiod( ).
  lv_string = lo_row_1->get_charactersetname( ).
  lv_string = lo_row_1->get_databasename( ).
  lv_string = lo_row_1->get_dbclusteridentifier( ).
  lv_string = lo_row_1->get_dbclusterparametergroup( ).
  lv_string = lo_row_1->get_dbsubnetgroup( ).
  lv_string = lo_row_1->get_status( ).
  lv_string = lo_row_1->get_percentprogress( ).
  lv_tstamp = lo_row_1->get_earliestrestorabletime( ).
  lv_string = lo_row_1->get_endpoint( ).
  lv_string = lo_row_1->get_readerendpoint( ).
  lv_boolean = lo_row_1->get_multiaz( ).
  lv_string = lo_row_1->get_engine( ).
  lv_string = lo_row_1->get_engineversion( ).
  lv_tstamp = lo_row_1->get_latestrestorabletime( ).
  lv_integeroptional = lo_row_1->get_port( ).
  lv_string = lo_row_1->get_masterusername( ).
  LOOP AT lo_row_1->get_dbclustoptiongrpmember00( ) into lo_row_4.
    lv_string = lo_row_5->get_dbclusteroptiongroupname( ).
    lv_string = lo_row_5->get_status( ).
  ENDLOOP.
  lv_string = lo_row_1->get_preferredbackupwindow( ).
  lv_string = lo_row_1->get_preferredmaintenancewi00( ).
  lv_string = lo_row_1->get_replsourceidentifier( ).
  LOOP AT lo_row_1->get_readreplicaidentifiers( ) into lo_row_6.
    lv_string = lo_row_7->get_value( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_dbclustermembers( ) into lo_row_8.
    lv_string = lo_row_9->get_dbinstanceidentifier( ).
    lv_boolean = lo_row_9->get_isclusterwriter( ).
    lv_string = lo_row_9->get_dbclustparamgroupstatus( ).
    lv_integeroptional = lo_row_9->get_promotiontier( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_vpcsecuritygroups( ) into lo_row_10.
    lv_string = lo_row_11->get_vpcsecuritygroupid( ).
    lv_string = lo_row_11->get_status( ).
  ENDLOOP.
  lv_string = lo_row_1->get_hostedzoneid( ).
  lv_boolean = lo_row_1->get_storageencrypted( ).
  lv_string = lo_row_1->get_kmskeyid( ).
  lv_string = lo_row_1->get_dbclusterresourceid( ).
  lv_string = lo_row_1->get_dbclusterarn( ).
  LOOP AT lo_row_1->get_associatedroles( ) into lo_row_12.
    lv_string = lo_row_13->get_rolearn( ).
    lv_string = lo_row_13->get_status( ).
    lv_string = lo_row_13->get_featurename( ).
  ENDLOOP.
  lv_boolean = lo_row_1->get_iamdatabaseauthntctnenbd( ).
  lv_string = lo_row_1->get_clonegroupid( ).
  lv_tstamp = lo_row_1->get_clustercreatetime( ).
  lv_booleanoptional = lo_row_1->get_copytagstosnapshot( ).
  LOOP AT lo_row_1->get_enabledcloudwatchlogsexp( ) into lo_row_14.
    lv_string = lo_row_15->get_value( ).
  ENDLOOP.
  LOOP AT lo_pendingcloudwatchlogsex->get_logtypestoenable( ) into lo_row_14.
    lv_string = lo_row_15->get_value( ).
  ENDLOOP.
  LOOP AT lo_pendingcloudwatchlogsex->get_logtypestodisable( ) into lo_row_14.
    lv_string = lo_row_15->get_value( ).
  ENDLOOP.
  lv_string = lo_clusterpendingmodifiedv->get_dbclusteridentifier( ).
  lv_booleanoptional = lo_clusterpendingmodifiedv->get_iamdatabaseauthntctnenbd( ).
  lv_string = lo_clusterpendingmodifiedv->get_engineversion( ).
  lv_integeroptional = lo_clusterpendingmodifiedv->get_backupretentionperiod( ).
  lv_string = lo_clusterpendingmodifiedv->get_storagetype( ).
  lv_integeroptional = lo_clusterpendingmodifiedv->get_allocatedstorage( ).
  lv_integeroptional = lo_clusterpendingmodifiedv->get_iops( ).
  lv_booleanoptional = lo_row_1->get_deletionprotection( ).
  lv_booleanoptional = lo_row_1->get_crossaccountclone( ).
  lv_tstamp = lo_row_1->get_automaticrestarttime( ).
  lv_doubleoptional = lo_serverlessv2scalingconf->get_mincapacity( ).
  lv_doubleoptional = lo_serverlessv2scalingconf->get_maxcapacity( ).
  lv_globalclusteridentifier = lo_row_1->get_globalclusteridentifier( ).
  lv_tstamp = lo_row_1->get_iooptimizednextalwedmo00( ).
  lv_string = lo_row_1->get_storagetype( ).
ENDLOOP.

/AWS1/CL_NEP=>DESCRIBEDBCLUSTERS()¶