DESCRIBEDBSECURITYGROUPS()`¶

About DescribeDBSecurityGroups¶

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 User Guide, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the Amazon RDS User Guide.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`iv_dbsecuritygroupname` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

The name of the DB security group to return details for.

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

This parameter isn't currently supported.

`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 DescribeDBSecurityGroups 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_rdsdbsecgroupmessage` `/AWS1/CL_RDSDBSECGROUPMESSAGE`¶

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~describedbsecuritygroups(
  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_dbsecuritygroupname = |string|
  iv_marker = |string|
  iv_maxrecords = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_marker( ).
  LOOP AT lo_result->get_dbsecuritygroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_ownerid( ).
      lv_string = lo_row_1->get_dbsecuritygroupname( ).
      lv_string = lo_row_1->get_dbsecuritygroupdesc( ).
      lv_string = lo_row_1->get_vpcid( ).
      LOOP AT lo_row_1->get_ec2securitygroups( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_status( ).
          lv_string = lo_row_3->get_ec2securitygroupname( ).
          lv_string = lo_row_3->get_ec2securitygroupid( ).
          lv_string = lo_row_3->get_ec2securitygroupownerid( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_ipranges( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_string = lo_row_5->get_status( ).
          lv_string = lo_row_5->get_cidrip( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_dbsecuritygrouparn( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To list DB security group settings¶

This example lists settings for the specified security group.

DATA(lo_result) = lo_client->/aws1/if_rds~describedbsecuritygroups( iv_dbsecuritygroupname = |mydbsecuritygroup| ) .

/AWS1/CL_RDS=>DESCRIBEDBSECURITYGROUPS()¶