Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. fsx
  5. OntapVolume
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.fsx.OntapVolume

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

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

Example Usage

Basic Usage

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

const test = new aws.fsx.OntapVolume("test", {
    name: "test",
    junctionPath: "/test",
    sizeInMegabytes: 1024,
    storageEfficiencyEnabled: true,
    storageVirtualMachineId: testAwsFsxOntapStorageVirtualMachine.id,
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.fsx.OntapVolume("test",
    name="test",
    junction_path="/test",
    size_in_megabytes=1024,
    storage_efficiency_enabled=True,
    storage_virtual_machine_id=test_aws_fsx_ontap_storage_virtual_machine["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name:                     pulumi.String("test"),
			JunctionPath:             pulumi.String("/test"),
			SizeInMegabytes:          pulumi.Int(1024),
			StorageEfficiencyEnabled: pulumi.Bool(true),
			StorageVirtualMachineId:  pulumi.Any(testAwsFsxOntapStorageVirtualMachine.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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()
    {
        Name = "test",
        JunctionPath = "/test",
        SizeInMegabytes = 1024,
        StorageEfficiencyEnabled = true,
        StorageVirtualMachineId = testAwsFsxOntapStorageVirtualMachine.Id,
    });

});
Copy
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()
            .name("test")
            .junctionPath("/test")
            .sizeInMegabytes(1024)
            .storageEfficiencyEnabled(true)
            .storageVirtualMachineId(testAwsFsxOntapStorageVirtualMachine.id())
            .build());

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

Using Tiering Policy

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

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

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

test = aws.fsx.OntapVolume("test",
    name="test",
    junction_path="/test",
    size_in_megabytes=1024,
    storage_efficiency_enabled=True,
    storage_virtual_machine_id=test_aws_fsx_ontap_storage_virtual_machine["id"],
    tiering_policy={
        "name": "AUTO",
        "cooling_period": 31,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name:                     pulumi.String("test"),
			JunctionPath:             pulumi.String("/test"),
			SizeInMegabytes:          pulumi.Int(1024),
			StorageEfficiencyEnabled: pulumi.Bool(true),
			StorageVirtualMachineId:  pulumi.Any(testAwsFsxOntapStorageVirtualMachine.Id),
			TieringPolicy: &fsx.OntapVolumeTieringPolicyArgs{
				Name:          pulumi.String("AUTO"),
				CoolingPeriod: pulumi.Int(31),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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()
    {
        Name = "test",
        JunctionPath = "/test",
        SizeInMegabytes = 1024,
        StorageEfficiencyEnabled = true,
        StorageVirtualMachineId = testAwsFsxOntapStorageVirtualMachine.Id,
        TieringPolicy = new Aws.Fsx.Inputs.OntapVolumeTieringPolicyArgs
        {
            Name = "AUTO",
            CoolingPeriod = 31,
        },
    });

});
Copy
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()
            .name("test")
            .junctionPath("/test")
            .sizeInMegabytes(1024)
            .storageEfficiencyEnabled(true)
            .storageVirtualMachineId(testAwsFsxOntapStorageVirtualMachine.id())
            .tieringPolicy(OntapVolumeTieringPolicyArgs.builder()
                .name("AUTO")
                .coolingPeriod(31)
                .build())
            .build());

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

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,
                storage_virtual_machine_id: Optional[str] = None,
                size_in_bytes: Optional[str] = None,
                snaplock_configuration: Optional[OntapVolumeSnaplockConfigurationArgs] = None,
                final_backup_tags: Optional[Mapping[str, str]] = None,
                junction_path: Optional[str] = None,
                name: Optional[str] = None,
                ontap_volume_type: Optional[str] = None,
                security_style: Optional[str] = None,
                aggregate_configuration: Optional[OntapVolumeAggregateConfigurationArgs] = None,
                copy_tags_to_backups: Optional[bool] = None,
                size_in_megabytes: Optional[int] = None,
                skip_final_backup: Optional[bool] = None,
                snapshot_policy: Optional[str] = None,
                storage_efficiency_enabled: Optional[bool] = None,
                bypass_snaplock_enterprise_retention: Optional[bool] = None,
                tags: Optional[Mapping[str, str]] = None,
                tiering_policy: Optional[OntapVolumeTieringPolicyArgs] = None,
                volume_style: Optional[str] = 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 This property is required. string
The unique name of the resource.
args This property is required. OntapVolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. OntapVolumeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OntapVolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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()
{
    StorageVirtualMachineId = "string",
    SizeInBytes = "string",
    SnaplockConfiguration = new Aws.Fsx.Inputs.OntapVolumeSnaplockConfigurationArgs
    {
        SnaplockType = "string",
        AuditLogVolume = false,
        AutocommitPeriod = new Aws.Fsx.Inputs.OntapVolumeSnaplockConfigurationAutocommitPeriodArgs
        {
            Type = "string",
            Value = 0,
        },
        PrivilegedDelete = "string",
        RetentionPeriod = new Aws.Fsx.Inputs.OntapVolumeSnaplockConfigurationRetentionPeriodArgs
        {
            DefaultRetention = new Aws.Fsx.Inputs.OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetentionArgs
            {
                Type = "string",
                Value = 0,
            },
            MaximumRetention = new Aws.Fsx.Inputs.OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetentionArgs
            {
                Type = "string",
                Value = 0,
            },
            MinimumRetention = new Aws.Fsx.Inputs.OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetentionArgs
            {
                Type = "string",
                Value = 0,
            },
        },
        VolumeAppendModeEnabled = false,
    },
    FinalBackupTags = 
    {
        { "string", "string" },
    },
    JunctionPath = "string",
    Name = "string",
    OntapVolumeType = "string",
    SecurityStyle = "string",
    AggregateConfiguration = new Aws.Fsx.Inputs.OntapVolumeAggregateConfigurationArgs
    {
        Aggregates = new[]
        {
            "string",
        },
        ConstituentsPerAggregate = 0,
        TotalConstituents = 0,
    },
    CopyTagsToBackups = false,
    SizeInMegabytes = 0,
    SkipFinalBackup = false,
    SnapshotPolicy = "string",
    StorageEfficiencyEnabled = false,
    BypassSnaplockEnterpriseRetention = false,
    Tags = 
    {
        { "string", "string" },
    },
    TieringPolicy = new Aws.Fsx.Inputs.OntapVolumeTieringPolicyArgs
    {
        CoolingPeriod = 0,
        Name = "string",
    },
    VolumeStyle = "string",
    VolumeType = "string",
});
Copy
example, err := fsx.NewOntapVolume(ctx, "ontapVolumeResource", &fsx.OntapVolumeArgs{
	StorageVirtualMachineId: pulumi.String("string"),
	SizeInBytes:             pulumi.String("string"),
	SnaplockConfiguration: &fsx.OntapVolumeSnaplockConfigurationArgs{
		SnaplockType:   pulumi.String("string"),
		AuditLogVolume: pulumi.Bool(false),
		AutocommitPeriod: &fsx.OntapVolumeSnaplockConfigurationAutocommitPeriodArgs{
			Type:  pulumi.String("string"),
			Value: pulumi.Int(0),
		},
		PrivilegedDelete: pulumi.String("string"),
		RetentionPeriod: &fsx.OntapVolumeSnaplockConfigurationRetentionPeriodArgs{
			DefaultRetention: &fsx.OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetentionArgs{
				Type:  pulumi.String("string"),
				Value: pulumi.Int(0),
			},
			MaximumRetention: &fsx.OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetentionArgs{
				Type:  pulumi.String("string"),
				Value: pulumi.Int(0),
			},
			MinimumRetention: &fsx.OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetentionArgs{
				Type:  pulumi.String("string"),
				Value: pulumi.Int(0),
			},
		},
		VolumeAppendModeEnabled: pulumi.Bool(false),
	},
	FinalBackupTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	JunctionPath:    pulumi.String("string"),
	Name:            pulumi.String("string"),
	OntapVolumeType: pulumi.String("string"),
	SecurityStyle:   pulumi.String("string"),
	AggregateConfiguration: &fsx.OntapVolumeAggregateConfigurationArgs{
		Aggregates: pulumi.StringArray{
			pulumi.String("string"),
		},
		ConstituentsPerAggregate: pulumi.Int(0),
		TotalConstituents:        pulumi.Int(0),
	},
	CopyTagsToBackups:                 pulumi.Bool(false),
	SizeInMegabytes:                   pulumi.Int(0),
	SkipFinalBackup:                   pulumi.Bool(false),
	SnapshotPolicy:                    pulumi.String("string"),
	StorageEfficiencyEnabled:          pulumi.Bool(false),
	BypassSnaplockEnterpriseRetention: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TieringPolicy: &fsx.OntapVolumeTieringPolicyArgs{
		CoolingPeriod: pulumi.Int(0),
		Name:          pulumi.String("string"),
	},
	VolumeStyle: pulumi.String("string"),
	VolumeType:  pulumi.String("string"),
})
Copy
var ontapVolumeResource = new OntapVolume("ontapVolumeResource", OntapVolumeArgs.builder()
    .storageVirtualMachineId("string")
    .sizeInBytes("string")
    .snaplockConfiguration(OntapVolumeSnaplockConfigurationArgs.builder()
        .snaplockType("string")
        .auditLogVolume(false)
        .autocommitPeriod(OntapVolumeSnaplockConfigurationAutocommitPeriodArgs.builder()
            .type("string")
            .value(0)
            .build())
        .privilegedDelete("string")
        .retentionPeriod(OntapVolumeSnaplockConfigurationRetentionPeriodArgs.builder()
            .defaultRetention(OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetentionArgs.builder()
                .type("string")
                .value(0)
                .build())
            .maximumRetention(OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetentionArgs.builder()
                .type("string")
                .value(0)
                .build())
            .minimumRetention(OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetentionArgs.builder()
                .type("string")
                .value(0)
                .build())
            .build())
        .volumeAppendModeEnabled(false)
        .build())
    .finalBackupTags(Map.of("string", "string"))
    .junctionPath("string")
    .name("string")
    .ontapVolumeType("string")
    .securityStyle("string")
    .aggregateConfiguration(OntapVolumeAggregateConfigurationArgs.builder()
        .aggregates("string")
        .constituentsPerAggregate(0)
        .totalConstituents(0)
        .build())
    .copyTagsToBackups(false)
    .sizeInMegabytes(0)
    .skipFinalBackup(false)
    .snapshotPolicy("string")
    .storageEfficiencyEnabled(false)
    .bypassSnaplockEnterpriseRetention(false)
    .tags(Map.of("string", "string"))
    .tieringPolicy(OntapVolumeTieringPolicyArgs.builder()
        .coolingPeriod(0)
        .name("string")
        .build())
    .volumeStyle("string")
    .volumeType("string")
    .build());
Copy
ontap_volume_resource = aws.fsx.OntapVolume("ontapVolumeResource",
    storage_virtual_machine_id="string",
    size_in_bytes="string",
    snaplock_configuration={
        "snaplock_type": "string",
        "audit_log_volume": False,
        "autocommit_period": {
            "type": "string",
            "value": 0,
        },
        "privileged_delete": "string",
        "retention_period": {
            "default_retention": {
                "type": "string",
                "value": 0,
            },
            "maximum_retention": {
                "type": "string",
                "value": 0,
            },
            "minimum_retention": {
                "type": "string",
                "value": 0,
            },
        },
        "volume_append_mode_enabled": False,
    },
    final_backup_tags={
        "string": "string",
    },
    junction_path="string",
    name="string",
    ontap_volume_type="string",
    security_style="string",
    aggregate_configuration={
        "aggregates": ["string"],
        "constituents_per_aggregate": 0,
        "total_constituents": 0,
    },
    copy_tags_to_backups=False,
    size_in_megabytes=0,
    skip_final_backup=False,
    snapshot_policy="string",
    storage_efficiency_enabled=False,
    bypass_snaplock_enterprise_retention=False,
    tags={
        "string": "string",
    },
    tiering_policy={
        "cooling_period": 0,
        "name": "string",
    },
    volume_style="string",
    volume_type="string")
Copy
const ontapVolumeResource = new aws.fsx.OntapVolume("ontapVolumeResource", {
    storageVirtualMachineId: "string",
    sizeInBytes: "string",
    snaplockConfiguration: {
        snaplockType: "string",
        auditLogVolume: false,
        autocommitPeriod: {
            type: "string",
            value: 0,
        },
        privilegedDelete: "string",
        retentionPeriod: {
            defaultRetention: {
                type: "string",
                value: 0,
            },
            maximumRetention: {
                type: "string",
                value: 0,
            },
            minimumRetention: {
                type: "string",
                value: 0,
            },
        },
        volumeAppendModeEnabled: false,
    },
    finalBackupTags: {
        string: "string",
    },
    junctionPath: "string",
    name: "string",
    ontapVolumeType: "string",
    securityStyle: "string",
    aggregateConfiguration: {
        aggregates: ["string"],
        constituentsPerAggregate: 0,
        totalConstituents: 0,
    },
    copyTagsToBackups: false,
    sizeInMegabytes: 0,
    skipFinalBackup: false,
    snapshotPolicy: "string",
    storageEfficiencyEnabled: false,
    bypassSnaplockEnterpriseRetention: false,
    tags: {
        string: "string",
    },
    tieringPolicy: {
        coolingPeriod: 0,
        name: "string",
    },
    volumeStyle: "string",
    volumeType: "string",
});
Copy
type: aws:fsx:OntapVolume
properties:
    aggregateConfiguration:
        aggregates:
            - string
        constituentsPerAggregate: 0
        totalConstituents: 0
    bypassSnaplockEnterpriseRetention: false
    copyTagsToBackups: false
    finalBackupTags:
        string: string
    junctionPath: string
    name: string
    ontapVolumeType: string
    securityStyle: string
    sizeInBytes: string
    sizeInMegabytes: 0
    skipFinalBackup: false
    snaplockConfiguration:
        auditLogVolume: false
        autocommitPeriod:
            type: string
            value: 0
        privilegedDelete: string
        retentionPeriod:
            defaultRetention:
                type: string
                value: 0
            maximumRetention:
                type: string
                value: 0
            minimumRetention:
                type: string
                value: 0
        snaplockType: string
        volumeAppendModeEnabled: false
    snapshotPolicy: string
    storageEfficiencyEnabled: false
    storageVirtualMachineId: string
    tags:
        string: string
    tieringPolicy:
        coolingPeriod: 0
        name: string
    volumeStyle: string
    volumeType: string
Copy

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:

StorageVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
string

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

The following arguments are optional:

AggregateConfiguration OntapVolumeAggregateConfiguration
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
BypassSnaplockEnterpriseRetention bool
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 bool
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
FinalBackupTags Dictionary<string, string>
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. string
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
OntapVolumeType Changes to this property will trigger replacement. 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
SecurityStyle string
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
SizeInBytes string
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
SizeInMegabytes int
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
SkipFinalBackup bool
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 OntapVolumeSnaplockConfiguration
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
SnapshotPolicy string
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
StorageEfficiencyEnabled bool
Set to true to enable deduplication, compression, and compaction storage efficiency features on 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.
TieringPolicy OntapVolumeTieringPolicy
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
VolumeStyle Changes to this property will trigger replacement. string
Specifies the 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
VolumeType Changes to this property will trigger replacement. string
The type of volume, currently the only valid value is ONTAP.
StorageVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
string

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

The following arguments are optional:

AggregateConfiguration OntapVolumeAggregateConfigurationArgs
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
BypassSnaplockEnterpriseRetention bool
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 bool
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
FinalBackupTags map[string]string
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. string
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
OntapVolumeType Changes to this property will trigger replacement. 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
SecurityStyle string
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
SizeInBytes string
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
SizeInMegabytes int
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
SkipFinalBackup bool
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 OntapVolumeSnaplockConfigurationArgs
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
SnapshotPolicy string
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
StorageEfficiencyEnabled bool
Set to true to enable deduplication, compression, and compaction storage efficiency features on 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.
TieringPolicy OntapVolumeTieringPolicyArgs
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
VolumeStyle Changes to this property will trigger replacement. string
Specifies the 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
VolumeType Changes to this property will trigger replacement. string
The type of volume, currently the only valid value is ONTAP.
storageVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
String

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

The following arguments are optional:

aggregateConfiguration OntapVolumeAggregateConfiguration
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
bypassSnaplockEnterpriseRetention 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 Boolean
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
finalBackupTags Map<String,String>
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. String
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
ontapVolumeType Changes to this property will trigger replacement. 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
securityStyle String
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
sizeInBytes String
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
sizeInMegabytes Integer
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
skipFinalBackup 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 OntapVolumeSnaplockConfiguration
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
snapshotPolicy String
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
storageEfficiencyEnabled Boolean
Set to true to enable deduplication, compression, and compaction storage efficiency features on 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.
tieringPolicy OntapVolumeTieringPolicy
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
volumeStyle Changes to this property will trigger replacement. String
Specifies the 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
volumeType Changes to this property will trigger replacement. String
The type of volume, currently the only valid value is ONTAP.
storageVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
string

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

The following arguments are optional:

aggregateConfiguration OntapVolumeAggregateConfiguration
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
bypassSnaplockEnterpriseRetention 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 boolean
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
finalBackupTags {[key: string]: string}
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. string
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
ontapVolumeType Changes to this property will trigger replacement. 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
securityStyle string
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
sizeInBytes string
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
sizeInMegabytes number
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
skipFinalBackup 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 OntapVolumeSnaplockConfiguration
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
snapshotPolicy string
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
storageEfficiencyEnabled boolean
Set to true to enable deduplication, compression, and compaction storage efficiency features on 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.
tieringPolicy OntapVolumeTieringPolicy
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
volumeStyle Changes to this property will trigger replacement. string
Specifies the 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
volumeType Changes to this property will trigger replacement. string
The type of volume, currently the only valid value is ONTAP.
storage_virtual_machine_id
This property is required.
Changes to this property will trigger replacement.
str

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

The following arguments are optional:

aggregate_configuration OntapVolumeAggregateConfigurationArgs
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
bypass_snaplock_enterprise_retention bool
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.
copy_tags_to_backups bool
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
final_backup_tags Mapping[str, str]
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. str
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
ontap_volume_type Changes to this property will trigger replacement. str
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
security_style str
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
size_in_bytes str
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
size_in_megabytes int
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
skip_final_backup bool
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.
snaplock_configuration OntapVolumeSnaplockConfigurationArgs
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
snapshot_policy str
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
storage_efficiency_enabled bool
Set to true to enable deduplication, compression, and compaction storage efficiency features on 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.
tiering_policy OntapVolumeTieringPolicyArgs
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
volume_style Changes to this property will trigger replacement. str
Specifies the 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
volume_type Changes to this property will trigger replacement. str
The type of volume, currently the only valid value is ONTAP.
storageVirtualMachineId
This property is required.
Changes to this property will trigger replacement.
String

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

The following arguments are optional:

aggregateConfiguration Property Map
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
bypassSnaplockEnterpriseRetention 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 Boolean
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
finalBackupTags Map<String>
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. String
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
ontapVolumeType Changes to this property will trigger replacement. 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
securityStyle String
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
sizeInBytes String
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
sizeInMegabytes Number
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
skipFinalBackup 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 Property Map
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
snapshotPolicy String
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
storageEfficiencyEnabled Boolean
Set to true to enable deduplication, compression, and compaction storage efficiency features on 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.
tieringPolicy Property Map
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
volumeStyle Changes to this property will trigger replacement. String
Specifies the 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
volumeType Changes to this property will trigger replacement. 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.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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,
        aggregate_configuration: Optional[OntapVolumeAggregateConfigurationArgs] = None,
        arn: Optional[str] = None,
        bypass_snaplock_enterprise_retention: Optional[bool] = None,
        copy_tags_to_backups: Optional[bool] = None,
        file_system_id: Optional[str] = None,
        final_backup_tags: Optional[Mapping[str, 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_bytes: Optional[str] = None,
        size_in_megabytes: Optional[int] = None,
        skip_final_backup: Optional[bool] = None,
        snaplock_configuration: Optional[OntapVolumeSnaplockConfigurationArgs] = None,
        snapshot_policy: Optional[str] = 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_style: 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AggregateConfiguration OntapVolumeAggregateConfiguration
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
Arn string
Amazon Resource Name of the volune.
BypassSnaplockEnterpriseRetention bool
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 bool
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
FileSystemId string
Describes the file system for the volume, e.g. fs-12345679
FinalBackupTags Dictionary<string, string>
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. string
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
OntapVolumeType Changes to this property will trigger replacement. 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
SecurityStyle string
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
SizeInBytes string
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
SizeInMegabytes int
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
SkipFinalBackup bool
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 OntapVolumeSnaplockConfiguration
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
SnapshotPolicy string
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
StorageEfficiencyEnabled bool
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
StorageVirtualMachineId Changes to this property will trigger replacement. string

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

TieringPolicy OntapVolumeTieringPolicy
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
Uuid string
The Volume's UUID (universally unique identifier).
VolumeStyle Changes to this property will trigger replacement. string
Specifies the 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
VolumeType Changes to this property will trigger replacement. string
The type of volume, currently the only valid value is ONTAP.
AggregateConfiguration OntapVolumeAggregateConfigurationArgs
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
Arn string
Amazon Resource Name of the volune.
BypassSnaplockEnterpriseRetention bool
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 bool
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
FileSystemId string
Describes the file system for the volume, e.g. fs-12345679
FinalBackupTags map[string]string
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. string
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
OntapVolumeType Changes to this property will trigger replacement. 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
SecurityStyle string
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
SizeInBytes string
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
SizeInMegabytes int
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
SkipFinalBackup bool
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 OntapVolumeSnaplockConfigurationArgs
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
SnapshotPolicy string
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
StorageEfficiencyEnabled bool
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
StorageVirtualMachineId Changes to this property will trigger replacement. string

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

TieringPolicy OntapVolumeTieringPolicyArgs
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
Uuid string
The Volume's UUID (universally unique identifier).
VolumeStyle Changes to this property will trigger replacement. string
Specifies the 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
VolumeType Changes to this property will trigger replacement. string
The type of volume, currently the only valid value is ONTAP.
aggregateConfiguration OntapVolumeAggregateConfiguration
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
arn String
Amazon Resource Name of the volune.
bypassSnaplockEnterpriseRetention 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 Boolean
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
fileSystemId String
Describes the file system for the volume, e.g. fs-12345679
finalBackupTags Map<String,String>
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. String
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
ontapVolumeType Changes to this property will trigger replacement. 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
securityStyle String
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
sizeInBytes String
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
sizeInMegabytes Integer
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
skipFinalBackup 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 OntapVolumeSnaplockConfiguration
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
snapshotPolicy String
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
storageEfficiencyEnabled Boolean
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
storageVirtualMachineId Changes to this property will trigger replacement. String

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

tieringPolicy OntapVolumeTieringPolicy
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
uuid String
The Volume's UUID (universally unique identifier).
volumeStyle Changes to this property will trigger replacement. String
Specifies the 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
volumeType Changes to this property will trigger replacement. String
The type of volume, currently the only valid value is ONTAP.
aggregateConfiguration OntapVolumeAggregateConfiguration
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
arn string
Amazon Resource Name of the volune.
bypassSnaplockEnterpriseRetention 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 boolean
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
fileSystemId string
Describes the file system for the volume, e.g. fs-12345679
finalBackupTags {[key: string]: string}
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. string
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
ontapVolumeType Changes to this property will trigger replacement. 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
securityStyle string
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
sizeInBytes string
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
sizeInMegabytes number
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
skipFinalBackup 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 OntapVolumeSnaplockConfiguration
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
snapshotPolicy string
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
storageEfficiencyEnabled boolean
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
storageVirtualMachineId Changes to this property will trigger replacement. string

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

tieringPolicy OntapVolumeTieringPolicy
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
uuid string
The Volume's UUID (universally unique identifier).
volumeStyle Changes to this property will trigger replacement. string
Specifies the 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
volumeType Changes to this property will trigger replacement. string
The type of volume, currently the only valid value is ONTAP.
aggregate_configuration OntapVolumeAggregateConfigurationArgs
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
arn str
Amazon Resource Name of the volune.
bypass_snaplock_enterprise_retention bool
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.
copy_tags_to_backups bool
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
file_system_id str
Describes the file system for the volume, e.g. fs-12345679
final_backup_tags Mapping[str, str]
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. str
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
ontap_volume_type Changes to this property will trigger replacement. str
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
security_style str
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
size_in_bytes str
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
size_in_megabytes int
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
skip_final_backup bool
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.
snaplock_configuration OntapVolumeSnaplockConfigurationArgs
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
snapshot_policy str
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
storage_efficiency_enabled bool
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
storage_virtual_machine_id Changes to this property will trigger replacement. str

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

tiering_policy OntapVolumeTieringPolicyArgs
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
uuid str
The Volume's UUID (universally unique identifier).
volume_style Changes to this property will trigger replacement. str
Specifies the 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
volume_type Changes to this property will trigger replacement. str
The type of volume, currently the only valid value is ONTAP.
aggregateConfiguration Property Map
The Aggregate configuration only applies to FLEXGROUP volumes. See [aggregate_configuration Block] for details.
arn String
Amazon Resource Name of the volune.
bypassSnaplockEnterpriseRetention 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 Boolean
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false.
fileSystemId String
Describes the file system for the volume, e.g. fs-12345679
finalBackupTags Map<String>
A map of tags to apply to the volume's final backup.
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 Changes to this property will trigger replacement. String
The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character.
ontapVolumeType Changes to this property will trigger replacement. 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
securityStyle String
Specifies the volume security style, Valid values are UNIX, NTFS, and MIXED.
sizeInBytes String
Specifies the 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 size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
sizeInMegabytes Number
Specifies the size of the volume, in megabytes (MB), that you are creating. Supported when creating volumes under 2 PB. Either size_in_bytes or size_in_megabytes must be specified. Minimum size for FLEXGROUP volumes are 100GiB per constituent.
skipFinalBackup 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 Property Map
The SnapLock configuration for an FSx for ONTAP volume. See snaplock_configuration Block for details.
snapshotPolicy String
Specifies the snapshot policy for the volume. See snapshot policies in the Amazon FSx ONTAP User Guide
storageEfficiencyEnabled Boolean
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
storageVirtualMachineId Changes to this property will trigger replacement. String

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

The following arguments are optional:

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.

Deprecated: Please use tags instead.

tieringPolicy Property Map
The data tiering policy for an FSx for ONTAP volume. See tiering_policy Block for details.
uuid String
The Volume's UUID (universally unique identifier).
volumeStyle Changes to this property will trigger replacement. String
Specifies the 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
volumeType Changes to this property will trigger replacement. String
The type of volume, currently the only valid value is ONTAP.

Supporting Types

OntapVolumeAggregateConfiguration
, OntapVolumeAggregateConfigurationArgs

Aggregates Changes to this property will trigger replacement. List<string>
Used to specify the names of the aggregates on which the volume will be created. Each aggregate needs to be in the format aggrX where X is the number of the aggregate.
ConstituentsPerAggregate Changes to this property will trigger replacement. int
Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. the default value is 8.
TotalConstituents int
The total amount of constituents for a FLEXGROUP volume. This would equal constituents_per_aggregate x aggregates.
Aggregates Changes to this property will trigger replacement. []string
Used to specify the names of the aggregates on which the volume will be created. Each aggregate needs to be in the format aggrX where X is the number of the aggregate.
ConstituentsPerAggregate Changes to this property will trigger replacement. int
Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. the default value is 8.
TotalConstituents int
The total amount of constituents for a FLEXGROUP volume. This would equal constituents_per_aggregate x aggregates.
aggregates Changes to this property will trigger replacement. List<String>
Used to specify the names of the aggregates on which the volume will be created. Each aggregate needs to be in the format aggrX where X is the number of the aggregate.
constituentsPerAggregate Changes to this property will trigger replacement. Integer
Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. the default value is 8.
totalConstituents Integer
The total amount of constituents for a FLEXGROUP volume. This would equal constituents_per_aggregate x aggregates.
aggregates Changes to this property will trigger replacement. string[]
Used to specify the names of the aggregates on which the volume will be created. Each aggregate needs to be in the format aggrX where X is the number of the aggregate.
constituentsPerAggregate Changes to this property will trigger replacement. number
Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. the default value is 8.
totalConstituents number
The total amount of constituents for a FLEXGROUP volume. This would equal constituents_per_aggregate x aggregates.
aggregates Changes to this property will trigger replacement. Sequence[str]
Used to specify the names of the aggregates on which the volume will be created. Each aggregate needs to be in the format aggrX where X is the number of the aggregate.
constituents_per_aggregate Changes to this property will trigger replacement. int
Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. the default value is 8.
total_constituents int
The total amount of constituents for a FLEXGROUP volume. This would equal constituents_per_aggregate x aggregates.
aggregates Changes to this property will trigger replacement. List<String>
Used to specify the names of the aggregates on which the volume will be created. Each aggregate needs to be in the format aggrX where X is the number of the aggregate.
constituentsPerAggregate Changes to this property will trigger replacement. Number
Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. the default value is 8.
totalConstituents Number
The total amount of constituents for a FLEXGROUP volume. This would equal constituents_per_aggregate x aggregates.

OntapVolumeSnaplockConfiguration
, OntapVolumeSnaplockConfigurationArgs

SnaplockType
This property is required.
Changes to this property will trigger replacement.
string
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Valid values: COMPLIANCE, ENTERPRISE.
AuditLogVolume bool
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false.
AutocommitPeriod OntapVolumeSnaplockConfigurationAutocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. See autocommit_period Block for details.
PrivilegedDelete string
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Valid values: DISABLED, ENABLED, PERMANENTLY_DISABLED. The default value is DISABLED.
RetentionPeriod OntapVolumeSnaplockConfigurationRetentionPeriod
The retention period of an FSx for ONTAP SnapLock volume. See retention_period Block for details.
VolumeAppendModeEnabled bool
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. The default value is false.
SnaplockType
This property is required.
Changes to this property will trigger replacement.
string
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Valid values: COMPLIANCE, ENTERPRISE.
AuditLogVolume bool
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false.
AutocommitPeriod OntapVolumeSnaplockConfigurationAutocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. See autocommit_period Block for details.
PrivilegedDelete string
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Valid values: DISABLED, ENABLED, PERMANENTLY_DISABLED. The default value is DISABLED.
RetentionPeriod OntapVolumeSnaplockConfigurationRetentionPeriod
The retention period of an FSx for ONTAP SnapLock volume. See retention_period Block for details.
VolumeAppendModeEnabled bool
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. The default value is false.
snaplockType
This property is required.
Changes to this property will trigger replacement.
String
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Valid values: COMPLIANCE, ENTERPRISE.
auditLogVolume Boolean
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false.
autocommitPeriod OntapVolumeSnaplockConfigurationAutocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. See autocommit_period Block for details.
privilegedDelete String
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Valid values: DISABLED, ENABLED, PERMANENTLY_DISABLED. The default value is DISABLED.
retentionPeriod OntapVolumeSnaplockConfigurationRetentionPeriod
The retention period of an FSx for ONTAP SnapLock volume. See retention_period Block for details.
volumeAppendModeEnabled Boolean
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. The default value is false.
snaplockType
This property is required.
Changes to this property will trigger replacement.
string
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Valid values: COMPLIANCE, ENTERPRISE.
auditLogVolume boolean
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false.
autocommitPeriod OntapVolumeSnaplockConfigurationAutocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. See autocommit_period Block for details.
privilegedDelete string
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Valid values: DISABLED, ENABLED, PERMANENTLY_DISABLED. The default value is DISABLED.
retentionPeriod OntapVolumeSnaplockConfigurationRetentionPeriod
The retention period of an FSx for ONTAP SnapLock volume. See retention_period Block for details.
volumeAppendModeEnabled boolean
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. The default value is false.
snaplock_type
This property is required.
Changes to this property will trigger replacement.
str
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Valid values: COMPLIANCE, ENTERPRISE.
audit_log_volume bool
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false.
autocommit_period OntapVolumeSnaplockConfigurationAutocommitPeriod
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. See autocommit_period Block for details.
privileged_delete str
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Valid values: DISABLED, ENABLED, PERMANENTLY_DISABLED. The default value is DISABLED.
retention_period OntapVolumeSnaplockConfigurationRetentionPeriod
The retention period of an FSx for ONTAP SnapLock volume. See retention_period Block for details.
volume_append_mode_enabled bool
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. The default value is false.
snaplockType
This property is required.
Changes to this property will trigger replacement.
String
Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Valid values: COMPLIANCE, ENTERPRISE.
auditLogVolume Boolean
Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false.
autocommitPeriod Property Map
The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. See autocommit_period Block for details.
privilegedDelete String
Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Valid values: DISABLED, ENABLED, PERMANENTLY_DISABLED. The default value is DISABLED.
retentionPeriod Property Map
The retention period of an FSx for ONTAP SnapLock volume. See retention_period Block for details.
volumeAppendModeEnabled Boolean
Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. The default value is false.

OntapVolumeSnaplockConfigurationAutocommitPeriod
, OntapVolumeSnaplockConfigurationAutocommitPeriodArgs

Type string
The type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. Valid values: MINUTES, HOURS, DAYS, MONTHS, YEARS, NONE.
Value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
Type string
The type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. Valid values: MINUTES, HOURS, DAYS, MONTHS, YEARS, NONE.
Value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type String
The type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. Valid values: MINUTES, HOURS, DAYS, MONTHS, YEARS, NONE.
value Integer
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type string
The type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. Valid values: MINUTES, HOURS, DAYS, MONTHS, YEARS, NONE.
value number
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type str
The type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. Valid values: MINUTES, HOURS, DAYS, MONTHS, YEARS, NONE.
value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type String
The type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. Valid values: MINUTES, HOURS, DAYS, MONTHS, YEARS, NONE.
value Number
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.

OntapVolumeSnaplockConfigurationRetentionPeriod
, OntapVolumeSnaplockConfigurationRetentionPeriodArgs

DefaultRetention OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention
The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. See default_retention Block for details.
MaximumRetention OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention
The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See maximum_retention Block for details.
MinimumRetention OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention
The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See minimum_retention Block for details.
DefaultRetention OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention
The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. See default_retention Block for details.
MaximumRetention OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention
The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See maximum_retention Block for details.
MinimumRetention OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention
The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See minimum_retention Block for details.
defaultRetention OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention
The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. See default_retention Block for details.
maximumRetention OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention
The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See maximum_retention Block for details.
minimumRetention OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention
The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See minimum_retention Block for details.
defaultRetention OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention
The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. See default_retention Block for details.
maximumRetention OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention
The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See maximum_retention Block for details.
minimumRetention OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention
The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See minimum_retention Block for details.
default_retention OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention
The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. See default_retention Block for details.
maximum_retention OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention
The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See maximum_retention Block for details.
minimum_retention OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention
The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See minimum_retention Block for details.
defaultRetention Property Map
The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period. See default_retention Block for details.
maximumRetention Property Map
The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See maximum_retention Block for details.
minimumRetention Property Map
The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. See minimum_retention Block for details.

OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetention
, OntapVolumeSnaplockConfigurationRetentionPeriodDefaultRetentionArgs

Type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
Value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
Type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
Value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type String
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value Integer
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value number
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type str
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type String
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value Number
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.

OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetention
, OntapVolumeSnaplockConfigurationRetentionPeriodMaximumRetentionArgs

Type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
Value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
Type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
Value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type String
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value Integer
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value number
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type str
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type String
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value Number
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.

OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetention
, OntapVolumeSnaplockConfigurationRetentionPeriodMinimumRetentionArgs

Type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
Value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
Type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
Value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type String
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value Integer
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type string
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value number
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type str
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value int
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
type String
The type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period. Valid values: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS, INFINITE, UNSPECIFIED.
value Number
The amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.

OntapVolumeTieringPolicy
, OntapVolumeTieringPolicyArgs

CoolingPeriod int
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with AUTO and SNAPSHOT_ONLY tiering policies only. Valid values are whole numbers between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
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
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with AUTO and SNAPSHOT_ONLY tiering policies only. Valid values are whole numbers between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
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
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with AUTO and SNAPSHOT_ONLY tiering policies only. Valid values are whole numbers between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
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
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with AUTO and SNAPSHOT_ONLY tiering policies only. Valid values are whole numbers between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
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
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with AUTO and SNAPSHOT_ONLY tiering policies only. Valid values are whole numbers between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
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
Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with AUTO and SNAPSHOT_ONLY tiering policies only. Valid values are whole numbers between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
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

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

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

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 v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws