Skip to content

/AWS1/IF_SGM=>ATTACHCLUSTERNODEVOLUME()

About AttachClusterNodeVolume

Attaches your Amazon Elastic Block Store (Amazon EBS) volume to a node in your EKS orchestrated HyperPod cluster.

This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.

Method Signature

IMPORTING

Required arguments:

iv_clusterarn TYPE /AWS1/SGMCLUSTERARN /AWS1/SGMCLUSTERARN

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the InService state.

iv_nodeid TYPE /AWS1/SGMCLUSTERNODEID /AWS1/SGMCLUSTERNODEID

The unique identifier of the cluster node to which you want to attach the volume. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG).

iv_volumeid TYPE /AWS1/SGMVOLUMEID /AWS1/SGMVOLUMEID

The unique identifier of your EBS volume to attach. The volume must be in the available state.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmattachclstnodevo01 /AWS1/CL_SGMATTACHCLSTNODEVO01

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->/aws1/if_sgm~attachclusternodevolume(
  iv_clusterarn = |string|
  iv_nodeid = |string|
  iv_volumeid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_clusterarn = lo_result->get_clusterarn( ).
  lv_clusternodeid = lo_result->get_nodeid( ).
  lv_volumeid = lo_result->get_volumeid( ).
  lv_timestamp = lo_result->get_attachtime( ).
  lv_volumeattachmentstatus = lo_result->get_status( ).
  lv_volumedevicename = lo_result->get_devicename( ).
ENDIF.