Skip to content

/AWS1/IF_FNS=>CREATEKXVOLUME()

About CreateKxVolume

Creates a new volume with a specific amount of throughput and storage capacity.

Method Signature

METHODS /AWS1/IF_FNS~CREATEKXVOLUME
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/FNSCLIENTTOKEN OPTIONAL
    !IV_ENVIRONMENTID TYPE /AWS1/FNSKXENVIRONMENTID OPTIONAL
    !IV_VOLUMETYPE TYPE /AWS1/FNSKXVOLUMETYPE OPTIONAL
    !IV_VOLUMENAME TYPE /AWS1/FNSKXVOLUMENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/FNSDESCRIPTION OPTIONAL
    !IO_NAS1CONFIGURATION TYPE REF TO /AWS1/CL_FNSKXNAS1CONF OPTIONAL
    !IV_AZMODE TYPE /AWS1/FNSKXAZMODE OPTIONAL
    !IT_AVAILABILITYZONEIDS TYPE /AWS1/CL_FNSAZIDS_W=>TT_AVAILABILITYZONEIDS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_FNSTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fnscreatekxvolumersp
  RAISING
    /AWS1/CX_FNSACCESSDENIEDEX
    /AWS1/CX_FNSCONFLICTEXCEPTION
    /AWS1/CX_FNSINTERNALSERVEREX
    /AWS1/CX_FNSLIMITEXCEEDEDEX
    /AWS1/CX_FNSRESRCALRDYEXISTSEX
    /AWS1/CX_FNSRESOURCENOTFOUNDEX
    /AWS1/CX_FNSTHROTTLINGEX
    /AWS1/CX_FNSVALIDATIONEX
    /AWS1/CX_FNSCLIENTEXC
    /AWS1/CX_FNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_environmentid TYPE /AWS1/FNSKXENVIRONMENTID /AWS1/FNSKXENVIRONMENTID

A unique identifier for the kdb environment, whose clusters can attach to the volume.

iv_volumetype TYPE /AWS1/FNSKXVOLUMETYPE /AWS1/FNSKXVOLUMETYPE

The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.

iv_volumename TYPE /AWS1/FNSKXVOLUMENAME /AWS1/FNSKXVOLUMENAME

A unique identifier for the volume.

iv_azmode TYPE /AWS1/FNSKXAZMODE /AWS1/FNSKXAZMODE

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

it_availabilityzoneids TYPE /AWS1/CL_FNSAZIDS_W=>TT_AVAILABILITYZONEIDS TT_AVAILABILITYZONEIDS

The identifier of the availability zones.

Optional arguments:

iv_clienttoken TYPE /AWS1/FNSCLIENTTOKEN /AWS1/FNSCLIENTTOKEN

A token that ensures idempotency. This token expires in 10 minutes.

iv_description TYPE /AWS1/FNSDESCRIPTION /AWS1/FNSDESCRIPTION

A description of the volume.

io_nas1configuration TYPE REF TO /AWS1/CL_FNSKXNAS1CONF /AWS1/CL_FNSKXNAS1CONF

Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose volumeType as NAS_1.

it_tags TYPE /AWS1/CL_FNSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.

RETURNING

oo_output TYPE REF TO /aws1/cl_fnscreatekxvolumersp /AWS1/CL_FNSCREATEKXVOLUMERSP

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->createkxvolume(
  io_nas1configuration = new /aws1/cl_fnskxnas1conf(
    iv_size = 123
    iv_type = |string|
  )
  it_availabilityzoneids = VALUE /aws1/cl_fnsazids_w=>tt_availabilityzoneids(
    ( new /aws1/cl_fnsazids_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_fnstagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_fnstagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_fnstagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_azmode = |string|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_environmentid = |string|
  iv_volumename = |string|
  iv_volumetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_kxenvironmentid = lo_result->get_environmentid( ).
  lv_kxvolumename = lo_result->get_volumename( ).
  lv_kxvolumetype = lo_result->get_volumetype( ).
  lv_kxvolumearn = lo_result->get_volumearn( ).
  lo_kxnas1configuration = lo_result->get_nas1configuration( ).
  IF lo_kxnas1configuration IS NOT INITIAL.
    lv_kxnas1type = lo_kxnas1configuration->get_type( ).
    lv_kxnas1size = lo_kxnas1configuration->get_size( ).
  ENDIF.
  lv_kxvolumestatus = lo_result->get_status( ).
  lv_kxvolumestatusreason = lo_result->get_statusreason( ).
  lv_kxazmode = lo_result->get_azmode( ).
  lv_description = lo_result->get_description( ).
  LOOP AT lo_result->get_availabilityzoneids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_availabilityzoneid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_timestamp = lo_result->get_createdtimestamp( ).
ENDIF.