create_kx_volume
¶
create_kx_volume(
environment_id: KxEnvironmentId,
volume_type: KxVolumeType,
volume_name: KxVolumeName,
az_mode: KxAzMode,
availability_zone_ids: AvailabilityZoneIds,
*,
config_overrides: Optional[finspaceClientConfig] = None,
client_token: Optional[ClientToken] = None,
description: Optional[Description] = None,
nas1_configuration: Optional[KxNAS1Configuration] = None,
tags: Optional[TagMap] = None,
) -> CreateKxVolumeResponse
Creates a new volume with a specific amount of throughput and storage capacity.
Parameters:
-
client_token(Optional[ClientToken], default:None) –A token that ensures idempotency. This token expires in 10 minutes.
-
environment_id(KxEnvironmentId) –A unique identifier for the kdb environment, whose clusters can attach to the volume.
-
volume_type(KxVolumeType) –The type of file system volume. Currently, FinSpace only supports
NAS_1volume type. When you selectNAS_1volume type, you must also providenas1Configuration. -
volume_name(KxVolumeName) –A unique identifier for the volume.
-
description(Optional[Description], default:None) –A description of the volume.
-
nas1_configuration(Optional[KxNAS1Configuration], default:None) –Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose
volumeTypeas NAS_1. -
az_mode(KxAzMode) –The number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLEfor volumes. This places dataview in a single AZ. -
availability_zone_ids(AvailabilityZoneIds) –The identifier of the availability zones.
-
tags(Optional[TagMap], default:None) –A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
ConflictException–There was a conflict with this action, and it could not be completed.
-
InternalServerException–The request processing has failed because of an unknown error, exception or failure.
-
LimitExceededException–A service limit or quota is exceeded.
-
ResourceAlreadyExistsException–The specified resource group already exists.
-
ResourceNotFoundException–One or more resources can't be found.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an AWS service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_finspace/_services/finspace.py
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 | |