Attach Cluster Node Volume

sagemaker_attach_cluster_node_volume

R Documentation

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

Description¶

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.

Usage¶

sagemaker_attach_cluster_node_volume(ClusterArn, NodeId, VolumeId)

Arguments¶

ClusterArn

[required] 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.

NodeId

[required] 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).

VolumeId

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

Value¶

A list with the following syntax:

list(
  ClusterArn = "string",
  NodeId = "string",
  VolumeId = "string",
  AttachTime = as.POSIXct(
    "2015-01-01"
  ),
  Status = "attaching"|"attached"|"detaching"|"detached"|"busy",
  DeviceName = "string"
)

Request syntax¶

svc$attach_cluster_node_volume(
  ClusterArn = "string",
  NodeId = "string",
  VolumeId = "string"
)