/AWS1/IF_DOD=>CREATEDBINSTANCE()

About CreateDBInstance

Creates a new instance.

Method Signature

METHODS /AWS1/IF_DOD~CREATEDBINSTANCE
  IMPORTING
    !IV_DBINSTANCEIDENTIFIER TYPE /AWS1/DODSTRING OPTIONAL
    !IV_DBINSTANCECLASS TYPE /AWS1/DODSTRING OPTIONAL
    !IV_ENGINE TYPE /AWS1/DODSTRING OPTIONAL
    !IV_AVAILABILITYZONE TYPE /AWS1/DODSTRING OPTIONAL
    !IV_PREFERREDMAINTENANCEWIN00 TYPE /AWS1/DODSTRING OPTIONAL
    !IV_AUTOMINORVERSIONUPGRADE TYPE /AWS1/DODBOOLEANOPTIONAL OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DODTAG=>TT_TAGLIST OPTIONAL
    !IV_DBCLUSTERIDENTIFIER TYPE /AWS1/DODSTRING OPTIONAL
    !IV_COPYTAGSTOSNAPSHOT TYPE /AWS1/DODBOOLEANOPTIONAL OPTIONAL
    !IV_PROMOTIONTIER TYPE /AWS1/DODINTEGEROPTIONAL OPTIONAL
    !IV_ENABLEPERFORMANCEINSIGHTS TYPE /AWS1/DODBOOLEANOPTIONAL OPTIONAL
    !IV_PERFORMANCEINSIGHTSKMSK00 TYPE /AWS1/DODSTRING OPTIONAL
    !IV_CACERTIFICATEIDENTIFIER TYPE /AWS1/DODSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dodcreatedbinstresult
  RAISING
    /AWS1/CX_DODAUTHNOTFOUNDFAULT
    /AWS1/CX_DODDBCLUSTNOTFNDFAULT
    /AWS1/CX_DODDBINSTALRDYEXFAULT
    /AWS1/CX_DODDBPRMGRNOTFNDFAULT
    /AWS1/CX_DODDBSECGRNOTFNDFAULT
    /AWS1/CX_DODDBSNETGRDOESNOTC00
    /AWS1/CX_DODDBSNETGRNOTFNDFA00
    /AWS1/CX_DODINSTQUOTAEXCDFAULT
    /AWS1/CX_DODINSUFFICIENTDBIN00
    /AWS1/CX_DODINVDBCLSTSTATEFA00
    /AWS1/CX_DODINVALIDSUBNET
    /AWS1/CX_DODINVVPCNETWORKSTA00
    /AWS1/CX_DODKMSKEYNOTACCIBLE00
    /AWS1/CX_DODSTRGQUOTAEXCDFAULT
    /AWS1/CX_DODSTRGTYPENOTSUPPE00
    /AWS1/CX_DODCLIENTEXC
    /AWS1/CX_DODSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_dbinstanceidentifier TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The instance identifier. This parameter 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: mydbinstance

iv_dbinstanceclass TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The compute and memory capacity of the instance; for example, db.r5.large.

iv_engine TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The name of the database engine to be used for this instance.

Valid value: docdb

iv_dbclusteridentifier TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The identifier of the cluster that the instance will belong to.

Optional arguments:

iv_availabilityzone TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

iv_preferredmaintenancewin00 TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The time range each week 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 Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

iv_autominorversionupgrade TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

it_tags TYPE /AWS1/CL_DODTAG=>TT_TAGLIST TT_TAGLIST

The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

iv_copytagstosnapshot TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

iv_promotiontier TYPE /AWS1/DODINTEGEROPTIONAL /AWS1/DODINTEGEROPTIONAL

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

iv_enableperformanceinsights TYPE /AWS1/DODBOOLEANOPTIONAL /AWS1/DODBOOLEANOPTIONAL

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

iv_performanceinsightskmsk00 TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

iv_cacertificateidentifier TYPE /AWS1/DODSTRING /AWS1/DODSTRING

The CA certificate identifier to use for the DB instance's server certificate.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_dodcreatedbinstresult /AWS1/CL_DODCREATEDBINSTRESULT

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(
  it_tags = VALUE /aws1/cl_dodtag=>tt_taglist(
    (
      new /aws1/cl_dodtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_autominorversionupgrade = ABAP_TRUE
  iv_availabilityzone = |string|
  iv_cacertificateidentifier = |string|
  iv_copytagstosnapshot = ABAP_TRUE
  iv_dbclusteridentifier = |string|
  iv_dbinstanceclass = |string|
  iv_dbinstanceidentifier = |string|
  iv_enableperformanceinsights = ABAP_TRUE
  iv_engine = |string|
  iv_performanceinsightskmsk00 = |string|
  iv_preferredmaintenancewin00 = |string|
  iv_promotiontier = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_dbinstance = lo_result->get_dbinstance( ).
  IF lo_dbinstance IS NOT INITIAL.
    lv_string = lo_dbinstance->get_dbinstanceidentifier( ).
    lv_string = lo_dbinstance->get_dbinstanceclass( ).
    lv_string = lo_dbinstance->get_engine( ).
    lv_string = lo_dbinstance->get_dbinstancestatus( ).
    lo_endpoint = lo_dbinstance->get_endpoint( ).
    IF lo_endpoint IS NOT INITIAL.
      lv_string = lo_endpoint->get_address( ).
      lv_integer = lo_endpoint->get_port( ).
      lv_string = lo_endpoint->get_hostedzoneid( ).
    ENDIF.
    lv_tstamp = lo_dbinstance->get_instancecreatetime( ).
    lv_string = lo_dbinstance->get_preferredbackupwindow( ).
    lv_integer = lo_dbinstance->get_backupretentionperiod( ).
    LOOP AT lo_dbinstance->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_dbinstance->get_availabilityzone( ).
    lo_dbsubnetgroup = lo_dbinstance->get_dbsubnetgroup( ).
    IF lo_dbsubnetgroup IS NOT INITIAL.
      lv_string = lo_dbsubnetgroup->get_dbsubnetgroupname( ).
      lv_string = lo_dbsubnetgroup->get_dbsubnetgroupdescription( ).
      lv_string = lo_dbsubnetgroup->get_vpcid( ).
      lv_string = lo_dbsubnetgroup->get_subnetgroupstatus( ).
      LOOP AT lo_dbsubnetgroup->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.
      lv_string = lo_dbsubnetgroup->get_dbsubnetgrouparn( ).
      LOOP AT lo_dbsubnetgroup->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_dbinstance->get_preferredmaintenancewi00( ).
    lo_pendingmodifiedvalues = lo_dbinstance->get_pendingmodifiedvalues( ).
    IF lo_pendingmodifiedvalues IS NOT INITIAL.
      lv_string = lo_pendingmodifiedvalues->get_dbinstanceclass( ).
      lv_integeroptional = lo_pendingmodifiedvalues->get_allocatedstorage( ).
      lv_string = lo_pendingmodifiedvalues->get_masteruserpassword( ).
      lv_integeroptional = lo_pendingmodifiedvalues->get_port( ).
      lv_integeroptional = lo_pendingmodifiedvalues->get_backupretentionperiod( ).
      lv_booleanoptional = lo_pendingmodifiedvalues->get_multiaz( ).
      lv_string = lo_pendingmodifiedvalues->get_engineversion( ).
      lv_string = lo_pendingmodifiedvalues->get_licensemodel( ).
      lv_integeroptional = lo_pendingmodifiedvalues->get_iops( ).
      lv_string = lo_pendingmodifiedvalues->get_dbinstanceidentifier( ).
      lv_string = lo_pendingmodifiedvalues->get_storagetype( ).
      lv_string = lo_pendingmodifiedvalues->get_cacertificateidentifier( ).
      lv_string = lo_pendingmodifiedvalues->get_dbsubnetgroupname( ).
      lo_pendingcloudwatchlogsex = lo_pendingmodifiedvalues->get_pendingcloudwatchlogsexp( ).
      IF lo_pendingcloudwatchlogsex IS NOT INITIAL.
        LOOP AT lo_pendingcloudwatchlogsex->get_logtypestoenable( ) 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_pendingcloudwatchlogsex->get_logtypestodisable( ) 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.
      ENDIF.
    ENDIF.
    lv_tstamp = lo_dbinstance->get_latestrestorabletime( ).
    lv_string = lo_dbinstance->get_engineversion( ).
    lv_boolean = lo_dbinstance->get_autominorversionupgrade( ).
    lv_boolean = lo_dbinstance->get_publiclyaccessible( ).
    LOOP AT lo_dbinstance->get_statusinfos( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_string = lo_row_9->get_statustype( ).
        lv_boolean = lo_row_9->get_normal( ).
        lv_string = lo_row_9->get_status( ).
        lv_string = lo_row_9->get_message( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_dbinstance->get_dbclusteridentifier( ).
    lv_boolean = lo_dbinstance->get_storageencrypted( ).
    lv_string = lo_dbinstance->get_kmskeyid( ).
    lv_string = lo_dbinstance->get_dbiresourceid( ).
    lv_string = lo_dbinstance->get_cacertificateidentifier( ).
    lv_booleanoptional = lo_dbinstance->get_copytagstosnapshot( ).
    lv_integeroptional = lo_dbinstance->get_promotiontier( ).
    lv_string = lo_dbinstance->get_dbinstancearn( ).
    LOOP AT lo_dbinstance->get_enabledcloudwatchlogsexp( ) 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.
    lo_certificatedetails = lo_dbinstance->get_certificatedetails( ).
    IF lo_certificatedetails IS NOT INITIAL.
      lv_string = lo_certificatedetails->get_caidentifier( ).
      lv_tstamp = lo_certificatedetails->get_validtill( ).
    ENDIF.
    lv_booleanoptional = lo_dbinstance->get_performanceinsightsenbd( ).
    lv_string = lo_dbinstance->get_performanceinsightskms00( ).
  ENDIF.
ENDIF.