Package com.pulumi.aws.finspace

Class KxVolume

  • public class KxVolume
extends com.pulumi.resources.CustomResource
    Resource for managing an AWS FinSpace Kx Volume. ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import an AWS FinSpace Kx Volume using the `id` (environment ID and volume name, comma-delimited). For example: ```sh $ pulumi import aws:finspace/kxVolume:KxVolume example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-volume ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      KxVolume​(java.lang.String name)  
      KxVolume​(java.lang.String name, KxVolumeArgs args)  
      KxVolume​(java.lang.String name, KxVolumeArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.List<KxVolumeAttachedCluster>> attachedClusters()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> availabilityZones()  
      com.pulumi.core.Output<java.lang.String> azMode()  
      com.pulumi.core.Output<java.lang.String> createdTimestamp()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> environmentId()  
      static KxVolume get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, KxVolumeState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lastModifiedTimestamp()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<KxVolumeNas1Configuration>>> nas1Configurations()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.lang.String> statusReason()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> type()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • KxVolume

        public KxVolume​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • KxVolume

        public KxVolume​(java.lang.String name,
                KxVolumeArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • KxVolume

        public KxVolume​(java.lang.String name,
                KxVolumeArgs args,
                @Nullable
                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN identifier of the KX volume.

      • attachedClusters

        public com.pulumi.core.Output<java.util.List<KxVolumeAttachedCluster>> attachedClusters()
        Returns:
        Clusters attached to the volume. See `attachedClusters` Block below.

      • availabilityZones

        public com.pulumi.core.Output<java.util.List<java.lang.String>> availabilityZones()
        Returns:
        Identifier of the AWS Availability Zone IDs.

      • azMode

        public com.pulumi.core.Output<java.lang.String> azMode()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> createdTimestamp()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the volume.

      • environmentId

        public com.pulumi.core.Output<java.lang.String> environmentId()
        Returns:
        Unique identifier for the kdb environment, whose clusters can attach to the volume.

      • lastModifiedTimestamp

        public com.pulumi.core.Output<java.lang.String> lastModifiedTimestamp()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Unique name for the volume that you want to create.

      • nas1Configurations

        public com.pulumi.core.Output<java.util.Optional<java.util.List<KxVolumeNas1Configuration>>> nas1Configurations()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> statusReason()
        Returns:
        Error message when a failed state occurs.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value pairs to label the volume. You can add up to 50 tags to a volume.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        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:

      • get

        public static KxVolume get​(java.lang.String name,
                           com.pulumi.core.Output<java.lang.String> id,
                           @Nullable
                           KxVolumeState state,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.