Skip to content

Create Kx Volume

finspace_create_kx_volume R Documentation

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

Description

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

Usage

finspace_create_kx_volume(clientToken, environmentId, volumeType,
  volumeName, description, nas1Configuration, azMode, availabilityZoneIds,
  tags)

Arguments

clientToken

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

environmentId

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

volumeType

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

volumeName

[required] A unique identifier for the volume.

description

A description of the volume.

nas1Configuration

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

azMode

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

availabilityZoneIds

[required] The identifier of the availability zones.

tags

A list of key-value pairs to label the volume. You can add up to 50 tags to a 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",
  statusReason = "string",
  azMode = "SINGLE"|"MULTI",
  description = "string",
  availabilityZoneIds = list(
    "string"
  ),
  createdTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_kx_volume(
  clientToken = "string",
  environmentId = "string",
  volumeType = "NAS_1",
  volumeName = "string",
  description = "string",
  nas1Configuration = list(
    type = "SSD_1000"|"SSD_250"|"HDD_12",
    size = 123
  ),
  azMode = "SINGLE"|"MULTI",
  availabilityZoneIds = list(
    "string"
  ),
  tags = list(
    "string"
  )
)