KxVolume class
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", {
nas1Configurations: [{
size: 1200,
type: "SSD_250",
}],
name: "my-tf-kx-volume",
environmentId: exampleAwsFinspaceKxEnvironment.id,
availabilityZones: ["use1-az2"],
azMode: "SINGLE",
type: "NAS_1",
});
import pulumi
import pulumi_aws as aws
example = aws.finspace.KxVolume("example",
nas1_configurations=[{
"size": 1200,
"type": "SSD_250",
}],
name="my-tf-kx-volume",
environment_id=example_aws_finspace_kx_environment["id"],
availability_zones=["use1-az2"],
az_mode="SINGLE",
type="NAS_1")
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()
{
Nas1Configurations = new[]
{
new Aws.FinSpace.Inputs.KxVolumeNas1ConfigurationArgs
{
Size = 1200,
Type = "SSD_250",
},
},
Name = "my-tf-kx-volume",
EnvironmentId = exampleAwsFinspaceKxEnvironment.Id,
AvailabilityZones = new[]
{
"use1-az2",
},
AzMode = "SINGLE",
Type = "NAS_1",
});
});
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{
Nas1Configurations: finspace.KxVolumeNas1ConfigurationArray{
&finspace.KxVolumeNas1ConfigurationArgs{
Size: pulumi.Int(1200),
Type: pulumi.String("SSD_250"),
},
},
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"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_finspace_kxvolume" "example" {
nas1_configurations {
size = 1200
type = "SSD_250"
}
name = "my-tf-kx-volume"
environment_id = exampleAwsFinspaceKxEnvironment.id
availability_zones = ["use1-az2"]
az_mode = "SINGLE"
type = "NAS_1"
}
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()
.nas1Configurations(KxVolumeNas1ConfigurationArgs.builder()
.size(1200)
.type("SSD_250")
.build())
.name("my-tf-kx-volume")
.environmentId(exampleAwsFinspaceKxEnvironment.id())
.availabilityZones("use1-az2")
.azMode("SINGLE")
.type("NAS_1")
.build());
}
}
resources:
example:
type: aws:finspace:KxVolume
properties:
nas1Configurations:
- size: 1200
type: SSD_250
name: my-tf-kx-volume
environmentId: ${exampleAwsFinspaceKxEnvironment.id}
availabilityZones:
- use1-az2
azMode: SINGLE
type: NAS_1
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
Constructors
- KxVolume(String name, {KxVolumeArgs? args, CustomResourceOptions? options})
-
Creates a new KxVolume.
nameThe Pulumi resource name.argsArguments used to configure this KxVolume. The set of arguments for KxVolume.optionsResource options controlling this resource's behavior. - KxVolume.reference(String urn)
- Creates a typed reference to an existing KxVolume resource.
Properties
-
arn
↔ Output<
String> -
ARN identifier of the KX volume.
latefinal
-
attachedClusters
↔ Output<
List< KxVolumeAttachedCluster> > -
Clusters attached to the volume. See
attachedClustersBlock below.latefinal -
availabilityZones
↔ Output<
List< String> > -
Identifier of the AWS Availability Zone IDs.
latefinal
-
azMode
↔ Output<
String> -
Number of availability zones you want to assign per volume. Currently, FinSpace only supports
SINGLEfor volumes, which assigns one availability zone per volume.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdTimestamp
↔ Output<
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.
latefinal
-
description
↔ Output<
String?> -
Description of the volume.
latefinal
-
environmentId
↔ Output<
String> -
Unique identifier for the kdb environment, whose clusters can attach to the volume.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
lastModifiedTimestamp
↔ Output<
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.
latefinal
-
name
↔ Output<
String> -
Unique name for the volume that you want to create.
latefinal
-
nas1Configurations
↔ Output<
List< KxVolumeNas1Configuration> ?> -
Configuration for the Network attached storage (
NAS_1) file system volume. This parameter is required whenvolumeTypeisNAS_1. Seenas1ConfigurationBlock below.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
↔ Output<
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), andDELETED(volume is successfully deleted).latefinal -
statusReason
↔ Output<
String> -
Error message when a failed state occurs.
latefinal
-
Key-value pairs to label the volume. You can add up to 50 tags to a volume.
latefinal
-
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
Type of file system volume. Currently, FinSpace only supports the
NAS_1volume type. When you select theNAS_1volume type, you must also providenas1Configuration.latefinal -
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited