Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. finspace
  6. KxVolume
Viewing docs for AWS v7.43.0
published on Thursday, Aug 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.finspace.KxVolume

aws logo aws logo
Viewing docs for AWS v7.43.0
published on Thursday, Aug 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Resource for managing an AWS FinSpace Kx Volume.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.finspace.KxVolume("example", {
    name: "my-tf-kx-volume",
    environmentId: exampleAwsFinspaceKxEnvironment.id,
    availabilityZones: ["use1-az2"],
    azMode: "SINGLE",
    type: "NAS_1",
    nas1Configurations: [{
        size: 1200,
        type: "SSD_250",
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.finspace.KxVolume("example",
    name="my-tf-kx-volume",
    environment_id=example_aws_finspace_kx_environment["id"],
    availability_zones=["use1-az2"],
    az_mode="SINGLE",
    type="NAS_1",
    nas1_configurations=[{
        "size": 1200,
        "type": "SSD_250",
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/finspace"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := finspace.NewKxVolume(ctx, "example", &finspace.KxVolumeArgs{
			Name:          pulumi.String("my-tf-kx-volume"),
			EnvironmentId: pulumi.Any(exampleAwsFinspaceKxEnvironment.Id),
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("use1-az2"),
			},
			AzMode: pulumi.String("SINGLE"),
			Type:   pulumi.String("NAS_1"),
			Nas1Configurations: finspace.KxVolumeNas1ConfigurationArray{
				&finspace.KxVolumeNas1ConfigurationArgs{
					Size: pulumi.Int(1200),
					Type: pulumi.String("SSD_250"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.FinSpace.KxVolume("example", new()
    {
        Name = "my-tf-kx-volume",
        EnvironmentId = exampleAwsFinspaceKxEnvironment.Id,
        AvailabilityZones = new[]
        {
            "use1-az2",
        },
        AzMode = "SINGLE",
        Type = "NAS_1",
        Nas1Configurations = new[]
        {
            new Aws.FinSpace.Inputs.KxVolumeNas1ConfigurationArgs
            {
                Size = 1200,
                Type = "SSD_250",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.finspace.KxVolume;
import com.pulumi.aws.finspace.KxVolumeArgs;
import com.pulumi.aws.finspace.inputs.KxVolumeNas1ConfigurationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new KxVolume("example", KxVolumeArgs.builder()
            .name("my-tf-kx-volume")
            .environmentId(exampleAwsFinspaceKxEnvironment.id())
            .availabilityZones("use1-az2")
            .azMode("SINGLE")
            .type("NAS_1")
            .nas1Configurations(KxVolumeNas1ConfigurationArgs.builder()
                .size(1200)
                .type("SSD_250")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:finspace:KxVolume
    properties:
      name: my-tf-kx-volume
      environmentId: ${exampleAwsFinspaceKxEnvironment.id}
      availabilityZones:
        - use1-az2
      azMode: SINGLE
      type: NAS_1
      nas1Configurations:
        - size: 1200
          type: SSD_250

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_finspace_kxvolume" "example" {
  name               = "my-tf-kx-volume"
  environment_id     = exampleAwsFinspaceKxEnvironment.id
  availability_zones = ["use1-az2"]
  az_mode            = "SINGLE"
  type               = "NAS_1"
  nas1_configurations {
    size = 1200
    type = "SSD_250"
  }
}

    Create KxVolume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KxVolume(name: string, args: KxVolumeArgs, opts?: CustomResourceOptions);
    @overload
def KxVolume(resource_name: str,
             args: KxVolumeArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def KxVolume(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             availability_zones: Optional[Sequence[str]] = None,
             az_mode: Optional[str] = None,
             environment_id: Optional[str] = None,
             type: Optional[str] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             nas1_configurations: Optional[Sequence[KxVolumeNas1ConfigurationArgs]] = None,
             region: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewKxVolume(ctx *Context, name string, args KxVolumeArgs, opts ...ResourceOption) (*KxVolume, error)
    public KxVolume(string name, KxVolumeArgs args, CustomResourceOptions? opts = null)
    public KxVolume(String name, KxVolumeArgs args)
public KxVolume(String name, KxVolumeArgs args, CustomResourceOptions options)

    type: aws:finspace:KxVolume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_finspace_kx_volume" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args KxVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args KxVolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args KxVolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KxVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KxVolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var kxVolumeResource = new Aws.FinSpace.KxVolume("kxVolumeResource", new()
{
    AvailabilityZones = new[]
    {
        "string",
    },
    AzMode = "string",
    EnvironmentId = "string",
    Type = "string",
    Description = "string",
    Name = "string",
    Nas1Configurations = new[]
    {
        new Aws.FinSpace.Inputs.KxVolumeNas1ConfigurationArgs
        {
            Size = 0,
            Type = "string",
        },
    },
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := finspace.NewKxVolume(ctx, "kxVolumeResource", &finspace.KxVolumeArgs{
	AvailabilityZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	AzMode:        pulumi.String("string"),
	EnvironmentId: pulumi.String("string"),
	Type:          pulumi.String("string"),
	Description:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	Nas1Configurations: finspace.KxVolumeNas1ConfigurationArray{
		&finspace.KxVolumeNas1ConfigurationArgs{
			Size: pulumi.Int(0),
			Type: pulumi.String("string"),
		},
	},
	Region: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    resource "aws_finspace_kx_volume" "kxVolumeResource" {
  lifecycle {
    create_before_destroy = true
  }
  availability_zones = ["string"]
  az_mode            = "string"
  environment_id     = "string"
  type               = "string"
  description        = "string"
  name               = "string"
  nas1_configurations {
    size = 0
    type = "string"
  }
  region = "string"
  tags = {
    "string" = "string"
  }
}

    var kxVolumeResource = new KxVolume("kxVolumeResource", KxVolumeArgs.builder()
    .availabilityZones("string")
    .azMode("string")
    .environmentId("string")
    .type("string")
    .description("string")
    .name("string")
    .nas1Configurations(KxVolumeNas1ConfigurationArgs.builder()
        .size(0)
        .type("string")
        .build())
    .region("string")
    .tags(Map.of("string", "string"))
    .build());

    kx_volume_resource = aws.finspace.KxVolume("kxVolumeResource",
    availability_zones=["string"],
    az_mode="string",
    environment_id="string",
    type="string",
    description="string",
    name="string",
    nas1_configurations=[{
        "size": 0,
        "type": "string",
    }],
    region="string",
    tags={
        "string": "string",
    })

    const kxVolumeResource = new aws.finspace.KxVolume("kxVolumeResource", {
    availabilityZones: ["string"],
    azMode: "string",
    environmentId: "string",
    type: "string",
    description: "string",
    name: "string",
    nas1Configurations: [{
        size: 0,
        type: "string",
    }],
    region: "string",
    tags: {
        string: "string",
    },
});

    type: aws:finspace:KxVolume
properties:
    availabilityZones:
        - string
    azMode: string
    description: string
    environmentId: string
    name: string
    nas1Configurations:
        - size: 0
          type: string
    region: string
    tags:
        string: string
    type: string

    KxVolume Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The KxVolume resource accepts the following input properties:

    AvailabilityZones List<string>
    Identifier of the AWS Availability Zone IDs.
    AzMode string
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    EnvironmentId string
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    Type string

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    Description string
    Description of the volume.
    Name string
    Unique name for the volume that you want to create.
    Nas1Configurations List<KxVolumeNas1Configuration>
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    AvailabilityZones []string
    Identifier of the AWS Availability Zone IDs.
    AzMode string
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    EnvironmentId string
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    Type string

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    Description string
    Description of the volume.
    Name string
    Unique name for the volume that you want to create.
    Nas1Configurations []KxVolumeNas1ConfigurationArgs
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    availability_zones list(string)
    Identifier of the AWS Availability Zone IDs.
    az_mode string
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    environment_id string
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    type string

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    description string
    Description of the volume.
    name string
    Unique name for the volume that you want to create.
    nas1_configurations list(object)
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    availabilityZones List<String>
    Identifier of the AWS Availability Zone IDs.
    azMode String
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    environmentId String
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    type String

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    description String
    Description of the volume.
    name String
    Unique name for the volume that you want to create.
    nas1Configurations List<KxVolumeNas1Configuration>
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    availabilityZones string[]
    Identifier of the AWS Availability Zone IDs.
    azMode string
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    environmentId string
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    type string

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    description string
    Description of the volume.
    name string
    Unique name for the volume that you want to create.
    nas1Configurations KxVolumeNas1Configuration[]
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    availability_zones Sequence[str]
    Identifier of the AWS Availability Zone IDs.
    az_mode str
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    environment_id str
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    type str

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    description str
    Description of the volume.
    name str
    Unique name for the volume that you want to create.
    nas1_configurations Sequence[KxVolumeNas1ConfigurationArgs]
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    availabilityZones List<String>
    Identifier of the AWS Availability Zone IDs.
    azMode String
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    environmentId String
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    type String

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    description String
    Description of the volume.
    name String
    Unique name for the volume that you want to create.
    nas1Configurations List<Property Map>
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the KxVolume resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) identifier of the KX volume.
    AttachedClusters List<KxVolumeAttachedCluster>
    Clusters attached to the volume. See attachedClusters Block below.
    CreatedTimestamp string
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTimestamp string
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    Status string
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    StatusReason string
    Error message when a failed state occurs.
    TagsAll Dictionary<string, string>
    Arn string
    Amazon Resource Name (ARN) identifier of the KX volume.
    AttachedClusters []KxVolumeAttachedCluster
    Clusters attached to the volume. See attachedClusters Block below.
    CreatedTimestamp string
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTimestamp string
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    Status string
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    StatusReason string
    Error message when a failed state occurs.
    TagsAll map[string]string
    arn string
    Amazon Resource Name (ARN) identifier of the KX volume.
    attached_clusters list(object)
    Clusters attached to the volume. See attachedClusters Block below.
    created_timestamp string
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    last_modified_timestamp string
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    status string
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    status_reason string
    Error message when a failed state occurs.
    tags_all map(string)
    arn String
    Amazon Resource Name (ARN) identifier of the KX volume.
    attachedClusters List<KxVolumeAttachedCluster>
    Clusters attached to the volume. See attachedClusters Block below.
    createdTimestamp String
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp String
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    status String
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    statusReason String
    Error message when a failed state occurs.
    tagsAll Map<String,String>
    arn string
    Amazon Resource Name (ARN) identifier of the KX volume.
    attachedClusters KxVolumeAttachedCluster[]
    Clusters attached to the volume. See attachedClusters Block below.
    createdTimestamp string
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp string
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    status string
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    statusReason string
    Error message when a failed state occurs.
    tagsAll {[key: string]: string}
    arn str
    Amazon Resource Name (ARN) identifier of the KX volume.
    attached_clusters Sequence[KxVolumeAttachedCluster]
    Clusters attached to the volume. See attachedClusters Block below.
    created_timestamp str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_timestamp str
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    status str
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    status_reason str
    Error message when a failed state occurs.
    tags_all Mapping[str, str]
    arn String
    Amazon Resource Name (ARN) identifier of the KX volume.
    attachedClusters List<Property Map>
    Clusters attached to the volume. See attachedClusters Block below.
    createdTimestamp String
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTimestamp String
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    status String
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    statusReason String
    Error message when a failed state occurs.
    tagsAll Map<String>

    Look up Existing KxVolume Resource

    Get an existing KxVolume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: KxVolumeState, opts?: CustomResourceOptions): KxVolume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        attached_clusters: Optional[Sequence[KxVolumeAttachedClusterArgs]] = None,
        availability_zones: Optional[Sequence[str]] = None,
        az_mode: Optional[str] = None,
        created_timestamp: Optional[str] = None,
        description: Optional[str] = None,
        environment_id: Optional[str] = None,
        last_modified_timestamp: Optional[str] = None,
        name: Optional[str] = None,
        nas1_configurations: Optional[Sequence[KxVolumeNas1ConfigurationArgs]] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        status_reason: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None) -> KxVolume
    func GetKxVolume(ctx *Context, name string, id IDInput, state *KxVolumeState, opts ...ResourceOption) (*KxVolume, error)
    public static KxVolume Get(string name, Input<string> id, KxVolumeState? state, CustomResourceOptions? opts = null)
    public static KxVolume get(String name, Output<String> id, KxVolumeState state, CustomResourceOptions options)
    resources:  _:    type: aws:finspace:KxVolume    get:      id: ${id}
    import {
  to = aws_finspace_kx_volume.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) identifier of the KX volume.
    AttachedClusters List<KxVolumeAttachedCluster>
    Clusters attached to the volume. See attachedClusters Block below.
    AvailabilityZones List<string>
    Identifier of the AWS Availability Zone IDs.
    AzMode string
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    CreatedTimestamp string
    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
    Description of the volume.
    EnvironmentId string
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    LastModifiedTimestamp string
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    Name string
    Unique name for the volume that you want to create.
    Nas1Configurations List<KxVolumeNas1Configuration>
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Status string
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    StatusReason string
    Error message when a failed state occurs.
    Tags Dictionary<string, string>
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    TagsAll Dictionary<string, string>
    Type string

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    Arn string
    Amazon Resource Name (ARN) identifier of the KX volume.
    AttachedClusters []KxVolumeAttachedClusterArgs
    Clusters attached to the volume. See attachedClusters Block below.
    AvailabilityZones []string
    Identifier of the AWS Availability Zone IDs.
    AzMode string
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    CreatedTimestamp string
    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
    Description of the volume.
    EnvironmentId string
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    LastModifiedTimestamp string
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    Name string
    Unique name for the volume that you want to create.
    Nas1Configurations []KxVolumeNas1ConfigurationArgs
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Status string
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    StatusReason string
    Error message when a failed state occurs.
    Tags map[string]string
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    TagsAll map[string]string
    Type string

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    arn string
    Amazon Resource Name (ARN) identifier of the KX volume.
    attached_clusters list(object)
    Clusters attached to the volume. See attachedClusters Block below.
    availability_zones list(string)
    Identifier of the AWS Availability Zone IDs.
    az_mode string
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    created_timestamp string
    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
    Description of the volume.
    environment_id string
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    last_modified_timestamp string
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    name string
    Unique name for the volume that you want to create.
    nas1_configurations list(object)
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status string
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    status_reason string
    Error message when a failed state occurs.
    tags map(string)
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    tags_all map(string)
    type string

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    arn String
    Amazon Resource Name (ARN) identifier of the KX volume.
    attachedClusters List<KxVolumeAttachedCluster>
    Clusters attached to the volume. See attachedClusters Block below.
    availabilityZones List<String>
    Identifier of the AWS Availability Zone IDs.
    azMode String
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    createdTimestamp String
    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
    Description of the volume.
    environmentId String
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    lastModifiedTimestamp String
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    name String
    Unique name for the volume that you want to create.
    nas1Configurations List<KxVolumeNas1Configuration>
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status String
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    statusReason String
    Error message when a failed state occurs.
    tags Map<String,String>
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    tagsAll Map<String,String>
    type String

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    arn string
    Amazon Resource Name (ARN) identifier of the KX volume.
    attachedClusters KxVolumeAttachedCluster[]
    Clusters attached to the volume. See attachedClusters Block below.
    availabilityZones string[]
    Identifier of the AWS Availability Zone IDs.
    azMode string
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    createdTimestamp string
    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
    Description of the volume.
    environmentId string
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    lastModifiedTimestamp string
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    name string
    Unique name for the volume that you want to create.
    nas1Configurations KxVolumeNas1Configuration[]
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status string
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    statusReason string
    Error message when a failed state occurs.
    tags {[key: string]: string}
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    tagsAll {[key: string]: string}
    type string

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    arn str
    Amazon Resource Name (ARN) identifier of the KX volume.
    attached_clusters Sequence[KxVolumeAttachedClusterArgs]
    Clusters attached to the volume. See attachedClusters Block below.
    availability_zones Sequence[str]
    Identifier of the AWS Availability Zone IDs.
    az_mode str
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    created_timestamp str
    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 str
    Description of the volume.
    environment_id str
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    last_modified_timestamp str
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    name str
    Unique name for the volume that you want to create.
    nas1_configurations Sequence[KxVolumeNas1ConfigurationArgs]
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status str
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    status_reason str
    Error message when a failed state occurs.
    tags Mapping[str, str]
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    tags_all Mapping[str, str]
    type str

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    arn String
    Amazon Resource Name (ARN) identifier of the KX volume.
    attachedClusters List<Property Map>
    Clusters attached to the volume. See attachedClusters Block below.
    availabilityZones List<String>
    Identifier of the AWS Availability Zone IDs.
    azMode String
    Number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes, which assigns one availability zone per volume.
    createdTimestamp String
    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
    Description of the volume.
    environmentId String
    Unique identifier for the kdb environment, whose clusters can attach to the volume.
    lastModifiedTimestamp String
    Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000.
    name String
    Unique name for the volume that you want to create.
    nas1Configurations List<Property Map>
    Configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when volumeType is NAS_1. See nas1Configuration Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status String
    Status of volume creation. Values are CREATING (volume creation is in progress), CREATE_FAILED (volume creation has failed), ACTIVE (volume is active), UPDATING (volume is in the process of being updated), UPDATE_FAILED (update action failed), UPDATED (volume is successfully updated), DELETING (volume is in the process of being deleted), DELETE_FAILED (system failed to delete the volume), and DELETED (volume is successfully deleted).
    statusReason String
    Error message when a failed state occurs.
    tags Map<String>
    Key-value pairs to label the volume. You can add up to 50 tags to a volume.
    tagsAll Map<String>
    type String

    Type of file system volume. Currently, FinSpace only supports the NAS_1 volume type. When you select the NAS_1 volume type, you must also provide nas1Configuration.

    The following arguments are optional:

    Supporting Types

    KxVolumeAttachedCluster, KxVolumeAttachedClusterArgs

    ClusterName string
    Name of the KX cluster.
    ClusterStatus string
    Status of the KX cluster.
    ClusterType string
    Type of the KX cluster.
    ClusterName string
    Name of the KX cluster.
    ClusterStatus string
    Status of the KX cluster.
    ClusterType string
    Type of the KX cluster.
    cluster_name string
    Name of the KX cluster.
    cluster_status string
    Status of the KX cluster.
    cluster_type string
    Type of the KX cluster.
    clusterName String
    Name of the KX cluster.
    clusterStatus String
    Status of the KX cluster.
    clusterType String
    Type of the KX cluster.
    clusterName string
    Name of the KX cluster.
    clusterStatus string
    Status of the KX cluster.
    clusterType string
    Type of the KX cluster.
    cluster_name str
    Name of the KX cluster.
    cluster_status str
    Status of the KX cluster.
    cluster_type str
    Type of the KX cluster.
    clusterName String
    Name of the KX cluster.
    clusterStatus String
    Status of the KX cluster.
    clusterType String
    Type of the KX cluster.

    KxVolumeNas1Configuration, KxVolumeNas1ConfigurationArgs

    Size int
    Size of the network attached storage.
    Type string
    Type of the network attached storage.
    Size int
    Size of the network attached storage.
    Type string
    Type of the network attached storage.
    size number
    Size of the network attached storage.
    type string
    Type of the network attached storage.
    size Integer
    Size of the network attached storage.
    type String
    Type of the network attached storage.
    size number
    Size of the network attached storage.
    type string
    Type of the network attached storage.
    size int
    Size of the network attached storage.
    type str
    Type of the network attached storage.
    size Number
    Size of the network attached storage.
    type String
    Type of the network attached storage.

    Import

    Using pulumi import, import an AWS FinSpace Kx Volume using the id (environment ID and volume name, comma-delimited). For example:

    $ pulumi import aws:finspace/kxVolume:KxVolume example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-volume

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.43.0
    published on Thursday, Aug 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial