Skip to content

/AWS1/IF_NEP=>MODIFYDBCLUSTER()

About ModifyDBCluster

Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Method Signature

METHODS /AWS1/IF_NEP~MODIFYDBCLUSTER
  IMPORTING
    !IV_DBCLUSTERIDENTIFIER TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_NEWDBCLUSTERIDENTIFIER TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_APPLYIMMEDIATELY TYPE /AWS1/NEPBOOLEAN OPTIONAL
    !IV_BACKUPRETENTIONPERIOD TYPE /AWS1/NEPINTEGEROPTIONAL OPTIONAL
    !IV_DBCLUSTERPARAMGROUPNAME TYPE /AWS1/NEPSTRING OPTIONAL
    !IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_NEPVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST OPTIONAL
    !IV_PORT TYPE /AWS1/NEPINTEGEROPTIONAL OPTIONAL
    !IV_MASTERUSERPASSWORD TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_OPTIONGROUPNAME TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_PREFERREDBACKUPWINDOW TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_PREFERREDMAINTENANCEWIN00 TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_ENBIAMDATABASEAUTHNTCTN TYPE /AWS1/NEPBOOLEANOPTIONAL OPTIONAL
    !IO_CLOUDWATCHLOGSEXPORTCONF TYPE REF TO /AWS1/CL_NEPCLOUDWATCHLOGSEX00 OPTIONAL
    !IV_ENGINEVERSION TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_ALLOWMAJORVERSIONUPGRADE TYPE /AWS1/NEPBOOLEAN OPTIONAL
    !IV_DBINSTANCEPARAMGROUPNAME TYPE /AWS1/NEPSTRING OPTIONAL
    !IV_DELETIONPROTECTION TYPE /AWS1/NEPBOOLEANOPTIONAL OPTIONAL
    !IV_COPYTAGSTOSNAPSHOT TYPE /AWS1/NEPBOOLEANOPTIONAL OPTIONAL
    !IO_SERVERLESSV2SCALINGCONF TYPE REF TO /AWS1/CL_NEPSERVERLESSV2SCAC00 OPTIONAL
    !IV_STORAGETYPE TYPE /AWS1/NEPSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nepmodifydbclustrslt
  RAISING
    /AWS1/CX_NEPDBCLSTALREXFAULT
    /AWS1/CX_NEPDBCLUSTNOTFNDFAULT
    /AWS1/CX_NEPDBCLSTPRMGRNOTFN00
    /AWS1/CX_NEPDBSNETGRNOTFNDFA00
    /AWS1/CX_NEPINVDBCLSTSTATEFA00
    /AWS1/CX_NEPINVDBINSTSTATEFA00
    /AWS1/CX_NEPINVDBSECGRSTATEF00
    /AWS1/CX_NEPINVDBSNETGRSTATE00
    /AWS1/CX_NEPINVALIDSUBNET
    /AWS1/CX_NEPINVVPCNETWORKSTA00
    /AWS1/CX_NEPSTRGQUOTAEXCDFAULT
    /AWS1/CX_NEPSTRGTYPENOTSUPPE00
    /AWS1/CX_NEPCLIENTEXC
    /AWS1/CX_NEPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_dbclusteridentifier TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Optional arguments:

iv_newdbclusteridentifier TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • The first character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

iv_applyimmediately TYPE /AWS1/NEPBOOLEAN /AWS1/NEPBOOLEAN

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

iv_backupretentionperiod TYPE /AWS1/NEPINTEGEROPTIONAL /AWS1/NEPINTEGEROPTIONAL

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

iv_dbclusterparamgroupname TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The name of the DB cluster parameter group to use for the DB cluster.

it_vpcsecuritygroupids TYPE /AWS1/CL_NEPVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST

A list of VPC security groups that the DB cluster will belong to.

iv_port TYPE /AWS1/NEPINTEGEROPTIONAL /AWS1/NEPINTEGEROPTIONAL

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

iv_masteruserpassword TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

Not supported by Neptune.

iv_optiongroupname TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

Not supported by Neptune.

iv_preferredbackupwindow TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

iv_preferredmaintenancewin00 TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

iv_enbiamdatabaseauthntctn TYPE /AWS1/NEPBOOLEANOPTIONAL /AWS1/NEPBOOLEANOPTIONAL

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

io_cloudwatchlogsexportconf TYPE REF TO /AWS1/CL_NEPCLOUDWATCHLOGSEX00 /AWS1/CL_NEPCLOUDWATCHLOGSEX00

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. See Using the CLI to publish Neptune audit logs to CloudWatch Logs.

iv_engineversion TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

iv_allowmajorversionupgrade TYPE /AWS1/NEPBOOLEAN /AWS1/NEPBOOLEAN

A value that indicates whether upgrades between different major versions are allowed.

Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.

iv_dbinstanceparamgroupname TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

  • The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

  • The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

iv_deletionprotection TYPE /AWS1/NEPBOOLEANOPTIONAL /AWS1/NEPBOOLEANOPTIONAL

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

iv_copytagstosnapshot TYPE /AWS1/NEPBOOLEANOPTIONAL /AWS1/NEPBOOLEANOPTIONAL

If set to true, tags are copied to any snapshot of the DB cluster that is created.

io_serverlessv2scalingconf TYPE REF TO /AWS1/CL_NEPSERVERLESSV2SCAC00 /AWS1/CL_NEPSERVERLESSV2SCAC00

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

iv_storagetype TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The storage type to associate with the DB cluster.

Valid Values:

  • standard   –   ( the default ) Configures cost-effective database storage for applications with moderate to small I/O usage.

  • iopt1   –   Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

    Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

RETURNING

oo_output TYPE REF TO /aws1/cl_nepmodifydbclustrslt /AWS1/CL_NEPMODIFYDBCLUSTRSLT

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->modifydbcluster(
  io_cloudwatchlogsexportconf = new /aws1/cl_nepcloudwatchlogsex00(
    it_disablelogtypes = VALUE /aws1/cl_neplogtypelist_w=>tt_logtypelist(
      ( new /aws1/cl_neplogtypelist_w( |string| ) )
    )
    it_enablelogtypes = VALUE /aws1/cl_neplogtypelist_w=>tt_logtypelist(
      ( new /aws1/cl_neplogtypelist_w( |string| ) )
    )
  )
  io_serverlessv2scalingconf = new /aws1/cl_nepserverlessv2scac00(
    iv_maxcapacity = '0.1'
    iv_mincapacity = '0.1'
  )
  it_vpcsecuritygroupids = VALUE /aws1/cl_nepvpcsecgrpidlist_w=>tt_vpcsecuritygroupidlist(
    ( new /aws1/cl_nepvpcsecgrpidlist_w( |string| ) )
  )
  iv_allowmajorversionupgrade = ABAP_TRUE
  iv_applyimmediately = ABAP_TRUE
  iv_backupretentionperiod = 123
  iv_copytagstosnapshot = ABAP_TRUE
  iv_dbclusteridentifier = |string|
  iv_dbclusterparamgroupname = |string|
  iv_dbinstanceparamgroupname = |string|
  iv_deletionprotection = ABAP_TRUE
  iv_enbiamdatabaseauthntctn = ABAP_TRUE
  iv_engineversion = |string|
  iv_masteruserpassword = |string|
  iv_newdbclusteridentifier = |string|
  iv_optiongroupname = |string|
  iv_port = 123
  iv_preferredbackupwindow = |string|
  iv_preferredmaintenancewin00 = |string|
  iv_storagetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_dbcluster = lo_result->get_dbcluster( ).
  IF lo_dbcluster IS NOT INITIAL.
    lv_integeroptional = lo_dbcluster->get_allocatedstorage( ).
    LOOP AT lo_dbcluster->get_availabilityzones( ) 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_integeroptional = lo_dbcluster->get_backupretentionperiod( ).
    lv_string = lo_dbcluster->get_charactersetname( ).
    lv_string = lo_dbcluster->get_databasename( ).
    lv_string = lo_dbcluster->get_dbclusteridentifier( ).
    lv_string = lo_dbcluster->get_dbclusterparametergroup( ).
    lv_string = lo_dbcluster->get_dbsubnetgroup( ).
    lv_string = lo_dbcluster->get_status( ).
    lv_string = lo_dbcluster->get_percentprogress( ).
    lv_tstamp = lo_dbcluster->get_earliestrestorabletime( ).
    lv_string = lo_dbcluster->get_endpoint( ).
    lv_string = lo_dbcluster->get_readerendpoint( ).
    lv_boolean = lo_dbcluster->get_multiaz( ).
    lv_string = lo_dbcluster->get_engine( ).
    lv_string = lo_dbcluster->get_engineversion( ).
    lv_tstamp = lo_dbcluster->get_latestrestorabletime( ).
    lv_integeroptional = lo_dbcluster->get_port( ).
    lv_string = lo_dbcluster->get_masterusername( ).
    LOOP AT lo_dbcluster->get_dbclustoptiongrpmember00( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_string = lo_row_3->get_dbclusteroptiongroupname( ).
        lv_string = lo_row_3->get_status( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbcluster->get_preferredbackupwindow( ).
    lv_string = lo_dbcluster->get_preferredmaintenancewi00( ).
    lv_string = lo_dbcluster->get_replsourceidentifier( ).
    LOOP AT lo_dbcluster->get_readreplicaidentifiers( ) 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.
    LOOP AT lo_dbcluster->get_dbclustermembers( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_string = lo_row_7->get_dbinstanceidentifier( ).
        lv_boolean = lo_row_7->get_isclusterwriter( ).
        lv_string = lo_row_7->get_dbclustparamgroupstatus( ).
        lv_integeroptional = lo_row_7->get_promotiontier( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_dbcluster->get_vpcsecuritygroups( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_string = lo_row_9->get_vpcsecuritygroupid( ).
        lv_string = lo_row_9->get_status( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbcluster->get_hostedzoneid( ).
    lv_boolean = lo_dbcluster->get_storageencrypted( ).
    lv_string = lo_dbcluster->get_kmskeyid( ).
    lv_string = lo_dbcluster->get_dbclusterresourceid( ).
    lv_string = lo_dbcluster->get_dbclusterarn( ).
    LOOP AT lo_dbcluster->get_associatedroles( ) into lo_row_10.
      lo_row_11 = lo_row_10.
      IF lo_row_11 IS NOT INITIAL.
        lv_string = lo_row_11->get_rolearn( ).
        lv_string = lo_row_11->get_status( ).
        lv_string = lo_row_11->get_featurename( ).
      ENDIF.
    ENDLOOP.
    lv_boolean = lo_dbcluster->get_iamdatabaseauthntctnenbd( ).
    lv_string = lo_dbcluster->get_clonegroupid( ).
    lv_tstamp = lo_dbcluster->get_clustercreatetime( ).
    lv_booleanoptional = lo_dbcluster->get_copytagstosnapshot( ).
    LOOP AT lo_dbcluster->get_enabledcloudwatchlogsexp( ) into lo_row_12.
      lo_row_13 = lo_row_12.
      IF lo_row_13 IS NOT INITIAL.
        lv_string = lo_row_13->get_value( ).
      ENDIF.
    ENDLOOP.
    lo_clusterpendingmodifiedv = lo_dbcluster->get_pendingmodifiedvalues( ).
    IF lo_clusterpendingmodifiedv IS NOT INITIAL.
      lo_pendingcloudwatchlogsex = lo_clusterpendingmodifiedv->get_pendingcloudwatchlogsexp( ).
      IF lo_pendingcloudwatchlogsex IS NOT INITIAL.
        LOOP AT lo_pendingcloudwatchlogsex->get_logtypestoenable( ) into lo_row_12.
          lo_row_13 = lo_row_12.
          IF lo_row_13 IS NOT INITIAL.
            lv_string = lo_row_13->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_pendingcloudwatchlogsex->get_logtypestodisable( ) into lo_row_12.
          lo_row_13 = lo_row_12.
          IF lo_row_13 IS NOT INITIAL.
            lv_string = lo_row_13->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      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( ).
    ENDIF.
    lv_booleanoptional = lo_dbcluster->get_deletionprotection( ).
    lv_booleanoptional = lo_dbcluster->get_crossaccountclone( ).
    lv_tstamp = lo_dbcluster->get_automaticrestarttime( ).
    lo_serverlessv2scalingconf = lo_dbcluster->get_serverlessv2scalingconf( ).
    IF lo_serverlessv2scalingconf IS NOT INITIAL.
      lv_doubleoptional = lo_serverlessv2scalingconf->get_mincapacity( ).
      lv_doubleoptional = lo_serverlessv2scalingconf->get_maxcapacity( ).
    ENDIF.
    lv_globalclusteridentifier = lo_dbcluster->get_globalclusteridentifier( ).
    lv_tstamp = lo_dbcluster->get_iooptimizednextalwedmo00( ).
    lv_string = lo_dbcluster->get_storagetype( ).
  ENDIF.
ENDIF.