pulumi-aws-kotlin/com.pulumi.aws.fsx.kotlin/OntapVolume

OntapVolume

class OntapVolume : KotlinCustomResource

Manages a FSx ONTAP Volume. See the FSx ONTAP User Guide 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.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 test = new OntapVolume("test", OntapVolumeArgs.builder()
            .junctionPath("/test")
            .sizeInMegabytes(1024)
            .storageEfficiencyEnabled(true)
            .storageVirtualMachineId(aws_fsx_ontap_storage_virtual_machine.test().id())
            .build());
    }
}

Using Tiering Policy

Additional information on tiering policy with ONTAP Volumes can be found in the FSx ONTAP Guide.

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.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 test = new OntapVolume("test", OntapVolumeArgs.builder()
            .junctionPath("/test")
            .sizeInMegabytes(1024)
            .storageEfficiencyEnabled(true)
            .storageVirtualMachineId(aws_fsx_ontap_storage_virtual_machine.test().id())
            .tieringPolicy(OntapVolumeTieringPolicyArgs.builder()
                .name("AUTO")
                .coolingPeriod(31)
                .build())
            .build());
    }
}

Import

Using pulumi import, import FSx ONTAP volume using the id. For example:

$ pulumi import aws:fsx/ontapVolume:OntapVolume example fsvol-12345678abcdef123

Properties

arn

val arn: Output<String>

Amazon Resource Name of the volune.

bypassSnaplockEnterpriseRetention

val bypassSnaplockEnterpriseRetention: Output<Boolean>?

Setting this to true allows 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

val copyTagsToBackups: Output<Boolean>?

A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.

fileSystemId

val fileSystemId: Output<String>

Describes the file system for the volume, e.g. fs-12345679

flexcacheEndpointType

val flexcacheEndpointType: Output<String>

Specifies the 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.

val id: Output<String>

junctionPath

val junctionPath: Output<String>?

Specifies the location in the storage virtual machine's namespace where the volume is mounted. The junction_path must have a leading forward slash, such as /vol3

name

val name: Output<String>

The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.

ontapVolumeType

val ontapVolumeType: Output<String>

Specifies the 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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

securityStyle

val securityStyle: Output<String>

Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.

sizeInMegabytes

val sizeInMegabytes: Output<Int>

Specifies the size of the volume, in megabytes (MB), that you are creating.

skipFinalBackup

val skipFinalBackup: Output<Boolean>?

When enabled, will 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

val snaplockConfiguration: Output<OntapVolumeSnaplockConfiguration>?

The SnapLock configuration for an FSx for ONTAP volume. See SnapLock Configuration below.

snapshotPolicy

val snapshotPolicy: Output<String>

Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide

storageEfficiencyEnabled

val storageEfficiencyEnabled: Output<Boolean>?

Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.

storageVirtualMachineId

val storageVirtualMachineId: Output<String>

Specifies the storage virtual machine in which to create the volume.