Skip to content

/AWS1/IF_TSI=>UPDATEDBINSTANCE()

About UpdateDbInstance

Updates a Timestream for InfluxDB DB instance.

Method Signature

METHODS /AWS1/IF_TSI~UPDATEDBINSTANCE
  IMPORTING
    !IV_IDENTIFIER TYPE /AWS1/TSIDBINSTANCEIDENTIFIER OPTIONAL
    !IO_LOGDELIVERYCONFIGURATION TYPE REF TO /AWS1/CL_TSILOGDELIVERYCONF OPTIONAL
    !IV_DBPARAMETERGROUPID TYPE /AWS1/TSIDBPARAMETERGROUPID OPTIONAL
    !IV_PORT TYPE /AWS1/TSIPORT OPTIONAL
    !IV_DBINSTANCETYPE TYPE /AWS1/TSIDBINSTANCETYPE OPTIONAL
    !IV_DEPLOYMENTTYPE TYPE /AWS1/TSIDEPLOYMENTTYPE OPTIONAL
    !IV_DBSTORAGETYPE TYPE /AWS1/TSIDBSTORAGETYPE OPTIONAL
    !IV_ALLOCATEDSTORAGE TYPE /AWS1/TSIALLOCATEDSTORAGE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tsiupdatedbinstoutput
  RAISING
    /AWS1/CX_TSIACCESSDENIEDEX
    /AWS1/CX_TSICONFLICTEXCEPTION
    /AWS1/CX_TSIINTERNALSERVEREX
    /AWS1/CX_TSIRESOURCENOTFOUNDEX
    /AWS1/CX_TSITHROTTLINGEX
    /AWS1/CX_TSIVALIDATIONEX
    /AWS1/CX_TSICLIENTEXC
    /AWS1/CX_TSISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_identifier TYPE /AWS1/TSIDBINSTANCEIDENTIFIER /AWS1/TSIDBINSTANCEIDENTIFIER

The id of the DB instance.

Optional arguments:

io_logdeliveryconfiguration TYPE REF TO /AWS1/CL_TSILOGDELIVERYCONF /AWS1/CL_TSILOGDELIVERYCONF

Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

iv_dbparametergroupid TYPE /AWS1/TSIDBPARAMETERGROUPID /AWS1/TSIDBPARAMETERGROUPID

The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

iv_port TYPE /AWS1/TSIPORT /AWS1/TSIPORT

The port number on which InfluxDB accepts connections.

If you change the Port value, your database restarts immediately.

Valid Values: 1024-65535

Default: 8086

Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680

iv_dbinstancetype TYPE /AWS1/TSIDBINSTANCETYPE /AWS1/TSIDBINSTANCETYPE

The Timestream for InfluxDB DB instance type to run InfluxDB on.

iv_deploymenttype TYPE /AWS1/TSIDEPLOYMENTTYPE /AWS1/TSIDEPLOYMENTTYPE

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

iv_dbstoragetype TYPE /AWS1/TSIDBSTORAGETYPE /AWS1/TSIDBSTORAGETYPE

The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

iv_allocatedstorage TYPE /AWS1/TSIALLOCATEDSTORAGE /AWS1/TSIALLOCATEDSTORAGE

The amount of storage to allocate for your DB storage type (in gibibytes).

RETURNING

oo_output TYPE REF TO /aws1/cl_tsiupdatedbinstoutput /AWS1/CL_TSIUPDATEDBINSTOUTPUT

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->updatedbinstance(
  io_logdeliveryconfiguration = new /aws1/cl_tsilogdeliveryconf(
    io_s3configuration = new /aws1/cl_tsis3configuration(
      iv_bucketname = |string|
      iv_enabled = ABAP_TRUE
    )
  )
  iv_allocatedstorage = 123
  iv_dbinstancetype = |string|
  iv_dbparametergroupid = |string|
  iv_dbstoragetype = |string|
  iv_deploymenttype = |string|
  iv_identifier = |string|
  iv_port = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_dbinstanceid = lo_result->get_id( ).
  lv_dbinstancename = lo_result->get_name( ).
  lv_arn = lo_result->get_arn( ).
  lv_status = lo_result->get_status( ).
  lv_string = lo_result->get_endpoint( ).
  lv_port = lo_result->get_port( ).
  lv_networktype = lo_result->get_networktype( ).
  lv_dbinstancetype = lo_result->get_dbinstancetype( ).
  lv_dbstoragetype = lo_result->get_dbstoragetype( ).
  lv_allocatedstorage = lo_result->get_allocatedstorage( ).
  lv_deploymenttype = lo_result->get_deploymenttype( ).
  LOOP AT lo_result->get_vpcsubnetids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_vpcsubnetid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_boolean = lo_result->get_publiclyaccessible( ).
  LOOP AT lo_result->get_vpcsecuritygroupids( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_vpcsecuritygroupid = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_dbparametergroupidentif = lo_result->get_dbparametergroupid( ).
  lv_string = lo_result->get_availabilityzone( ).
  lv_string = lo_result->get_secondaryaz( ).
  lo_logdeliveryconfiguratio = lo_result->get_logdeliveryconfiguration( ).
  IF lo_logdeliveryconfiguratio IS NOT INITIAL.
    lo_s3configuration = lo_logdeliveryconfiguratio->get_s3configuration( ).
    IF lo_s3configuration IS NOT INITIAL.
      lv_string = lo_s3configuration->get_bucketname( ).
      lv_boolean = lo_s3configuration->get_enabled( ).
    ENDIF.
  ENDIF.
  lv_string = lo_result->get_influxauthparmssecretarn( ).
  lv_dbclusterid = lo_result->get_dbclusterid( ).
  lv_instancemode = lo_result->get_instancemode( ).
  LOOP AT lo_result->get_instancemodes( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_instancemode = lo_row_5->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.