Skip to content

/AWS1/IF_RDS=>CREATEDBPROXY()

About CreateDBProxy

Creates a new DB proxy.

Method Signature

IMPORTING

Required arguments:

iv_dbproxyname TYPE /AWS1/RDSDBPROXYNAME /AWS1/RDSDBPROXYNAME

The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

iv_enginefamily TYPE /AWS1/RDSENGINEFAMILY /AWS1/RDSENGINEFAMILY

The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER.

iv_rolearn TYPE /AWS1/RDSARN /AWS1/RDSARN

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.

it_vpcsubnetids TYPE /AWS1/CL_RDSSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

One or more VPC subnet IDs to associate with the new proxy.

Optional arguments:

iv_defaultauthscheme TYPE /AWS1/RDSDEFAULTAUTHSCHEME /AWS1/RDSDEFAULTAUTHSCHEME

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. When set to IAM_AUTH, the proxy uses end-to-end IAM authentication to connect to the database. If you don't specify DefaultAuthScheme or specify this parameter as NONE, you must specify the Auth option.

it_auth TYPE /AWS1/CL_RDSUSERAUTHCONFIG=>TT_USERAUTHCONFIGLIST TT_USERAUTHCONFIGLIST

The authorization mechanism that the proxy uses.

it_vpcsecuritygroupids TYPE /AWS1/CL_RDSSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

One or more VPC security group IDs to associate with the new proxy.

iv_requiretls TYPE /AWS1/RDSBOOLEAN /AWS1/RDSBOOLEAN

Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy.

iv_idleclienttimeout TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database.

iv_debuglogging TYPE /AWS1/RDSBOOLEAN /AWS1/RDSBOOLEAN

Specifies whether the proxy logs detailed connection and query information. When you enable DebugLogging, the proxy captures connection details and connection pool behavior from your queries. Debug logging increases CloudWatch costs and can impact proxy performance. Enable this option only when you need to troubleshoot connection or performance issues.

it_tags TYPE /AWS1/CL_RDSTAG=>TT_TAGLIST TT_TAGLIST

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

iv_endpointnetworktype TYPE /AWS1/RDSENDPOINTNETWORKTYPE /AWS1/RDSENDPOINTNETWORKTYPE

The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.

Valid values:

  • IPV4 - The proxy endpoint supports IPv4 only.

  • IPV6 - The proxy endpoint supports IPv6 only.

  • DUAL - The proxy endpoint supports both IPv4 and IPv6.

Default: IPV4

Constraints:

  • If you specify IPV6 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

  • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.

iv_targetconnnetworktype TYPE /AWS1/RDSTARGETCONNNETWORKTYPE /AWS1/RDSTARGETCONNNETWORKTYPE

The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.

Valid values:

  • IPV4 - The proxy connects to the database using IPv4 only.

  • IPV6 - The proxy connects to the database using IPv6 only.

Default: IPV4

Constraints:

  • If you specify IPV6, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.

  • All targets registered with the proxy must be compatible with the specified network type.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdscreatedbproxyrsp /AWS1/CL_RDSCREATEDBPROXYRSP

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->createdbproxy(
  it_auth = VALUE /aws1/cl_rdsuserauthconfig=>tt_userauthconfiglist(
    (
      new /aws1/cl_rdsuserauthconfig(
        iv_authscheme = |string|
        iv_clientpasswordauthtype = |string|
        iv_description = |string|
        iv_iamauth = |string|
        iv_secretarn = |string|
        iv_username = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_rdstag=>tt_taglist(
    (
      new /aws1/cl_rdstag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  it_vpcsecuritygroupids = VALUE /aws1/cl_rdsstringlist_w=>tt_stringlist(
    ( new /aws1/cl_rdsstringlist_w( |string| ) )
  )
  it_vpcsubnetids = VALUE /aws1/cl_rdsstringlist_w=>tt_stringlist(
    ( new /aws1/cl_rdsstringlist_w( |string| ) )
  )
  iv_dbproxyname = |string|
  iv_debuglogging = ABAP_TRUE
  iv_defaultauthscheme = |string|
  iv_endpointnetworktype = |string|
  iv_enginefamily = |string|
  iv_idleclienttimeout = 123
  iv_requiretls = ABAP_TRUE
  iv_rolearn = |string|
  iv_targetconnnetworktype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_dbproxy = lo_result->get_dbproxy( ).
  IF lo_dbproxy IS NOT INITIAL.
    lv_string = lo_dbproxy->get_dbproxyname( ).
    lv_string = lo_dbproxy->get_dbproxyarn( ).
    lv_dbproxystatus = lo_dbproxy->get_status( ).
    lv_string = lo_dbproxy->get_enginefamily( ).
    lv_string = lo_dbproxy->get_vpcid( ).
    LOOP AT lo_dbproxy->get_vpcsecuritygroupids( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_dbproxy->get_vpcsubnetids( ) 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_string = lo_dbproxy->get_defaultauthscheme( ).
    LOOP AT lo_dbproxy->get_auth( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_string = lo_row_3->get_description( ).
        lv_string = lo_row_3->get_username( ).
        lv_authscheme = lo_row_3->get_authscheme( ).
        lv_string = lo_row_3->get_secretarn( ).
        lv_iamauthmode = lo_row_3->get_iamauth( ).
        lv_clientpasswordauthtype = lo_row_3->get_clientpasswordauthtype( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbproxy->get_rolearn( ).
    lv_string = lo_dbproxy->get_endpoint( ).
    lv_boolean = lo_dbproxy->get_requiretls( ).
    lv_integer = lo_dbproxy->get_idleclienttimeout( ).
    lv_boolean = lo_dbproxy->get_debuglogging( ).
    lv_tstamp = lo_dbproxy->get_createddate( ).
    lv_tstamp = lo_dbproxy->get_updateddate( ).
    lv_endpointnetworktype = lo_dbproxy->get_endpointnetworktype( ).
    lv_targetconnectionnetwork = lo_dbproxy->get_targetconnnetworktype( ).
  ENDIF.
ENDIF.