Update Kx Volume

finspace_update_kx_volume

R Documentation

Updates the throughput or capacity of a volume¶

Description¶

Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.

Usage¶

finspace_update_kx_volume(environmentId, volumeName, description,
  clientToken, nas1Configuration)

Arguments¶

environmentId: [required] A unique identifier for the kdb environment where you created the storage volume.
volumeName: [required] A unique identifier for the volume.
description: A description of the volume.
clientToken: A token that ensures idempotency. This token expires in 10 minutes.
nas1Configuration: Specifies the configuration for the Network attached storage (NAS_1) file system volume.

Value¶

A list with the following syntax:

list(
  environmentId = "string",
  volumeName = "string",
  volumeType = "NAS_1",
  volumeArn = "string",
  nas1Configuration = list(
    type = "SSD_1000"|"SSD_250"|"HDD_12",
    size = 123
  ),
  status = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"UPDATING"|"UPDATED"|"UPDATE_FAILED"|"DELETING"|"DELETED"|"DELETE_FAILED",
  description = "string",
  statusReason = "string",
  createdTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  azMode = "SINGLE"|"MULTI",
  availabilityZoneIds = list(
    "string"
  ),
  lastModifiedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  attachedClusters = list(
    list(
      clusterName = "string",
      clusterType = "HDB"|"RDB"|"GATEWAY"|"GP"|"TICKERPLANT",
      clusterStatus = "PENDING"|"CREATING"|"CREATE_FAILED"|"RUNNING"|"UPDATING"|"DELETING"|"DELETED"|"DELETE_FAILED"
    )
  )
)

Request syntax¶

svc$update_kx_volume(
  environmentId = "string",
  volumeName = "string",
  description = "string",
  clientToken = "string",
  nas1Configuration = list(
    type = "SSD_1000"|"SSD_250"|"HDD_12",
    size = 123
  )
)