aws.finspace.KxVolume
Explore with Pulumi AI
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/v6/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("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 = "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.List;
import java.util.ArrayList;
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
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,
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.
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",
},
},
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"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.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())
.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",
}],
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",
}],
tags: {
string: "string",
},
});
type: aws:finspace:KxVolume
properties:
availabilityZones:
- string
azMode: string
description: string
environmentId: string
name: string
nas1Configurations:
- size: 0
type: 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
The KxVolume resource accepts the following input properties:
- Availability
Zones List<string> The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- Az
Mode string - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- Environment
Id string - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- Type string
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
. - Description string
- Description of the volume.
- Name string
- Unique name for the volumr that you want to create.
- Nas1Configurations
List<Kx
Volume Nas1Configuration> - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - Dictionary<string, string>
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- Availability
Zones []string The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- Az
Mode string - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- Environment
Id string - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- Type string
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
. - Description string
- Description of the volume.
- Name string
- Unique name for the volumr that you want to create.
- Nas1Configurations
[]Kx
Volume Nas1Configuration Args - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - map[string]string
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- availability
Zones List<String> The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- az
Mode String - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- environment
Id String - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- type String
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
. - description String
- Description of the volume.
- name String
- Unique name for the volumr that you want to create.
- nas1Configurations
List<Kx
Volume Nas1Configuration> - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - Map<String,String>
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- availability
Zones string[] The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- az
Mode string - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- environment
Id string - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- type string
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
. - description string
- Description of the volume.
- name string
- Unique name for the volumr that you want to create.
- nas1Configurations
Kx
Volume Nas1Configuration[] - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - {[key: string]: string}
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- availability_
zones Sequence[str] The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- az_
mode str - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- environment_
id str - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- type str
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
. - description str
- Description of the volume.
- name str
- Unique name for the volumr that you want to create.
- nas1_
configurations Sequence[KxVolume Nas1Configuration Args] - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - Mapping[str, str]
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- availability
Zones List<String> The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- az
Mode String - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- environment
Id String - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- type String
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
. - description String
- Description of the volume.
- name String
- Unique name for the volumr that you want to create.
- nas1Configurations List<Property Map>
- Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - Map<String>
- A list of 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.
- Attached
Clusters List<KxVolume Attached Cluster> - Created
Timestamp string - 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTimestamp - 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
- 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.
- Status
Reason string - The error message when a failed state occurs.
- Dictionary<string, string>
- Arn string
- Amazon Resource Name (ARN) identifier of the KX volume.
- Attached
Clusters []KxVolume Attached Cluster - Created
Timestamp string - 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTimestamp - 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
- 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.
- Status
Reason string - The error message when a failed state occurs.
- map[string]string
- arn String
- Amazon Resource Name (ARN) identifier of the KX volume.
- attached
Clusters List<KxVolume Attached Cluster> - created
Timestamp String - 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.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTimestamp - 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
- 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.
- status
Reason String - The error message when a failed state occurs.
- Map<String,String>
- arn string
- Amazon Resource Name (ARN) identifier of the KX volume.
- attached
Clusters KxVolume Attached Cluster[] - created
Timestamp string - 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.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringTimestamp - 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
- 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.
- status
Reason string - The error message when a failed state occurs.
- {[key: string]: string}
- arn str
- Amazon Resource Name (ARN) identifier of the KX volume.
- attached_
clusters Sequence[KxVolume Attached Cluster] - created_
timestamp str - 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.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strtimestamp - 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
- 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.
- status_
reason str - The error message when a failed state occurs.
- Mapping[str, str]
- arn String
- Amazon Resource Name (ARN) identifier of the KX volume.
- attached
Clusters List<Property Map> - created
Timestamp String - 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.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTimestamp - 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
- 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.
- status
Reason String - The error message when a failed state occurs.
- 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,
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)
Resource lookup is not supported in YAML
- 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.
- Arn string
- Amazon Resource Name (ARN) identifier of the KX volume.
- Attached
Clusters List<KxVolume Attached Cluster> - Availability
Zones List<string> The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- Az
Mode string - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- Created
Timestamp string - 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
- Description of the volume.
- Environment
Id string - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- Last
Modified stringTimestamp - 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 volumr that you want to create.
- Nas1Configurations
List<Kx
Volume Nas1Configuration> - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - 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.
- Status
Reason string - The error message when a failed state occurs.
- Dictionary<string, string>
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- Dictionary<string, string>
- Type string
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
.
- Arn string
- Amazon Resource Name (ARN) identifier of the KX volume.
- Attached
Clusters []KxVolume Attached Cluster Args - Availability
Zones []string The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- Az
Mode string - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- Created
Timestamp string - 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
- Description of the volume.
- Environment
Id string - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- Last
Modified stringTimestamp - 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 volumr that you want to create.
- Nas1Configurations
[]Kx
Volume Nas1Configuration Args - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - 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.
- Status
Reason string - The error message when a failed state occurs.
- map[string]string
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- map[string]string
- Type string
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
.
- arn String
- Amazon Resource Name (ARN) identifier of the KX volume.
- attached
Clusters List<KxVolume Attached Cluster> - availability
Zones List<String> The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- az
Mode String - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- created
Timestamp String - 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
- Description of the volume.
- environment
Id String - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- last
Modified StringTimestamp - 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 volumr that you want to create.
- nas1Configurations
List<Kx
Volume Nas1Configuration> - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - 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.
- status
Reason String - The error message when a failed state occurs.
- Map<String,String>
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- Map<String,String>
- type String
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
.
- arn string
- Amazon Resource Name (ARN) identifier of the KX volume.
- attached
Clusters KxVolume Attached Cluster[] - availability
Zones string[] The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- az
Mode string - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- created
Timestamp string - 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
- Description of the volume.
- environment
Id string - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- last
Modified stringTimestamp - 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 volumr that you want to create.
- nas1Configurations
Kx
Volume Nas1Configuration[] - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - 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.
- status
Reason string - The error message when a failed state occurs.
- {[key: string]: string}
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- {[key: string]: string}
- type string
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
.
- arn str
- Amazon Resource Name (ARN) identifier of the KX volume.
- attached_
clusters Sequence[KxVolume Attached Cluster Args] - availability_
zones Sequence[str] The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- az_
mode str - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- created_
timestamp str - 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 str
- Description of the volume.
- environment_
id str - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- last_
modified_ strtimestamp - 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 volumr that you want to create.
- nas1_
configurations Sequence[KxVolume Nas1Configuration Args] - Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - status str
- 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.
- status_
reason str - The error message when a failed state occurs.
- Mapping[str, str]
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- Mapping[str, str]
- type str
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
.
- arn String
- Amazon Resource Name (ARN) identifier of the KX volume.
- attached
Clusters List<Property Map> - availability
Zones List<String> The identifier of the AWS Availability Zone IDs.
The following arguments are optional:
- az
Mode String - The number of availability zones you want to assign per volume. Currently, Finspace only support SINGLE for volumes.
SINGLE
- Assigns one availability zone per volume.
- created
Timestamp String - 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
- Description of the volume.
- environment
Id String - A unique identifier for the kdb environment, whose clusters can attach to the volume.
- last
Modified StringTimestamp - 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 volumr that you want to create.
- nas1Configurations List<Property Map>
- Specifies the configuration for the Network attached storage (
NAS_1
) file system volume. This parameter is required whenvolume_type
isNAS_1
. Seenas1_configuration
Argument Reference below. - 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.
- status
Reason String - The error message when a failed state occurs.
- Map<String>
- A list of key-value pairs to label the volume. You can add up to 50 tags to a volume
- Map<String>
- type String
- The type of file system volume. Currently, FinSpace only supports the
NAS_1
volume type. When you select theNAS_1
volume type, you must also providenas1_configuration
.
Supporting Types
KxVolumeAttachedCluster, KxVolumeAttachedClusterArgs
- Cluster
Name string - Cluster
Status string - Cluster
Type string
- Cluster
Name string - Cluster
Status string - Cluster
Type string
- cluster
Name String - cluster
Status String - cluster
Type String
- cluster
Name string - cluster
Status string - cluster
Type string
- cluster_
name str - cluster_
status str - cluster_
type str
- cluster
Name String - cluster
Status String - cluster
Type String
KxVolumeNas1Configuration, KxVolumeNas1ConfigurationArgs
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.