Package com.pulumi.aws.fsx

Class OntapVolume

  • public class OntapVolume
extends com.pulumi.resources.CustomResource
    Manages a FSx ONTAP Volume. See the [FSx ONTAP User Guide](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html) for more information. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.fsx.OntapVolume;
 import com.pulumi.aws.fsx.OntapVolumeArgs;
 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 OntapVolume("test", OntapVolumeArgs.builder()
             .name("test")
             .junctionPath("/test")
             .sizeInMegabytes(1024)
             .storageEfficiencyEnabled(true)
             .storageVirtualMachineId(testAwsFsxOntapStorageVirtualMachine.id())
             .build());
 
     }
 }
    ### Using Tiering Policy Additional information on tiering policy with ONTAP Volumes can be found in the [FSx ONTAP Guide](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-volumes.html). 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.fsx.OntapVolume;
 import com.pulumi.aws.fsx.OntapVolumeArgs;
 import com.pulumi.aws.fsx.inputs.OntapVolumeTieringPolicyArgs;
 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 OntapVolume("test", OntapVolumeArgs.builder()
             .tieringPolicy(OntapVolumeTieringPolicyArgs.builder()
                 .name("AUTO")
                 .coolingPeriod(31)
                 .build())
             .name("test")
             .junctionPath("/test")
             .sizeInMegabytes(1024)
             .storageEfficiencyEnabled(true)
             .storageVirtualMachineId(testAwsFsxOntapStorageVirtualMachine.id())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import FSx ONTAP volume using the `id`. For example: ```sh $ pulumi import aws:fsx/ontapVolume:OntapVolume example fsvol-12345678abcdef123 ```

    • 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.util.Optional<OntapVolumeAggregateConfiguration>> aggregateConfiguration()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> bypassSnaplockEnterpriseRetention()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> copyTagsToBackups()  
      com.pulumi.core.Output<java.lang.String> fileSystemId()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> finalBackupTags()  
      com.pulumi.core.Output<java.lang.String> flexcacheEndpointType()  
      static OntapVolume get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OntapVolumeState 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.util.Optional<java.lang.String>> junctionPath()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> ontapVolumeType()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> securityStyle()  
      com.pulumi.core.Output<java.lang.String> sizeInBytes()  
      com.pulumi.core.Output<java.lang.Integer> sizeInMegabytes()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipFinalBackup()  
      com.pulumi.core.Output<java.util.Optional<OntapVolumeSnaplockConfiguration>> snaplockConfiguration()  
      com.pulumi.core.Output<java.lang.String> snapshotPolicy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> storageEfficiencyEnabled()  
      com.pulumi.core.Output<java.lang.String> storageVirtualMachineId()  
      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.Optional<OntapVolumeTieringPolicy>> tieringPolicy()  
      com.pulumi.core.Output<java.lang.String> uuid()  
      com.pulumi.core.Output<java.lang.String> volumeStyle()  
      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

      • OntapVolume

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

      • OntapVolume

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

      • OntapVolume

        public OntapVolume​(java.lang.String name,
                   OntapVolumeArgs 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

      • aggregateConfiguration

        public com.pulumi.core.Output<java.util.Optional<OntapVolumeAggregateConfiguration>> aggregateConfiguration()
        Returns:
        Aggregate configuration only applies to `FLEXGROUP` volumes. See [`aggregateConfiguration` Block] for details.

      • arn

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

      • bypassSnaplockEnterpriseRetention

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> bypassSnaplockEnterpriseRetention()
        Returns:
        Whether to allow a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to `false`.

      • copyTagsToBackups

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> copyTagsToBackups()
        Returns:
        Whether tags for the volume should be copied to backups. This value defaults to `false`.

      • fileSystemId

        public com.pulumi.core.Output<java.lang.String> fileSystemId()
        Returns:
        File system for the volume, e.g. `fs-12345679`

      • finalBackupTags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> finalBackupTags()
        Returns:
        Map of tags to apply to the volume's final backup.

      • flexcacheEndpointType

        public com.pulumi.core.Output<java.lang.String> flexcacheEndpointType()
        Returns:
        FlexCache endpoint type of the volume, Valid values are `NONE`, `ORIGIN`, `CACHE`. Default value is `NONE`. These can be set by the ONTAP CLI or API and are use with FlexCache feature.

      • junctionPath

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> junctionPath()
        Returns:
        Location in the storage virtual machine's namespace where the volume is mounted. The junctionPath must have a leading forward slash, such as `/vol3`

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

      • ontapVolumeType

        public com.pulumi.core.Output<java.lang.String> ontapVolumeType()
        Returns:
        Type of volume, valid values are `RW`, `DP`. Default value is `RW`. These can be set by the ONTAP CLI or API. This setting is used as part of migration and replication [Migrating to Amazon FSx for NetApp ONTAP](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/migrating-fsx-ontap.html)

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

      • securityStyle

        public com.pulumi.core.Output<java.lang.String> securityStyle()
        Returns:
        Volume security style, Valid values are `UNIX`, `NTFS`, and `MIXED`.

      • sizeInBytes

        public com.pulumi.core.Output<java.lang.String> sizeInBytes()
        Returns:
        Size of the volume, in megabytes (MB), that you are creating. Can be used for any size but required for volumes over 2 PB. Either sizeInBytes or sizeInMegabytes must be specified. Minimum size for `FLEXGROUP` volumes are 100GiB per constituent.

      • sizeInMegabytes

        public com.pulumi.core.Output<java.lang.Integer> sizeInMegabytes()
        Returns:
        Size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either sizeInBytes or sizeInMegabytes must be specified. Minimum size for `FLEXGROUP` volumes are 100GiB per constituent.

      • skipFinalBackup

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> skipFinalBackup()
        Returns:
        Whether to skip the default final backup taken when the volume is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to `false`.

      • snaplockConfiguration

        public com.pulumi.core.Output<java.util.Optional<OntapVolumeSnaplockConfiguration>> snaplockConfiguration()
        Returns:
        SnapLock configuration for an FSx for ONTAP volume. See `snaplockConfiguration` Block for details.

      • snapshotPolicy

        public com.pulumi.core.Output<java.lang.String> snapshotPolicy()
        Returns:
        Snapshot policy for the volume. See [snapshot policies](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snapshots-ontap.html#snapshot-policies) in the Amazon FSx ONTAP User Guide

      • storageEfficiencyEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> storageEfficiencyEnabled()
        Returns:
        Whether to enable deduplication, compression, and compaction storage efficiency features on the volume.

      • storageVirtualMachineId

        public com.pulumi.core.Output<java.lang.String> storageVirtualMachineId()
        Returns:
        Storage virtual machine in which to create the volume. The following arguments are optional:

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

      • tieringPolicy

        public com.pulumi.core.Output<java.util.Optional<OntapVolumeTieringPolicy>> tieringPolicy()
        Returns:
        Data tiering policy for an FSx for ONTAP volume. See `tieringPolicy` Block for details.

      • uuid

        public com.pulumi.core.Output<java.lang.String> uuid()
        Returns:
        Volume's UUID (universally unique identifier).

      • volumeStyle

        public com.pulumi.core.Output<java.lang.String> volumeStyle()
        Returns:
        Styles of volume, valid values are `FLEXVOL`, `FLEXGROUP`. Default value is `FLEXVOL`. FLEXGROUPS have a larger minimum and maximum size. See Volume Styles for more details. [Volume Styles](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-styles.html)

      • volumeType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> volumeType()
        Returns:
        Type of volume, currently the only valid value is `ONTAP`.

      • get

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