Skip to content

CreateKxVolumeRequest

Source code in docs_src/capo_finspace/types/create_kx_volume_request.py
class CreateKxVolumeRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_finspace.types.client_token.ClientToken"]
    """<p>A token that ensures idempotency. This token expires in 10 minutes.</p>"""
    environment_id: "capo_finspace.types.kx_environment_id.KxEnvironmentId"
    """<p>A unique identifier for the kdb environment, whose clusters can attach to the volume. </p>"""
    volume_type: "capo_finspace.types.kx_volume_type.KxVolumeType"
    """<p> The type of file system volume. Currently, FinSpace only supports <code>NAS_1</code> volume type. When you select <code>NAS_1</code> volume type, you must also provide <code>nas1Configuration</code>. </p>"""
    volume_name: "capo_finspace.types.kx_volume_name.KxVolumeName"
    """<p>A unique identifier for the volume.</p>"""
    description: NotRequired["capo_finspace.types.description.Description"]
    """<p> A description of the volume. </p>"""
    nas1_configuration: NotRequired[
        "capo_finspace.types.kx_nas1_configuration.KxNAS1Configuration"
    ]
    """<p> Specifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose <code>volumeType</code> as <i>NAS_1</i>.</p>"""
    az_mode: "capo_finspace.types.kx_az_mode.KxAzMode"
    """<p>The number of availability zones you want to assign per volume. Currently, FinSpace only supports <code>SINGLE</code> for volumes. This places dataview in a single AZ.</p>"""
    availability_zone_ids: (
        "capo_finspace.types.availability_zone_ids.AvailabilityZoneIds"
    )
    """<p>The identifier of the availability zones.</p>"""
    tags: NotRequired["capo_finspace.types.tag_map.TagMap"]
    """<p> A list of key-value pairs to label the volume. You can add up to 50 tags to a volume. </p>"""

availability_zone_ids instance-attribute

availability_zone_ids: AvailabilityZoneIds

The identifier of the availability zones.

az_mode instance-attribute

az_mode: KxAzMode

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.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

description instance-attribute

description: NotRequired[Description]

A description of the volume.

environment_id instance-attribute

environment_id: KxEnvironmentId

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

nas1_configuration instance-attribute

nas1_configuration: NotRequired[KxNAS1Configuration]

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

tags instance-attribute

tags: NotRequired[TagMap]

A list of key-value pairs to label the volume. You can add up to 50 tags to a volume.

volume_name instance-attribute

volume_name: KxVolumeName

A unique identifier for the volume.

volume_type instance-attribute

volume_type: KxVolumeType

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.