kx_volumes

Creates, updates, deletes, gets or lists a kx_volumes resource.

Overview

Name	kx_volumes
Type	Resource
Id	aws.finspace.kx_volumes

Fields

The following fields are returned by SELECT queries:

get_kx_volume

Name	Datatype	Description
attached_clusters	array	A list of cluster identifiers that a volume is attached to.
availability_zone_ids	array	The identifier of the availability zones.
az_mode	string	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. (SINGLE, MULTI)
created_timestamp	string (date-time)	The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
description	string	A description of the volume. (pattern: <code>^[a-zA-Z0-9. ]{1,1000}$</code>)
environment_id	string	A unique identifier for the kdb environment, whose clusters can attach to the volume. (pattern: <code>^[a-z0-9]+$</code>)
last_modified_timestamp	string (date-time)	The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
nas_1_configuration	object	The structure containing the size and type of the network attached storage (NAS_1) file system volume.
status	string	The status of volume creation. CREATING – The volume creation is in progress. CREATE_FAILED – The volume creation has failed. ACTIVE – The volume is active. UPDATING – The volume is in the process of being updated. UPDATE_FAILED – The update action failed. UPDATED – The volume is successfully updated. DELETING – The volume is in the process of being deleted. DELETE_FAILED – The system failed to delete the volume. DELETED – The volume is successfully deleted. (CREATING, CREATE_FAILED, ACTIVE, UPDATING, UPDATED, UPDATE_FAILED, DELETING, DELETED, DELETE_FAILED)
status_reason	string	The error message when a failed state occurs. (pattern: <code>^[a-zA-Z0-9_-.\s]+$</code>)
volume_arn	string	The ARN identifier of the volume. (pattern: <code>^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}(/kxSharedVolume/[a-zA-Z0-9_-]{1,255})?$</code>)
volume_name	string	A unique identifier for the volume. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$</code>)
volume_type	string	The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. (NAS_1)

list_kx_volumes

Name	Datatype	Description
kx_volume_summaries	array	A summary of volumes.
next_token	string	A token that indicates where a results page should begin. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kx_volume	select	environment_id, volume_name, region		Retrieves the information about the volume.
list_kx_volumes	select	environment_id, region	maxResults, nextToken, volumeType	Lists all the volumes in a kdb environment.
create_kx_volume	insert	environment_id, region, volumeType, volumeName, azMode, availabilityZoneIds		Creates a new volume with a specific amount of throughput and storage capacity.
update_kx_volume	update	environment_id, volume_name, region		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.
delete_kx_volume	delete	environment_id, volume_name, region	clientToken	Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment_id	string	A unique identifier for the kdb environment, whose clusters can attach to the volume.
region	string	AWS region (default: us-east-1)
volume_name	string	The name of the volume that you want to delete.
clientToken	string	A token that ensures idempotency. This token expires in 10 minutes.
maxResults	integer	The maximum number of results to return in this request.
nextToken	string	A token that indicates where a results page should begin.
volumeType	string	The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

SELECT examples

get_kx_volume

Retrieves the information about the volume.

SELECT
attached_clusters,
availability_zone_ids,
az_mode,
created_timestamp,
description,
environment_id,
last_modified_timestamp,
nas_1_configuration,
status,
status_reason,
volume_arn,
volume_name,
volume_type
FROM aws.finspace.kx_volumes
WHERE environment_id = '{{ environment_id }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND region = '{{ region }}' -- required
;

list_kx_volumes

Lists all the volumes in a kdb environment.

SELECT
kx_volume_summaries,
next_token
FROM aws.finspace.kx_volumes
WHERE environment_id = '{{ environment_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND volumeType = '{{ volumeType }}'
;

INSERT examples

create_kx_volume

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

INSERT INTO aws.finspace.kx_volumes (
clientToken,
volumeType,
volumeName,
description,
nas1Configuration,
azMode,
availabilityZoneIds,
tags,
environment_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ volumeType }}' /* required */,
'{{ volumeName }}' /* required */,
'{{ description }}',
'{{ nas1Configuration }}',
'{{ azMode }}' /* required */,
'{{ availabilityZoneIds }}' /* required */,
'{{ tags }}',
'{{ environment_id }}',
'{{ region }}'
RETURNING
availability_zone_ids,
az_mode,
created_timestamp,
description,
environment_id,
nas_1_configuration,
status,
status_reason,
volume_arn,
volume_name,
volume_type
;

Manifest

# Description fields are for documentation purposes
- name: kx_volumes
props:
  - name: environment_id
    value: "{{ environment_id }}"
    description: Required parameter for the kx_volumes resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the kx_volumes resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: volumeType
    value: "{{ volumeType }}"
    valid_values: ['NAS_1']
  - name: volumeName
    value: "{{ volumeName }}"
  - name: description
    value: "{{ description }}"
  - name: nas1Configuration
    description: |
      The structure containing the size and type of the network attached storage (NAS_1) file system volume.
    value:
      type_: "{{ type_ }}"
      size: {{ size }}
  - name: azMode
    value: "{{ azMode }}"
    valid_values: ['SINGLE', 'MULTI']
  - name: availabilityZoneIds
    value:
      - "{{ availabilityZoneIds }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_kx_volume

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.

UPDATE aws.finspace.kx_volumes
SET 
description = '{{ description }}',
clientToken = '{{ clientToken }}',
nas1Configuration = '{{ nas1Configuration }}'
WHERE 
environment_id = '{{ environment_id }}' --required
AND volume_name = '{{ volume_name }}' --required
AND region = '{{ region }}' --required
RETURNING
attached_clusters,
availability_zone_ids,
az_mode,
created_timestamp,
description,
environment_id,
last_modified_timestamp,
nas_1_configuration,
status,
status_reason,
volume_arn,
volume_name,
volume_type;

DELETE examples

delete_kx_volume

Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.

DELETE FROM aws.finspace.kx_volumes
WHERE environment_id = '{{ environment_id }}' --required
AND volume_name = '{{ volume_name }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;