Skip to content

/AWS1/IF_ODB=>CREATEODBNETWORK()

About CreateOdbNetwork

Creates an ODB network.

Method Signature

METHODS /AWS1/IF_ODB~CREATEODBNETWORK
  IMPORTING
    !IV_DISPLAYNAME TYPE /AWS1/ODBRESOURCEDISPLAYNAME OPTIONAL
    !IV_AVAILABILITYZONE TYPE /AWS1/ODBSTRING OPTIONAL
    !IV_AVAILABILITYZONEID TYPE /AWS1/ODBSTRING OPTIONAL
    !IV_CLIENTSUBNETCIDR TYPE /AWS1/ODBSTRING OPTIONAL
    !IV_BACKUPSUBNETCIDR TYPE /AWS1/ODBSTRING OPTIONAL
    !IV_CUSTOMDOMAINNAME TYPE /AWS1/ODBSTRING OPTIONAL
    !IV_DEFAULTDNSPREFIX TYPE /AWS1/ODBSTRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/ODBGENERALINPUTSTRING OPTIONAL
    !IV_S3ACCESS TYPE /AWS1/ODBACCESS OPTIONAL
    !IV_ZEROETLACCESS TYPE /AWS1/ODBACCESS OPTIONAL
    !IV_STSACCESS TYPE /AWS1/ODBACCESS OPTIONAL
    !IV_KMSACCESS TYPE /AWS1/ODBACCESS OPTIONAL
    !IV_S3POLICYDOCUMENT TYPE /AWS1/ODBPOLICYDOCUMENT OPTIONAL
    !IV_STSPOLICYDOCUMENT TYPE /AWS1/ODBPOLICYDOCUMENT OPTIONAL
    !IV_KMSPOLICYDOCUMENT TYPE /AWS1/ODBPOLICYDOCUMENT OPTIONAL
    !IT_CROSSRGNS3RESTORESTOENB TYPE /AWS1/CL_ODBSTRINGLIST_W=>TT_STRINGLIST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_ODBREQUESTTAGMAP_W=>TT_REQUESTTAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_odbcreateodbnetoutput
  RAISING
    /AWS1/CX_ODBACCESSDENIEDEX
    /AWS1/CX_ODBCONFLICTEXCEPTION
    /AWS1/CX_ODBINTERNALSERVEREX
    /AWS1/CX_ODBSERVICEQUOTAEXCDEX
    /AWS1/CX_ODBTHROTTLINGEX
    /AWS1/CX_ODBVALIDATIONEX
    /AWS1/CX_ODBCLIENTEXC
    /AWS1/CX_ODBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_displayname TYPE /AWS1/ODBRESOURCEDISPLAYNAME /AWS1/ODBRESOURCEDISPLAYNAME

A user-friendly name for the ODB network.

iv_clientsubnetcidr TYPE /AWS1/ODBSTRING /AWS1/ODBSTRING

The CIDR range of the client subnet for the ODB network.

Constraints:

  • Must not overlap with the CIDR range of the backup subnet.

  • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

  • Must not use the following CIDR ranges that are reserved by OCI:

    • 100.106.0.0/16 and 100.107.0.0/16

    • 169.254.0.0/16

    • 224.0.0.0 - 239.255.255.255

    • 240.0.0.0 - 255.255.255.255

Optional arguments:

iv_availabilityzone TYPE /AWS1/ODBSTRING /AWS1/ODBSTRING

The Amazon Web Services Availability Zone (AZ) where the ODB network is located.

This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

iv_availabilityzoneid TYPE /AWS1/ODBSTRING /AWS1/ODBSTRING

The AZ ID of the AZ where the ODB network is located.

This operation requires that you specify a value for either availabilityZone or availabilityZoneId.

iv_backupsubnetcidr TYPE /AWS1/ODBSTRING /AWS1/ODBSTRING

The CIDR range of the backup subnet for the ODB network.

Constraints:

  • Must not overlap with the CIDR range of the client subnet.

  • Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.

  • Must not use the following CIDR ranges that are reserved by OCI:

    • 100.106.0.0/16 and 100.107.0.0/16

    • 169.254.0.0/16

    • 224.0.0.0 - 239.255.255.255

    • 240.0.0.0 - 255.255.255.255

iv_customdomainname TYPE /AWS1/ODBSTRING /AWS1/ODBSTRING

The domain name to use for the resources in the ODB network.

iv_defaultdnsprefix TYPE /AWS1/ODBSTRING /AWS1/ODBSTRING

The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.

iv_clienttoken TYPE /AWS1/ODBGENERALINPUTSTRING /AWS1/ODBGENERALINPUTSTRING

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.

iv_s3access TYPE /AWS1/ODBACCESS /AWS1/ODBACCESS

Specifies the configuration for Amazon S3 access from the ODB network.

iv_zeroetlaccess TYPE /AWS1/ODBACCESS /AWS1/ODBACCESS

Specifies the configuration for Zero-ETL access from the ODB network.

iv_stsaccess TYPE /AWS1/ODBACCESS /AWS1/ODBACCESS

The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.

iv_kmsaccess TYPE /AWS1/ODBACCESS /AWS1/ODBACCESS

The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.

iv_s3policydocument TYPE /AWS1/ODBPOLICYDOCUMENT /AWS1/ODBPOLICYDOCUMENT

Specifies the endpoint policy for Amazon S3 access from the ODB network.

iv_stspolicydocument TYPE /AWS1/ODBPOLICYDOCUMENT /AWS1/ODBPOLICYDOCUMENT

The Amazon Web Services Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.

iv_kmspolicydocument TYPE /AWS1/ODBPOLICYDOCUMENT /AWS1/ODBPOLICYDOCUMENT

The Amazon Web Services Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.

it_crossrgns3restorestoenb TYPE /AWS1/CL_ODBSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

The cross-Region Amazon S3 restore sources to enable for the ODB network.

it_tags TYPE /AWS1/CL_ODBREQUESTTAGMAP_W=>TT_REQUESTTAGMAP TT_REQUESTTAGMAP

The list of resource tags to apply to the ODB network.

RETURNING

oo_output TYPE REF TO /aws1/cl_odbcreateodbnetoutput /AWS1/CL_ODBCREATEODBNETOUTPUT

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->createodbnetwork(
  it_crossrgns3restorestoenb = VALUE /aws1/cl_odbstringlist_w=>tt_stringlist(
    ( new /aws1/cl_odbstringlist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_odbrequesttagmap_w=>tt_requesttagmap(
    (
      VALUE /aws1/cl_odbrequesttagmap_w=>ts_requesttagmap_maprow(
        value = new /aws1/cl_odbrequesttagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_availabilityzone = |string|
  iv_availabilityzoneid = |string|
  iv_backupsubnetcidr = |string|
  iv_clientsubnetcidr = |string|
  iv_clienttoken = |string|
  iv_customdomainname = |string|
  iv_defaultdnsprefix = |string|
  iv_displayname = |string|
  iv_kmsaccess = |string|
  iv_kmspolicydocument = |string|
  iv_s3access = |string|
  iv_s3policydocument = |string|
  iv_stsaccess = |string|
  iv_stspolicydocument = |string|
  iv_zeroetlaccess = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_displayname( ).
  lv_resourcestatus = lo_result->get_status( ).
  lv_string = lo_result->get_statusreason( ).
  lv_string = lo_result->get_odbnetworkid( ).
ENDIF.