/AWS1/IF_DMG=>MODIFYREPLICATIONINSTANCE()¶
About ModifyReplicationInstance¶
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.
Some settings are applied during the maintenance window.
Method Signature¶
METHODS /AWS1/IF_DMG~MODIFYREPLICATIONINSTANCE
IMPORTING
!IV_REPLICATIONINSTANCEARN TYPE /AWS1/DMGSTRING OPTIONAL
!IV_ALLOCATEDSTORAGE TYPE /AWS1/DMGINTEGEROPTIONAL OPTIONAL
!IV_APPLYIMMEDIATELY TYPE /AWS1/DMGBOOLEAN OPTIONAL
!IV_REPLICATIONINSTANCECLASS TYPE /AWS1/DMGREPLINSTANCECLASS OPTIONAL
!IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_DMGVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST OPTIONAL
!IV_PREFERREDMAINTENANCEWIN00 TYPE /AWS1/DMGSTRING OPTIONAL
!IV_MULTIAZ TYPE /AWS1/DMGBOOLEANOPTIONAL OPTIONAL
!IV_ENGINEVERSION TYPE /AWS1/DMGSTRING OPTIONAL
!IV_ALLOWMAJORVERSIONUPGRADE TYPE /AWS1/DMGBOOLEAN OPTIONAL
!IV_AUTOMINORVERSIONUPGRADE TYPE /AWS1/DMGBOOLEANOPTIONAL OPTIONAL
!IV_REPLINSTANCEIDENTIFIER TYPE /AWS1/DMGSTRING OPTIONAL
!IV_NETWORKTYPE TYPE /AWS1/DMGSTRING OPTIONAL
!IO_KERBEROSAUTHNTCTNSETTINGS TYPE REF TO /AWS1/CL_DMGKERBEROSAUTHNSTGS OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgmodifyreplinstrsp
RAISING
/AWS1/CX_DMGACCESSDENIEDFAULT
/AWS1/CX_DMGINSUFFICIENTRESR00
/AWS1/CX_DMGINVRESRCSTATEFAULT
/AWS1/CX_DMGRESRCALRDYEXFAULT
/AWS1/CX_DMGRESRCNOTFOUNDFAULT
/AWS1/CX_DMGSTRGQUOTAEXCDFAULT
/AWS1/CX_DMGUPGRADEDEPENDENC00
/AWS1/CX_DMGCLIENTEXC
/AWS1/CX_DMGSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_replicationinstancearn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING¶
The Amazon Resource Name (ARN) of the replication instance.
Optional arguments:¶
iv_allocatedstorage TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL¶
The amount of storage (in gigabytes) to be allocated for the replication instance.
iv_applyimmediately TYPE /AWS1/DMGBOOLEAN /AWS1/DMGBOOLEAN¶
Indicates whether the changes should be applied immediately or during the next maintenance window.
iv_replicationinstanceclass TYPE /AWS1/DMGREPLINSTANCECLASS /AWS1/DMGREPLINSTANCECLASS¶
The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to
"dms.c4.large".For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
it_vpcsecuritygroupids TYPE /AWS1/CL_DMGVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST¶
Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
iv_preferredmaintenancewin00 TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING¶
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
iv_multiaz TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL¶
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZoneparameter if the Multi-AZ parameter is set totrue.
iv_engineversion TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING¶
The engine version number of the replication instance.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgradetotrue.
iv_allowmajorversionupgrade TYPE /AWS1/DMGBOOLEAN /AWS1/DMGBOOLEAN¶
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.
This parameter must be set to
truewhen specifying a value for theEngineVersionparameter that is a different major version than the replication instance's current version.
iv_autominorversionupgrade TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL¶
A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
This parameter is set to
trueduring the maintenance window.A newer minor version is available.
DMS has enabled automatic patching for the given engine version.
iv_replinstanceidentifier TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING¶
The replication instance identifier. This parameter is stored as a lowercase string.
iv_networktype TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING¶
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
io_kerberosauthntctnsettings TYPE REF TO /AWS1/CL_DMGKERBEROSAUTHNSTGS /AWS1/CL_DMGKERBEROSAUTHNSTGS¶
Specifies the settings required for kerberos authentication when modifying a replication instance.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_dmgmodifyreplinstrsp /AWS1/CL_DMGMODIFYREPLINSTRSP¶
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->modifyreplicationinstance(
io_kerberosauthntctnsettings = new /aws1/cl_dmgkerberosauthnstgs(
iv_keycachesecretiamarn = |string|
iv_keycachesecretid = |string|
iv_krb5filecontents = |string|
)
it_vpcsecuritygroupids = VALUE /aws1/cl_dmgvpcsecgrpidlist_w=>tt_vpcsecuritygroupidlist(
( new /aws1/cl_dmgvpcsecgrpidlist_w( |string| ) )
)
iv_allocatedstorage = 123
iv_allowmajorversionupgrade = ABAP_TRUE
iv_applyimmediately = ABAP_TRUE
iv_autominorversionupgrade = ABAP_TRUE
iv_engineversion = |string|
iv_multiaz = ABAP_TRUE
iv_networktype = |string|
iv_preferredmaintenancewin00 = |string|
iv_replicationinstancearn = |string|
iv_replicationinstanceclass = |string|
iv_replinstanceidentifier = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lo_replicationinstance = lo_result->get_replicationinstance( ).
IF lo_replicationinstance IS NOT INITIAL.
lv_string = lo_replicationinstance->get_replinstanceidentifier( ).
lv_replicationinstanceclas = lo_replicationinstance->get_replicationinstanceclass( ).
lv_string = lo_replicationinstance->get_replinstancestatus( ).
lv_integer = lo_replicationinstance->get_allocatedstorage( ).
lv_tstamp = lo_replicationinstance->get_instancecreatetime( ).
LOOP AT lo_replicationinstance->get_vpcsecuritygroups( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
lv_string = lo_row_1->get_vpcsecuritygroupid( ).
lv_string = lo_row_1->get_status( ).
ENDIF.
ENDLOOP.
lv_string = lo_replicationinstance->get_availabilityzone( ).
lo_replicationsubnetgroup = lo_replicationinstance->get_replicationsubnetgroup( ).
IF lo_replicationsubnetgroup IS NOT INITIAL.
lv_string = lo_replicationsubnetgroup->get_replsubnetgroupid( ).
lv_string = lo_replicationsubnetgroup->get_replsubnetgroupdesc( ).
lv_string = lo_replicationsubnetgroup->get_vpcid( ).
lv_string = lo_replicationsubnetgroup->get_subnetgroupstatus( ).
LOOP AT lo_replicationsubnetgroup->get_subnets( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_string = lo_row_3->get_subnetidentifier( ).
lo_availabilityzone = lo_row_3->get_subnetavailabilityzone( ).
IF lo_availabilityzone IS NOT INITIAL.
lv_string = lo_availabilityzone->get_name( ).
ENDIF.
lv_string = lo_row_3->get_subnetstatus( ).
ENDIF.
ENDLOOP.
LOOP AT lo_replicationsubnetgroup->get_supportednetworktypes( ) into lo_row_4.
lo_row_5 = lo_row_4.
IF lo_row_5 IS NOT INITIAL.
lv_string = lo_row_5->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
lv_string = lo_replicationinstance->get_preferredmaintenancewi00( ).
lo_replicationpendingmodif = lo_replicationinstance->get_pendingmodifiedvalues( ).
IF lo_replicationpendingmodif IS NOT INITIAL.
lv_replicationinstanceclas = lo_replicationpendingmodif->get_replicationinstanceclass( ).
lv_integeroptional = lo_replicationpendingmodif->get_allocatedstorage( ).
lv_booleanoptional = lo_replicationpendingmodif->get_multiaz( ).
lv_string = lo_replicationpendingmodif->get_engineversion( ).
lv_string = lo_replicationpendingmodif->get_networktype( ).
ENDIF.
lv_boolean = lo_replicationinstance->get_multiaz( ).
lv_string = lo_replicationinstance->get_engineversion( ).
lv_boolean = lo_replicationinstance->get_autominorversionupgrade( ).
lv_string = lo_replicationinstance->get_kmskeyid( ).
lv_string = lo_replicationinstance->get_replicationinstancearn( ).
lv_string = lo_replicationinstance->get_replinstpublicipaddress( ).
lv_string = lo_replicationinstance->get_replinstprivateipaddress( ).
LOOP AT lo_replicationinstance->get_replinstpubipaddresses( ) into lo_row_6.
lo_row_7 = lo_row_6.
IF lo_row_7 IS NOT INITIAL.
lv_string = lo_row_7->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_replicationinstance->get_replinstpvtipaddresses( ) into lo_row_8.
lo_row_9 = lo_row_8.
IF lo_row_9 IS NOT INITIAL.
lv_string = lo_row_9->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_replicationinstance->get_replinstipv6addresses( ) into lo_row_10.
lo_row_11 = lo_row_10.
IF lo_row_11 IS NOT INITIAL.
lv_string = lo_row_11->get_value( ).
ENDIF.
ENDLOOP.
lv_boolean = lo_replicationinstance->get_publiclyaccessible( ).
lv_string = lo_replicationinstance->get_secondaryaz( ).
lv_tstamp = lo_replicationinstance->get_freeuntil( ).
lv_string = lo_replicationinstance->get_dnsnameservers( ).
lv_string = lo_replicationinstance->get_networktype( ).
lo_kerberosauthentications = lo_replicationinstance->get_kerberosauthntctnstgs( ).
IF lo_kerberosauthentications IS NOT INITIAL.
lv_string = lo_kerberosauthentications->get_keycachesecretid( ).
lv_string = lo_kerberosauthentications->get_keycachesecretiamarn( ).
lv_string = lo_kerberosauthentications->get_krb5filecontents( ).
ENDIF.
ENDIF.
ENDIF.
Modify replication instance¶
Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request. Some settings are applied during the maintenance window.
DATA(lo_result) = lo_client->modifyreplicationinstance(
it_vpcsecuritygroupids = VALUE /aws1/cl_dmgvpcsecgrpidlist_w=>tt_vpcsecuritygroupidlist(
)
iv_allocatedstorage = 123
iv_allowmajorversionupgrade = ABAP_TRUE
iv_applyimmediately = ABAP_TRUE
iv_autominorversionupgrade = ABAP_TRUE
iv_engineversion = |1.5.0|
iv_multiaz = ABAP_TRUE
iv_preferredmaintenancewin00 = |sun:06:00-sun:14:00|
iv_replicationinstancearn = |arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ|
iv_replicationinstanceclass = |dms.t2.micro|
iv_replinstanceidentifier = |test-rep-1|
).