Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. fsx
  6. OntapVolume
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws

aws.fsx.OntapVolume

aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws

    Manages a FSx ONTAP Volume. See the FSx ONTAP User Guide for more information.

    Example Usage

    Basic Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Fsx.OntapVolume("test", new()
    {
        JunctionPath = "/test",
        SizeInMegabytes = 1024,
        StorageEfficiencyEnabled = true,
        StorageVirtualMachineId = aws_fsx_ontap_storage_virtual_machine.Test.Id,
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fsx.NewOntapVolume(ctx, "test", &fsx.OntapVolumeArgs{
			JunctionPath:             pulumi.String("/test"),
			SizeInMegabytes:          pulumi.Int(1024),
			StorageEfficiencyEnabled: pulumi.Bool(true),
			StorageVirtualMachineId:  pulumi.Any(aws_fsx_ontap_storage_virtual_machine.Test.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.fsx.OntapVolume("test", {
    junctionPath: "/test",
    sizeInMegabytes: 1024,
    storageEfficiencyEnabled: true,
    storageVirtualMachineId: aws_fsx_ontap_storage_virtual_machine.test.id,
});

    import pulumi
import pulumi_aws as aws

test = aws.fsx.OntapVolume("test",
    junction_path="/test",
    size_in_megabytes=1024,
    storage_efficiency_enabled=True,
    storage_virtual_machine_id=aws_fsx_ontap_storage_virtual_machine["test"]["id"])

    resources:
  test:
    type: aws:fsx:OntapVolume
    properties:
      junctionPath: /test
      sizeInMegabytes: 1024
      storageEfficiencyEnabled: true
      storageVirtualMachineId: ${aws_fsx_ontap_storage_virtual_machine.test.id}

    Using Tiering Policy

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Fsx.OntapVolume("test", new()
    {
        JunctionPath = "/test",
        SizeInMegabytes = 1024,
        StorageEfficiencyEnabled = true,
        StorageVirtualMachineId = aws_fsx_ontap_storage_virtual_machine.Test.Id,
        TieringPolicy = new Aws.Fsx.Inputs.OntapVolumeTieringPolicyArgs
        {
            Name = "AUTO",
            CoolingPeriod = 31,
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fsx.NewOntapVolume(ctx, "test", &fsx.OntapVolumeArgs{
			JunctionPath:             pulumi.String("/test"),
			SizeInMegabytes:          pulumi.Int(1024),
			StorageEfficiencyEnabled: pulumi.Bool(true),
			StorageVirtualMachineId:  pulumi.Any(aws_fsx_ontap_storage_virtual_machine.Test.Id),
			TieringPolicy: &fsx.OntapVolumeTieringPolicyArgs{
				Name:          pulumi.String("AUTO"),
				CoolingPeriod: pulumi.Int(31),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.fsx.OntapVolume("test", {
    junctionPath: "/test",
    sizeInMegabytes: 1024,
    storageEfficiencyEnabled: true,
    storageVirtualMachineId: aws_fsx_ontap_storage_virtual_machine.test.id,
    tieringPolicy: {
        name: "AUTO",
        coolingPeriod: 31,
    },
});

    import pulumi
import pulumi_aws as aws

test = aws.fsx.OntapVolume("test",
    junction_path="/test",
    size_in_megabytes=1024,
    storage_efficiency_enabled=True,
    storage_virtual_machine_id=aws_fsx_ontap_storage_virtual_machine["test"]["id"],
    tiering_policy=aws.fsx.OntapVolumeTieringPolicyArgs(
        name="AUTO",
        cooling_period=31,
    ))

    resources:
  test:
    type: aws:fsx:OntapVolume
    properties:
      junctionPath: /test
      sizeInMegabytes: 1024
      storageEfficiencyEnabled: true
      storageVirtualMachineId: ${aws_fsx_ontap_storage_virtual_machine.test.id}
      tieringPolicy:
        name: AUTO
        coolingPeriod: 31

    Create OntapVolume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OntapVolume(name: string, args: OntapVolumeArgs, opts?: CustomResourceOptions);
    @overload
def OntapVolume(resource_name: str,
                args: OntapVolumeArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def OntapVolume(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                junction_path: Optional[str] = None,
                size_in_megabytes: Optional[int] = None,
                storage_efficiency_enabled: Optional[bool] = None,
                storage_virtual_machine_id: Optional[str] = None,
                name: Optional[str] = None,
                security_style: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                tiering_policy: Optional[OntapVolumeTieringPolicyArgs] = None,
                volume_type: Optional[str] = None)
    func NewOntapVolume(ctx *Context, name string, args OntapVolumeArgs, opts ...ResourceOption) (*OntapVolume, error)
    public OntapVolume(string name, OntapVolumeArgs args, CustomResourceOptions? opts = null)
    public OntapVolume(String name, OntapVolumeArgs args)
public OntapVolume(String name, OntapVolumeArgs args, CustomResourceOptions options)

    type: aws:fsx:OntapVolume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OntapVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OntapVolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OntapVolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OntapVolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OntapVolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ontapVolumeResource = new Aws.Fsx.OntapVolume("ontapVolumeResource", new()
{
    JunctionPath = "string",
    SizeInMegabytes = 0,
    StorageEfficiencyEnabled = false,
    StorageVirtualMachineId = "string",
    Name = "string",
    SecurityStyle = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TieringPolicy = new Aws.Fsx.Inputs.OntapVolumeTieringPolicyArgs
    {
        CoolingPeriod = 0,
        Name = "string",
    },
    VolumeType = "string",
});

    example, err := fsx.NewOntapVolume(ctx, "ontapVolumeResource", &fsx.OntapVolumeArgs{
	JunctionPath:             pulumi.String("string"),
	SizeInMegabytes:          pulumi.Int(0),
	StorageEfficiencyEnabled: pulumi.Bool(false),
	StorageVirtualMachineId:  pulumi.String("string"),
	Name:                     pulumi.String("string"),
	SecurityStyle:            pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TieringPolicy: &fsx.OntapVolumeTieringPolicyArgs{
		CoolingPeriod: pulumi.Int(0),
		Name:          pulumi.String("string"),
	},
	VolumeType: pulumi.String("string"),
})

    var ontapVolumeResource = new OntapVolume("ontapVolumeResource", OntapVolumeArgs.builder()
    .junctionPath("string")
    .sizeInMegabytes(0)
    .storageEfficiencyEnabled(false)
    .storageVirtualMachineId("string")
    .name("string")
    .securityStyle("string")
    .tags(Map.of("string", "string"))
    .tieringPolicy(OntapVolumeTieringPolicyArgs.builder()
        .coolingPeriod(0)
        .name("string")
        .build())
    .volumeType("string")
    .build());

    ontap_volume_resource = aws.fsx.OntapVolume("ontapVolumeResource",
    junction_path="string",
    size_in_megabytes=0,
    storage_efficiency_enabled=False,
    storage_virtual_machine_id="string",
    name="string",
    security_style="string",
    tags={
        "string": "string",
    },
    tiering_policy={
        "cooling_period": 0,
        "name": "string",
    },
    volume_type="string")

    const ontapVolumeResource = new aws.fsx.OntapVolume("ontapVolumeResource", {
    junctionPath: "string",
    sizeInMegabytes: 0,
    storageEfficiencyEnabled: false,
    storageVirtualMachineId: "string",
    name: "string",
    securityStyle: "string",
    tags: {
        string: "string",
    },
    tieringPolicy: {
        coolingPeriod: 0,
        name: "string",
    },
    volumeType: "string",
});

    type: aws:fsx:OntapVolume
properties:
    junctionPath: string
    name: string
    securityStyle: string
    sizeInMegabytes: 0
    storageEfficiencyEnabled: false
    storageVirtualMachineId: string
    tags:
        string: string
    tieringPolicy:
        coolingPeriod: 0
        name: string
    volumeType: string

    OntapVolume Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OntapVolume resource accepts the following input properties:

    JunctionPath 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
    SizeInMegabytes int
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    StorageEfficiencyEnabled bool
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    StorageVirtualMachineId string
    Specifies the storage virtual machine in which to create the volume.
    Name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    SecurityStyle string
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    Tags Dictionary<string, string>
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TieringPolicy OntapVolumeTieringPolicy
    VolumeType string
    The type of volume, currently the only valid value is ONTAP.
    JunctionPath 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
    SizeInMegabytes int
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    StorageEfficiencyEnabled bool
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    StorageVirtualMachineId string
    Specifies the storage virtual machine in which to create the volume.
    Name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    SecurityStyle string
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    Tags map[string]string
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TieringPolicy OntapVolumeTieringPolicyArgs
    VolumeType string
    The type of volume, currently the only valid value is ONTAP.
    junctionPath 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
    sizeInMegabytes Integer
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    storageEfficiencyEnabled Boolean
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    storageVirtualMachineId String
    Specifies the storage virtual machine in which to create the volume.
    name String
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    securityStyle String
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    tags Map<String,String>
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tieringPolicy OntapVolumeTieringPolicy
    volumeType String
    The type of volume, currently the only valid value is ONTAP.
    junctionPath 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
    sizeInMegabytes number
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    storageEfficiencyEnabled boolean
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    storageVirtualMachineId string
    Specifies the storage virtual machine in which to create the volume.
    name string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    securityStyle string
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    tags {[key: string]: string}
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tieringPolicy OntapVolumeTieringPolicy
    volumeType string
    The type of volume, currently the only valid value is ONTAP.
    junction_path str
    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
    size_in_megabytes int
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    storage_efficiency_enabled bool
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    storage_virtual_machine_id str
    Specifies the storage virtual machine in which to create the volume.
    name str
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    security_style str
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    tags Mapping[str, str]
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tiering_policy OntapVolumeTieringPolicyArgs
    volume_type str
    The type of volume, currently the only valid value is ONTAP.
    junctionPath 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
    sizeInMegabytes Number
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    storageEfficiencyEnabled Boolean
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    storageVirtualMachineId String
    Specifies the storage virtual machine in which to create the volume.
    name String
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    securityStyle String
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    tags Map<String>
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tieringPolicy Property Map
    volumeType String
    The type of volume, currently the only valid value is ONTAP.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OntapVolume resource produces the following output properties:

    Arn string
    Amazon Resource Name of the volune.
    FileSystemId string
    Describes the file system for the volume, e.g. fs-12345679
    FlexcacheEndpointType 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    OntapVolumeType string
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Uuid string
    The Volume's UUID (universally unique identifier).
    Arn string
    Amazon Resource Name of the volune.
    FileSystemId string
    Describes the file system for the volume, e.g. fs-12345679
    FlexcacheEndpointType 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    OntapVolumeType string
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Uuid string
    The Volume's UUID (universally unique identifier).
    arn String
    Amazon Resource Name of the volune.
    fileSystemId String
    Describes the file system for the volume, e.g. fs-12345679
    flexcacheEndpointType 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.
    id String
    The provider-assigned unique ID for this managed resource.
    ontapVolumeType String
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    uuid String
    The Volume's UUID (universally unique identifier).
    arn string
    Amazon Resource Name of the volune.
    fileSystemId string
    Describes the file system for the volume, e.g. fs-12345679
    flexcacheEndpointType 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.
    id string
    The provider-assigned unique ID for this managed resource.
    ontapVolumeType string
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    uuid string
    The Volume's UUID (universally unique identifier).
    arn str
    Amazon Resource Name of the volune.
    file_system_id str
    Describes the file system for the volume, e.g. fs-12345679
    flexcache_endpoint_type str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    ontap_volume_type str
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    uuid str
    The Volume's UUID (universally unique identifier).
    arn String
    Amazon Resource Name of the volune.
    fileSystemId String
    Describes the file system for the volume, e.g. fs-12345679
    flexcacheEndpointType 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.
    id String
    The provider-assigned unique ID for this managed resource.
    ontapVolumeType String
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    uuid String
    The Volume's UUID (universally unique identifier).

    Look up Existing OntapVolume Resource

    Get an existing OntapVolume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OntapVolumeState, opts?: CustomResourceOptions): OntapVolume
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        file_system_id: Optional[str] = None,
        flexcache_endpoint_type: Optional[str] = None,
        junction_path: Optional[str] = None,
        name: Optional[str] = None,
        ontap_volume_type: Optional[str] = None,
        security_style: Optional[str] = None,
        size_in_megabytes: Optional[int] = None,
        storage_efficiency_enabled: Optional[bool] = None,
        storage_virtual_machine_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        tiering_policy: Optional[OntapVolumeTieringPolicyArgs] = None,
        uuid: Optional[str] = None,
        volume_type: Optional[str] = None) -> OntapVolume
    func GetOntapVolume(ctx *Context, name string, id IDInput, state *OntapVolumeState, opts ...ResourceOption) (*OntapVolume, error)
    public static OntapVolume Get(string name, Input<string> id, OntapVolumeState? state, CustomResourceOptions? opts = null)
    public static OntapVolume get(String name, Output<String> id, OntapVolumeState state, CustomResourceOptions options)
    resources:  _:    type: aws:fsx:OntapVolume    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name of the volune.
    FileSystemId string
    Describes the file system for the volume, e.g. fs-12345679
    FlexcacheEndpointType 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.
    JunctionPath 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 string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    OntapVolumeType string
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    SecurityStyle string
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    SizeInMegabytes int
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    StorageEfficiencyEnabled bool
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    StorageVirtualMachineId string
    Specifies the storage virtual machine in which to create the volume.
    Tags Dictionary<string, string>
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    TieringPolicy OntapVolumeTieringPolicy
    Uuid string
    The Volume's UUID (universally unique identifier).
    VolumeType string
    The type of volume, currently the only valid value is ONTAP.
    Arn string
    Amazon Resource Name of the volune.
    FileSystemId string
    Describes the file system for the volume, e.g. fs-12345679
    FlexcacheEndpointType 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.
    JunctionPath 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 string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    OntapVolumeType string
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    SecurityStyle string
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    SizeInMegabytes int
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    StorageEfficiencyEnabled bool
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    StorageVirtualMachineId string
    Specifies the storage virtual machine in which to create the volume.
    Tags map[string]string
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    TieringPolicy OntapVolumeTieringPolicyArgs
    Uuid string
    The Volume's UUID (universally unique identifier).
    VolumeType string
    The type of volume, currently the only valid value is ONTAP.
    arn String
    Amazon Resource Name of the volune.
    fileSystemId String
    Describes the file system for the volume, e.g. fs-12345679
    flexcacheEndpointType 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.
    junctionPath 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 String
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    ontapVolumeType String
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    securityStyle String
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    sizeInMegabytes Integer
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    storageEfficiencyEnabled Boolean
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    storageVirtualMachineId String
    Specifies the storage virtual machine in which to create the volume.
    tags Map<String,String>
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    tieringPolicy OntapVolumeTieringPolicy
    uuid String
    The Volume's UUID (universally unique identifier).
    volumeType String
    The type of volume, currently the only valid value is ONTAP.
    arn string
    Amazon Resource Name of the volune.
    fileSystemId string
    Describes the file system for the volume, e.g. fs-12345679
    flexcacheEndpointType 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.
    junctionPath 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 string
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    ontapVolumeType string
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    securityStyle string
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    sizeInMegabytes number
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    storageEfficiencyEnabled boolean
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    storageVirtualMachineId string
    Specifies the storage virtual machine in which to create the volume.
    tags {[key: string]: string}
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    tieringPolicy OntapVolumeTieringPolicy
    uuid string
    The Volume's UUID (universally unique identifier).
    volumeType string
    The type of volume, currently the only valid value is ONTAP.
    arn str
    Amazon Resource Name of the volune.
    file_system_id str
    Describes the file system for the volume, e.g. fs-12345679
    flexcache_endpoint_type str
    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.
    junction_path str
    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 str
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    ontap_volume_type str
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    security_style str
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    size_in_megabytes int
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    storage_efficiency_enabled bool
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    storage_virtual_machine_id str
    Specifies the storage virtual machine in which to create the volume.
    tags Mapping[str, str]
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    tiering_policy OntapVolumeTieringPolicyArgs
    uuid str
    The Volume's UUID (universally unique identifier).
    volume_type str
    The type of volume, currently the only valid value is ONTAP.
    arn String
    Amazon Resource Name of the volune.
    fileSystemId String
    Describes the file system for the volume, e.g. fs-12345679
    flexcacheEndpointType 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.
    junctionPath 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 String
    The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
    ontapVolumeType String
    Specifies the type of volume, Valid values are RW, DP, and LS. 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
    securityStyle String
    Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED. Default value is UNIX.
    sizeInMegabytes Number
    Specifies the size of the volume, in megabytes (MB), that you are creating.
    storageEfficiencyEnabled Boolean
    Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
    storageVirtualMachineId String
    Specifies the storage virtual machine in which to create the volume.
    tags Map<String>
    A map of tags to assign to the volume. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    tieringPolicy Property Map
    uuid String
    The Volume's UUID (universally unique identifier).
    volumeType String
    The type of volume, currently the only valid value is ONTAP.

    Supporting Types

    OntapVolumeTieringPolicy, OntapVolumeTieringPolicyArgs

    CoolingPeriod int
    Name string
    Specifies the tiering policy for the ONTAP volume for moving data to the capacity pool storage. Valid values are SNAPSHOT_ONLY, AUTO, ALL, NONE. Default value is SNAPSHOT_ONLY.
    CoolingPeriod int
    Name string
    Specifies the tiering policy for the ONTAP volume for moving data to the capacity pool storage. Valid values are SNAPSHOT_ONLY, AUTO, ALL, NONE. Default value is SNAPSHOT_ONLY.
    coolingPeriod Integer
    name String
    Specifies the tiering policy for the ONTAP volume for moving data to the capacity pool storage. Valid values are SNAPSHOT_ONLY, AUTO, ALL, NONE. Default value is SNAPSHOT_ONLY.
    coolingPeriod number
    name string
    Specifies the tiering policy for the ONTAP volume for moving data to the capacity pool storage. Valid values are SNAPSHOT_ONLY, AUTO, ALL, NONE. Default value is SNAPSHOT_ONLY.
    cooling_period int
    name str
    Specifies the tiering policy for the ONTAP volume for moving data to the capacity pool storage. Valid values are SNAPSHOT_ONLY, AUTO, ALL, NONE. Default value is SNAPSHOT_ONLY.
    coolingPeriod Number
    name String
    Specifies the tiering policy for the ONTAP volume for moving data to the capacity pool storage. Valid values are SNAPSHOT_ONLY, AUTO, ALL, NONE. Default value is SNAPSHOT_ONLY.

    Import

    FSx ONTAP volume can be imported using the id, e.g.,

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial