Package com.pulumi.aws.fsx

Class OpenZfsVolume

  • public class OpenZfsVolume
extends com.pulumi.resources.CustomResource
    Manages an Amazon FSx for OpenZFS volume. See the [FSx OpenZFS User Guide](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/what-is-fsx.html) for more information. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.fsx.OpenZfsVolume;
 import com.pulumi.aws.fsx.OpenZfsVolumeArgs;
 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 test = new OpenZfsVolume("test", OpenZfsVolumeArgs.builder()
             .name("testvolume")
             .parentVolumeId(testAwsFsxOpenzfsFileSystem.rootVolumeId())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import FSx Volumes using the `id`. For example: ```sh $ pulumi import aws:fsx/openZfsVolume:OpenZfsVolume example fsvol-543ab12b1ca672f33 ```

    • 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

    • 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.Optional<java.lang.Boolean>> copyTagsToSnapshots()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> dataCompressionType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> deleteVolumeOptions()  
      static OpenZfsVolume get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OpenZfsVolumeState 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> name()  
      com.pulumi.core.Output<java.util.Optional<OpenZfsVolumeNfsExports>> nfsExports()  
      com.pulumi.core.Output<java.util.Optional<OpenZfsVolumeOriginSnapshot>> originSnapshot()  
      com.pulumi.core.Output<java.lang.String> parentVolumeId()  
      com.pulumi.core.Output<java.lang.Boolean> readOnly()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> recordSizeKib()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.Integer> storageCapacityQuotaGib()  
      com.pulumi.core.Output<java.lang.Integer> storageCapacityReservationGib()  
      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.util.List<OpenZfsVolumeUserAndGroupQuota>> userAndGroupQuotas()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> volumeType()  

      • 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

      • OpenZfsVolume

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

      • OpenZfsVolume

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

      • OpenZfsVolume

        public OpenZfsVolume​(java.lang.String name,
                     OpenZfsVolumeArgs 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 of the file system.

      • copyTagsToSnapshots

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> copyTagsToSnapshots()
        Returns:
        Whether tags for the file system should be copied to snapshots. Default is false.

      • dataCompressionType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> dataCompressionType()
        Returns:
        Method used to compress the data on the volume. Valid values are `NONE` or `ZSTD`. Child volumes that don't specify compression option will inherit from parent volume. This option on file system applies to the root volume.

      • deleteVolumeOptions

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> deleteVolumeOptions()
        Returns:
        Whether to delete all child volumes and snapshots. Valid values: `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`. This configuration must be applied separately before attempting to delete the resource to have the desired behavior..

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.

      • nfsExports

        public com.pulumi.core.Output<java.util.Optional<OpenZfsVolumeNfsExports>> nfsExports()
        Returns:
        NFS export configuration for the root volume. Exactly 1 item. See `nfsExports` Block Below for details.

      • originSnapshot

        public com.pulumi.core.Output<java.util.Optional<OpenZfsVolumeOriginSnapshot>> originSnapshot()
        Returns:
        Configuration to use when creating the OpenZFS volume. See `originSnapshot` Block below for details.

      • parentVolumeId

        public com.pulumi.core.Output<java.lang.String> parentVolumeId()
        Returns:
        Volume ID of the volume that will be the parent volume for the volume being created, this could be the root volume created from the `aws.fsx.OpenZfsFileSystem` resource with the `rootVolumeId` or the `id` property of another `aws.fsx.OpenZfsVolume`.

      • readOnly

        public com.pulumi.core.Output<java.lang.Boolean> readOnly()
        Returns:
        Whether the volume is read-only. Default is false.

      • recordSizeKib

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> recordSizeKib()
        Returns:
        Record size of an OpenZFS volume, in kibibytes (KiB). Valid values are `4`, `8`, `16`, `32`, `64`, `128`, `256`, `512`, or `1024` KiB. Default is `128` KiB.

      • 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.

      • storageCapacityQuotaGib

        public com.pulumi.core.Output<java.lang.Integer> storageCapacityQuotaGib()
        Returns:
        Maximum amount of storage in gibibytes (GiB) that the volume can use from its parent.

      • storageCapacityReservationGib

        public com.pulumi.core.Output<java.lang.Integer> storageCapacityReservationGib()
        Returns:
        Amount of storage in gibibytes (GiB) to reserve from the parent volume.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the file system. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • userAndGroupQuotas

        public com.pulumi.core.Output<java.util.List<OpenZfsVolumeUserAndGroupQuota>> userAndGroupQuotas()
        Returns:
        Specify how much storage users or groups can use on the volume. Maximum number of items defined by [FSx for OpenZFS Resource quota](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/limits.html#limits-openzfs-resources-file-system). See `userAndGroupQuotas` Block Below.

      • volumeType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> volumeType()
        Returns:
        Volume type. Default is `OPENZFS`.

      • get

        public static OpenZfsVolume get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                OpenZfsVolumeState 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.