Skip to content

/AWS1/IF_DMG=>MODIFYDATAPROVIDER()

About ModifyDataProvider

Modifies the specified data provider using the provided settings.

You must remove the data provider from all migration projects before you can modify it.

Method Signature

METHODS /AWS1/IF_DMG~MODIFYDATAPROVIDER
  IMPORTING
    !IV_DATAPROVIDERIDENTIFIER TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_DATAPROVIDERNAME TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_ENGINE TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_VIRTUAL TYPE /AWS1/DMGBOOLEANOPTIONAL OPTIONAL
    !IV_EXACTSETTINGS TYPE /AWS1/DMGBOOLEANOPTIONAL OPTIONAL
    !IO_SETTINGS TYPE REF TO /AWS1/CL_DMGDATAPVDRSETTINGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgmodifydatapvdrrsp
  RAISING
    /AWS1/CX_DMGACCESSDENIEDFAULT
    /AWS1/CX_DMGFAILEDDEPENDENCY00
    /AWS1/CX_DMGINVRESRCSTATEFAULT
    /AWS1/CX_DMGRESRCNOTFOUNDFAULT
    /AWS1/CX_DMGCLIENTEXC
    /AWS1/CX_DMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_dataprovideridentifier TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The identifier of the data provider. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

Optional arguments:

iv_dataprovidername TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The name of the data provider.

iv_description TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

A user-friendly description of the data provider.

iv_engine TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, db2, db2-zos, docdb, and sybase. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.

iv_virtual TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Indicates whether the data provider is virtual.

iv_exactsettings TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

If this attribute is Y, the current call to ModifyDataProvider replaces all existing data provider settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyDataProvider does two things:

  • It replaces any data provider settings that already exist with new values, for settings with the same names.

  • It creates new data provider settings that you specify in the call, for settings with different names.

io_settings TYPE REF TO /AWS1/CL_DMGDATAPVDRSETTINGS /AWS1/CL_DMGDATAPVDRSETTINGS

The settings in JSON format for a data provider.

RETURNING

oo_output TYPE REF TO /aws1/cl_dmgmodifydatapvdrrsp /AWS1/CL_DMGMODIFYDATAPVDRRSP

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->modifydataprovider(
  io_settings = new /aws1/cl_dmgdatapvdrsettings(
    io_docdbsettings = new /aws1/cl_dmgdocdbdatapvdrstgs(
      iv_certificatearn = |string|
      iv_databasename = |string|
      iv_port = 123
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_ibmdb2luwsettings = new /aws1/cl_dmgibmdb2luwdatapvd00(
      iv_certificatearn = |string|
      iv_databasename = |string|
      iv_port = 123
      iv_s3accessrolearn = |string|
      iv_s3path = |string|
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_ibmdb2zossettings = new /aws1/cl_dmgibmdb2zosdatapvd00(
      iv_certificatearn = |string|
      iv_databasename = |string|
      iv_port = 123
      iv_s3accessrolearn = |string|
      iv_s3path = |string|
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_mariadbsettings = new /aws1/cl_dmgmariadbdatapvdrs00(
      iv_certificatearn = |string|
      iv_port = 123
      iv_s3accessrolearn = |string|
      iv_s3path = |string|
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_microsoftsqlserverstgs = new /aws1/cl_dmgmicrosoftsqlserv01(
      iv_certificatearn = |string|
      iv_databasename = |string|
      iv_port = 123
      iv_s3accessrolearn = |string|
      iv_s3path = |string|
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_mongodbsettings = new /aws1/cl_dmgmongodbdatapvdrs00(
      iv_authmechanism = |string|
      iv_authsource = |string|
      iv_authtype = |string|
      iv_certificatearn = |string|
      iv_databasename = |string|
      iv_port = 123
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_mysqlsettings = new /aws1/cl_dmgmysqldatapvdrstgs(
      iv_certificatearn = |string|
      iv_port = 123
      iv_s3accessrolearn = |string|
      iv_s3path = |string|
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_oraclesettings = new /aws1/cl_dmgoracledatapvdrstgs(
      iv_asmserver = |string|
      iv_certificatearn = |string|
      iv_databasename = |string|
      iv_port = 123
      iv_s3accessrolearn = |string|
      iv_s3path = |string|
      iv_secretsmanageroracleasm00 = |string|
      iv_secretsmanageroracleasm01 = |string|
      iv_secretsmanagersecdbenca00 = |string|
      iv_secretsmanagersecdbencs00 = |string|
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_postgresqlsettings = new /aws1/cl_dmgpostgresqldatapv00(
      iv_certificatearn = |string|
      iv_databasename = |string|
      iv_port = 123
      iv_s3accessrolearn = |string|
      iv_s3path = |string|
      iv_servername = |string|
      iv_sslmode = |string|
    )
    io_redshiftsettings = new /aws1/cl_dmgreddatapvdrstgs(
      iv_databasename = |string|
      iv_port = 123
      iv_s3accessrolearn = |string|
      iv_s3path = |string|
      iv_servername = |string|
    )
    io_sybaseasesettings = new /aws1/cl_dmgsybaseasedatapvd00(
      iv_certificatearn = |string|
      iv_databasename = |string|
      iv_encryptpassword = ABAP_TRUE
      iv_port = 123
      iv_servername = |string|
      iv_sslmode = |string|
    )
  )
  iv_dataprovideridentifier = |string|
  iv_dataprovidername = |string|
  iv_description = |string|
  iv_engine = |string|
  iv_exactsettings = ABAP_TRUE
  iv_virtual = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_dataprovider = lo_result->get_dataprovider( ).
  IF lo_dataprovider IS NOT INITIAL.
    lv_string = lo_dataprovider->get_dataprovidername( ).
    lv_string = lo_dataprovider->get_dataproviderarn( ).
    lv_iso8601datetime = lo_dataprovider->get_dataprovidercreationtime( ).
    lv_string = lo_dataprovider->get_description( ).
    lv_string = lo_dataprovider->get_engine( ).
    lv_booleanoptional = lo_dataprovider->get_virtual( ).
    lo_dataprovidersettings = lo_dataprovider->get_settings( ).
    IF lo_dataprovidersettings IS NOT INITIAL.
      lo_redshiftdataproviderset = lo_dataprovidersettings->get_redshiftsettings( ).
      IF lo_redshiftdataproviderset IS NOT INITIAL.
        lv_string = lo_redshiftdataproviderset->get_servername( ).
        lv_integeroptional = lo_redshiftdataproviderset->get_port( ).
        lv_string = lo_redshiftdataproviderset->get_databasename( ).
        lv_string = lo_redshiftdataproviderset->get_s3path( ).
        lv_string = lo_redshiftdataproviderset->get_s3accessrolearn( ).
      ENDIF.
      lo_postgresqldataproviders = lo_dataprovidersettings->get_postgresqlsettings( ).
      IF lo_postgresqldataproviders IS NOT INITIAL.
        lv_string = lo_postgresqldataproviders->get_servername( ).
        lv_integeroptional = lo_postgresqldataproviders->get_port( ).
        lv_string = lo_postgresqldataproviders->get_databasename( ).
        lv_dmssslmodevalue = lo_postgresqldataproviders->get_sslmode( ).
        lv_string = lo_postgresqldataproviders->get_certificatearn( ).
        lv_string = lo_postgresqldataproviders->get_s3path( ).
        lv_string = lo_postgresqldataproviders->get_s3accessrolearn( ).
      ENDIF.
      lo_mysqldataprovidersettin = lo_dataprovidersettings->get_mysqlsettings( ).
      IF lo_mysqldataprovidersettin IS NOT INITIAL.
        lv_string = lo_mysqldataprovidersettin->get_servername( ).
        lv_integeroptional = lo_mysqldataprovidersettin->get_port( ).
        lv_dmssslmodevalue = lo_mysqldataprovidersettin->get_sslmode( ).
        lv_string = lo_mysqldataprovidersettin->get_certificatearn( ).
        lv_string = lo_mysqldataprovidersettin->get_s3path( ).
        lv_string = lo_mysqldataprovidersettin->get_s3accessrolearn( ).
      ENDIF.
      lo_oracledataprovidersetti = lo_dataprovidersettings->get_oraclesettings( ).
      IF lo_oracledataprovidersetti IS NOT INITIAL.
        lv_string = lo_oracledataprovidersetti->get_servername( ).
        lv_integeroptional = lo_oracledataprovidersetti->get_port( ).
        lv_string = lo_oracledataprovidersetti->get_databasename( ).
        lv_dmssslmodevalue = lo_oracledataprovidersetti->get_sslmode( ).
        lv_string = lo_oracledataprovidersetti->get_certificatearn( ).
        lv_string = lo_oracledataprovidersetti->get_asmserver( ).
        lv_string = lo_oracledataprovidersetti->get_secretsmanageroracleas01( ).
        lv_string = lo_oracledataprovidersetti->get_secretsmanageroracleas00( ).
        lv_string = lo_oracledataprovidersetti->get_secretsmanagersecdbenc00( ).
        lv_string = lo_oracledataprovidersetti->get_secretsmanagersecdbenc01( ).
        lv_string = lo_oracledataprovidersetti->get_s3path( ).
        lv_string = lo_oracledataprovidersetti->get_s3accessrolearn( ).
      ENDIF.
      lo_sybaseasedataproviderse = lo_dataprovidersettings->get_sybaseasesettings( ).
      IF lo_sybaseasedataproviderse IS NOT INITIAL.
        lv_string = lo_sybaseasedataproviderse->get_servername( ).
        lv_integeroptional = lo_sybaseasedataproviderse->get_port( ).
        lv_string = lo_sybaseasedataproviderse->get_databasename( ).
        lv_dmssslmodevalue = lo_sybaseasedataproviderse->get_sslmode( ).
        lv_booleanoptional = lo_sybaseasedataproviderse->get_encryptpassword( ).
        lv_string = lo_sybaseasedataproviderse->get_certificatearn( ).
      ENDIF.
      lo_microsoftsqlserverdatap = lo_dataprovidersettings->get_microsoftsqlserverstgs( ).
      IF lo_microsoftsqlserverdatap IS NOT INITIAL.
        lv_string = lo_microsoftsqlserverdatap->get_servername( ).
        lv_integeroptional = lo_microsoftsqlserverdatap->get_port( ).
        lv_string = lo_microsoftsqlserverdatap->get_databasename( ).
        lv_dmssslmodevalue = lo_microsoftsqlserverdatap->get_sslmode( ).
        lv_string = lo_microsoftsqlserverdatap->get_certificatearn( ).
        lv_string = lo_microsoftsqlserverdatap->get_s3path( ).
        lv_string = lo_microsoftsqlserverdatap->get_s3accessrolearn( ).
      ENDIF.
      lo_docdbdataprovidersettin = lo_dataprovidersettings->get_docdbsettings( ).
      IF lo_docdbdataprovidersettin IS NOT INITIAL.
        lv_string = lo_docdbdataprovidersettin->get_servername( ).
        lv_integeroptional = lo_docdbdataprovidersettin->get_port( ).
        lv_string = lo_docdbdataprovidersettin->get_databasename( ).
        lv_dmssslmodevalue = lo_docdbdataprovidersettin->get_sslmode( ).
        lv_string = lo_docdbdataprovidersettin->get_certificatearn( ).
      ENDIF.
      lo_mariadbdataprovidersett = lo_dataprovidersettings->get_mariadbsettings( ).
      IF lo_mariadbdataprovidersett IS NOT INITIAL.
        lv_string = lo_mariadbdataprovidersett->get_servername( ).
        lv_integeroptional = lo_mariadbdataprovidersett->get_port( ).
        lv_dmssslmodevalue = lo_mariadbdataprovidersett->get_sslmode( ).
        lv_string = lo_mariadbdataprovidersett->get_certificatearn( ).
        lv_string = lo_mariadbdataprovidersett->get_s3path( ).
        lv_string = lo_mariadbdataprovidersett->get_s3accessrolearn( ).
      ENDIF.
      lo_ibmdb2luwdataproviderse = lo_dataprovidersettings->get_ibmdb2luwsettings( ).
      IF lo_ibmdb2luwdataproviderse IS NOT INITIAL.
        lv_string = lo_ibmdb2luwdataproviderse->get_servername( ).
        lv_integeroptional = lo_ibmdb2luwdataproviderse->get_port( ).
        lv_string = lo_ibmdb2luwdataproviderse->get_databasename( ).
        lv_dmssslmodevalue = lo_ibmdb2luwdataproviderse->get_sslmode( ).
        lv_string = lo_ibmdb2luwdataproviderse->get_certificatearn( ).
        lv_string = lo_ibmdb2luwdataproviderse->get_s3path( ).
        lv_string = lo_ibmdb2luwdataproviderse->get_s3accessrolearn( ).
      ENDIF.
      lo_ibmdb2zosdataproviderse = lo_dataprovidersettings->get_ibmdb2zossettings( ).
      IF lo_ibmdb2zosdataproviderse IS NOT INITIAL.
        lv_string = lo_ibmdb2zosdataproviderse->get_servername( ).
        lv_integeroptional = lo_ibmdb2zosdataproviderse->get_port( ).
        lv_string = lo_ibmdb2zosdataproviderse->get_databasename( ).
        lv_dmssslmodevalue = lo_ibmdb2zosdataproviderse->get_sslmode( ).
        lv_string = lo_ibmdb2zosdataproviderse->get_certificatearn( ).
        lv_string = lo_ibmdb2zosdataproviderse->get_s3path( ).
        lv_string = lo_ibmdb2zosdataproviderse->get_s3accessrolearn( ).
      ENDIF.
      lo_mongodbdataprovidersett = lo_dataprovidersettings->get_mongodbsettings( ).
      IF lo_mongodbdataprovidersett IS NOT INITIAL.
        lv_string = lo_mongodbdataprovidersett->get_servername( ).
        lv_integeroptional = lo_mongodbdataprovidersett->get_port( ).
        lv_string = lo_mongodbdataprovidersett->get_databasename( ).
        lv_dmssslmodevalue = lo_mongodbdataprovidersett->get_sslmode( ).
        lv_string = lo_mongodbdataprovidersett->get_certificatearn( ).
        lv_authtypevalue = lo_mongodbdataprovidersett->get_authtype( ).
        lv_string = lo_mongodbdataprovidersett->get_authsource( ).
        lv_authmechanismvalue = lo_mongodbdataprovidersett->get_authmechanism( ).
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.

Modify Data Provider

Modifies the specified data provider using the provided settings.

DATA(lo_result) = lo_client->modifydataprovider(
  io_settings = new /aws1/cl_dmgdatapvdrsettings(
    io_microsoftsqlserverstgs = new /aws1/cl_dmgmicrosoftsqlserv01(
      iv_databasename = |DatabaseName|
      iv_port = 11112
      iv_servername = |ServerName2|
      iv_sslmode = |none|
    )
  )
  iv_dataprovideridentifier = |arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345|
  iv_dataprovidername = |new-name|
  iv_description = |description|
  iv_engine = |sqlserver|
).