Skip to content

/AWS1/IF_TSI=>CREATEDBINSTANCE()

About CreateDbInstance

Creates a new Timestream for InfluxDB DB instance.

Method Signature

METHODS /AWS1/IF_TSI~CREATEDBINSTANCE
  IMPORTING
    !IV_NAME TYPE /AWS1/TSIDBINSTANCENAME OPTIONAL
    !IV_USERNAME TYPE /AWS1/TSIUSERNAME OPTIONAL
    !IV_PASSWORD TYPE /AWS1/TSIPASSWORD OPTIONAL
    !IV_ORGANIZATION TYPE /AWS1/TSIORGANIZATION OPTIONAL
    !IV_BUCKET TYPE /AWS1/TSIBUCKET OPTIONAL
    !IV_DBINSTANCETYPE TYPE /AWS1/TSIDBINSTANCETYPE OPTIONAL
    !IT_VPCSUBNETIDS TYPE /AWS1/CL_TSIVPCSUBNETIDLIST_W=>TT_VPCSUBNETIDLIST OPTIONAL
    !IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_TSIVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST OPTIONAL
    !IV_PUBLICLYACCESSIBLE TYPE /AWS1/TSIBOOLEAN OPTIONAL
    !IV_DBSTORAGETYPE TYPE /AWS1/TSIDBSTORAGETYPE OPTIONAL
    !IV_ALLOCATEDSTORAGE TYPE /AWS1/TSIALLOCATEDSTORAGE OPTIONAL
    !IV_DBPARAMETERGROUPID TYPE /AWS1/TSIDBPARAMETERGROUPID OPTIONAL
    !IV_DEPLOYMENTTYPE TYPE /AWS1/TSIDEPLOYMENTTYPE OPTIONAL
    !IO_LOGDELIVERYCONFIGURATION TYPE REF TO /AWS1/CL_TSILOGDELIVERYCONF OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_TSIREQUESTTAGMAP_W=>TT_REQUESTTAGMAP OPTIONAL
    !IV_PORT TYPE /AWS1/TSIPORT OPTIONAL
    !IV_NETWORKTYPE TYPE /AWS1/TSINETWORKTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tsicreatedbinstoutput
  RAISING
    /AWS1/CX_TSIACCESSDENIEDEX
    /AWS1/CX_TSICONFLICTEXCEPTION
    /AWS1/CX_TSIINTERNALSERVEREX
    /AWS1/CX_TSIRESOURCENOTFOUNDEX
    /AWS1/CX_TSISERVICEQUOTAEXCDEX
    /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_name TYPE /AWS1/TSIDBINSTANCENAME /AWS1/TSIDBINSTANCENAME

The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.

iv_password TYPE /AWS1/TSIPASSWORD /AWS1/TSIPASSWORD

The password of the initial admin user created in InfluxDB v2. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Secrets Manager in your account.

iv_dbinstancetype TYPE /AWS1/TSIDBINSTANCETYPE /AWS1/TSIDBINSTANCETYPE

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

it_vpcsubnetids TYPE /AWS1/CL_TSIVPCSUBNETIDLIST_W=>TT_VPCSUBNETIDLIST TT_VPCSUBNETIDLIST

A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

it_vpcsecuritygroupids TYPE /AWS1/CL_TSIVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST

A list of VPC security group IDs to associate with the DB instance.

iv_allocatedstorage TYPE /AWS1/TSIALLOCATEDSTORAGE /AWS1/TSIALLOCATEDSTORAGE

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

Optional arguments:

iv_username TYPE /AWS1/TSIUSERNAME /AWS1/TSIUSERNAME

The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.

iv_organization TYPE /AWS1/TSIORGANIZATION /AWS1/TSIORGANIZATION

The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.

iv_bucket TYPE /AWS1/TSIBUCKET /AWS1/TSIBUCKET

The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.

iv_publiclyaccessible TYPE /AWS1/TSIBOOLEAN /AWS1/TSIBOOLEAN

Configures the DB instance with a public IP to facilitate access.

iv_dbstoragetype TYPE /AWS1/TSIDBSTORAGETYPE /AWS1/TSIDBSTORAGETYPE

The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:

  • Influx IO Included 3000 IOPS

  • Influx IO Included 12000 IOPS

  • Influx IO Included 16000 IOPS

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_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.

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

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

it_tags TYPE /AWS1/CL_TSIREQUESTTAGMAP_W=>TT_REQUESTTAGMAP TT_REQUESTTAGMAP

A list of key-value pairs to associate with the DB instance.

iv_port TYPE /AWS1/TSIPORT /AWS1/TSIPORT

The port number on which InfluxDB accepts connections.

Valid Values: 1024-65535

Default: 8086

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

iv_networktype TYPE /AWS1/TSINETWORKTYPE /AWS1/TSINETWORKTYPE

Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

RETURNING

oo_output TYPE REF TO /aws1/cl_tsicreatedbinstoutput /AWS1/CL_TSICREATEDBINSTOUTPUT

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->createdbinstance(
  io_logdeliveryconfiguration = new /aws1/cl_tsilogdeliveryconf(
    io_s3configuration = new /aws1/cl_tsis3configuration(
      iv_bucketname = |string|
      iv_enabled = ABAP_TRUE
    )
  )
  it_tags = VALUE /aws1/cl_tsirequesttagmap_w=>tt_requesttagmap(
    (
      VALUE /aws1/cl_tsirequesttagmap_w=>ts_requesttagmap_maprow(
        value = new /aws1/cl_tsirequesttagmap_w( |string| )
        key = |string|
      )
    )
  )
  it_vpcsecuritygroupids = VALUE /aws1/cl_tsivpcsecgrpidlist_w=>tt_vpcsecuritygroupidlist(
    ( new /aws1/cl_tsivpcsecgrpidlist_w( |string| ) )
  )
  it_vpcsubnetids = VALUE /aws1/cl_tsivpcsubnetidlist_w=>tt_vpcsubnetidlist(
    ( new /aws1/cl_tsivpcsubnetidlist_w( |string| ) )
  )
  iv_allocatedstorage = 123
  iv_bucket = |string|
  iv_dbinstancetype = |string|
  iv_dbparametergroupid = |string|
  iv_dbstoragetype = |string|
  iv_deploymenttype = |string|
  iv_name = |string|
  iv_networktype = |string|
  iv_organization = |string|
  iv_password = |string|
  iv_port = 123
  iv_publiclyaccessible = ABAP_TRUE
  iv_username = |string|
).

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.